flow

Documentation

Overview

Package flow can be used to test MQTT packet flows.

Index

• type Conn
• type Flow
  • func New() *Flow
  • func (f *Flow) Close() *Flow
  • func (f *Flow) Debug() *Flow
  • func (f *Flow) Delay(d time.Duration) *Flow
  • func (f *Flow) End() *Flow
  • func (f *Flow) Receive(pkt packet.Generic) *Flow
  • func (f *Flow) Run(fn func()) *Flow
  • func (f *Flow) Send(pkt packet.Generic) *Flow
  • func (f *Flow) Skip(pkt packet.Generic) *Flow
  • func (f *Flow) Test(conn Conn) error
  • func (f *Flow) TestAsync(conn Conn, timeout time.Duration) <-chan error
  • func (f *Flow) Wait(ch chan struct{}) *Flow
• type Pipe
  • func NewPipe() *Pipe
  • func (conn *Pipe) Close() error
  • func (conn *Pipe) Receive() (packet.Generic, error)
  • func (conn *Pipe) Send(pkt packet.Generic, _ bool) error

Types

type Conn

type Conn interface {
	Send(pkt packet.Generic, async bool) error
	Receive() (packet.Generic, error)
	Close() error
}

A Conn defines an abstract interface for connections used with a Flow.

type Flow

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

A Flow is a sequence of actions that can be tested against a connection.

func New

func New() *Flow

New returns a new flow.

func (*Flow) Close

func (f *Flow) Close() *Flow

Close will immediately close the connection.

func (*Flow) Debug

func (f *Flow) Debug() *Flow

Debug will activate the debug mode.

func (*Flow) Delay

func (f *Flow) Delay(d time.Duration) *Flow

Delay will suspend the flow using the specified duration.

func (*Flow) End

func (f *Flow) End() *Flow

End will match proper connection close.

func (*Flow) Receive

func (f *Flow) Receive(pkt packet.Generic) *Flow

Receive will receive and match one packet.

func (*Flow) Run

func (f *Flow) Run(fn func()) *Flow

Run will call the supplied function and wait until it returns.

func (*Flow) Send

func (f *Flow) Send(pkt packet.Generic) *Flow

Send will send and one packet.

func (*Flow) Skip

func (f *Flow) Skip(pkt packet.Generic) *Flow

Skip will receive one packet without matching it.

func (*Flow) Test

func (f *Flow) Test(conn Conn) error

Test starts the flow on the given Conn and reports to the specified test.

func (*Flow) TestAsync

func (f *Flow) TestAsync(conn Conn, timeout time.Duration) <-chan error

TestAsync starts the flow on the given Conn and reports to the specified test asynchronously.

func (*Flow) Wait

func (f *Flow) Wait(ch chan struct{}) *Flow

Wait will wait until the specified channel is closed.

type Pipe

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

The Pipe pipes packets from Send to Receive.

func NewPipe

func NewPipe() *Pipe

NewPipe returns a new Pipe.

func (*Pipe) Close

func (conn *Pipe) Close() error

Close will close the conn and let Send and Receive return errors.

func (*Pipe) Receive

func (conn *Pipe) Receive() (packet.Generic, error)

Receive returns the packet being sent with Send.

func (*Pipe) Send

func (conn *Pipe) Send(pkt packet.Generic, _ bool) error

Send returns packet on next Receive call.