mirror
/
gomatrix
mirror of https://github.com/matrix-org/gomatrix
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

More clarifying comments

This commit is contained in:
Kegan Dougal 2016-12-09 16:26:38 +00:00
parent e989121b7a
commit b8025f5f6d
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
client.go
View File

@ -90,8 +90,15 @@ func (cli *Client) BuildURLWithQuery(urlPath []string, urlQuery map[string]strin
return u.String() return u.String()
} }
// Sync starts syncing with the provided Homeserver. This function will block until a fatal /sync error occurs, so should // Sync starts syncing with the provided Homeserver. If Sync() is called twice then the first sync will be stopped and the
// almost always be started as a new goroutine. If Sync() is called twice then the first sync will be stopped. // error will be nil.
//
// This function will block until a fatal /sync error occurs, so it should almost always be started as a new goroutine.
// Fatal sync errors can be caused by:
// - The failure to create a filter.
// - Client.Syncer.OnFailedSync returning an error in response to a failed sync.
// - Client.Syncer.ProcessResponse returning an error.
// If you wish to continue retrying in spite of these fatal errors, call Sync() again.
func (cli *Client) Sync() error { func (cli *Client) Sync() error {
// Mark the client as syncing. // Mark the client as syncing.
// We will keep syncing until the syncing state changes. Either because // We will keep syncing until the syncing state changes. Either because
@ -199,7 +206,7 @@ func (cli *Client) MakeRequest(method string, httpURL string, reqBody interface{
// If we failed to decode as RespError, don't just drop the HTTP body, include it in the // If we failed to decode as RespError, don't just drop the HTTP body, include it in the
// HTTP error instead (e.g proxy errors which return HTML). // HTTP error instead (e.g proxy errors which return HTML).
msg := "Failed to " + method + " JSON" msg := "Failed to " + method + " JSON to " + req.URL.Path
if wrap == nil { if wrap == nil {
msg = msg + ": " + string(contents) msg = msg + ": " + string(contents)
} }