token

Documentation

Index

• type Errors
  • func (es Errors) Error() string
• type Tokens
  • func NewTokens() *Tokens
  • func (ts *Tokens) Append(name string, t mqtt.Token)
  • func (ts *Tokens) Done() <-chan struct{}
  • func (ts *Tokens) Error() error
  • func (ts *Tokens) Wait() bool
  • func (ts *Tokens) WaitTimeout(d time.Duration) bool

Types

type Errors

type Errors []error

func (Errors) Error

func (es Errors) Error() string

type Tokens

type Tokens struct {
	// contains filtered or unexported fields
}

func NewTokens

func NewTokens() *Tokens

func (*Tokens) Append

func (ts *Tokens) Append(name string, t mqtt.Token)

func (*Tokens) Done

func (ts *Tokens) Done() <-chan struct{}

Done returns a channel that is closed when the flow associated with the Token completes. Clients should call Error after the channel is closed to check if the flow completed successfully.

Done is provided for use in select statements. Simple use cases may use Wait or WaitTimeout.

func (*Tokens) Error

func (ts *Tokens) Error() error

func (*Tokens) Wait

func (ts *Tokens) Wait() bool

Wait will wait indefinitely for the Token to complete, ie the Publish to be sent and confirmed receipt from the broker.

func (*Tokens) WaitTimeout

func (ts *Tokens) WaitTimeout(d time.Duration) bool

WaitTimeout takes a time.Duration to wait for the flow associated with the Token to complete, returns true if it returned before the timeout or returns false if the timeout occurred. In the case of a timeout the Token does not have an error set in case the caller wishes to wait again.