Skip to content

Commit

Permalink
Remove 'in seconds' from the docs for SetKeepAlive and SetPingTimeout
Browse files Browse the repository at this point in the history
At some point in the past these functions probably did take ints and assumed those
values would relate to the number of seconds for these features. They were changed
to take a time.Duration but the docs were not updated.

resolves eclipse-paho#152
  • Loading branch information
alsm committed Nov 16, 2017
1 parent 65f43bd commit a3ad7c0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions options.go
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ func (o *ClientOptions) SetStore(s Store) *ClientOptions {
return o
}

// SetKeepAlive will set the amount of time (in seconds) that the client
// SetKeepAlive will set the amount of time that the client
// should wait before sending a PING request to the broker. This will
// allow the client to know that a connection has not been lost with the
// server.
Expand All @@ -186,7 +186,7 @@ func (o *ClientOptions) SetKeepAlive(k time.Duration) *ClientOptions {
return o
}

// SetPingTimeout will set the amount of time (in seconds) that the client
// SetPingTimeout will set the amount of time that the client
// will wait after sending a PING request to the broker, before deciding
// that the connection has been lost. Default is 10 seconds.
func (o *ClientOptions) SetPingTimeout(k time.Duration) *ClientOptions {
Expand Down

0 comments on commit a3ad7c0

Please sign in to comment.