network

Documentation

Index

• type Conduit
  • func (c *Conduit) Publish(event interface{}, targetIDs ...flow.Identifier) error
• type Engine
  • func NewEngine() *Engine
  • func (e *Engine) OnProcess(processFunc EngineProcessFunc) *Engine
• type EngineProcessFunc
• type Network
  • func NewNetwork() *Network
  • func (n *Network) OnPublish(publishFunc NetworkPublishFunc) *Network
  • func (n *Network) Register(channel network.Channel, engine network.Engine) (network.Conduit, error)
  • func (n *Network) Send(channel network.Channel, originID flow.Identifier, event interface{}) error
• type NetworkPublishFunc

Types

type Conduit

type Conduit struct {
	mocknetwork.Conduit
	// contains filtered or unexported fields
}

Conduit represents a mock conduit.

func (*Conduit) Publish

func (c *Conduit) Publish(event interface{}, targetIDs ...flow.Identifier) error

Publish sends a message on this mock network, invoking any callback that has been specified. This will panic if no callback is found.

type Engine

type Engine struct {
	mockmodule.Engine
}

Engine represents a mock engine. The implementation is not concurrency-safe.

func NewEngine

func NewEngine() *Engine

NewEngine returns a new mock engine.

func (*Engine) OnProcess

func (e *Engine) OnProcess(processFunc EngineProcessFunc) *Engine

OnProcess specifies the callback that should be executed when `Process` is called on this mock engine.

type EngineProcessFunc

type EngineProcessFunc func(network.Channel, flow.Identifier, interface{}) error

type Network

type Network struct {
	mockmodule.ReadyDoneAwareNetwork
	// contains filtered or unexported fields
}

Network represents a mock network. The implementation is not concurrency-safe.

func NewNetwork

func NewNetwork() *Network

NewNetwork returns a new mock network.

func (*Network) OnPublish

func (n *Network) OnPublish(publishFunc NetworkPublishFunc) *Network

OnPublish specifies the callback that should be executed when `Publish` is called on any conduits created by this mock network.

func (*Network) Register

func (n *Network) Register(channel network.Channel, engine network.Engine) (network.Conduit, error)

Register registers an engine with this mock network. If an engine is already registered on the given channel, this will return an error.

func (*Network) Send

func (n *Network) Send(channel network.Channel, originID flow.Identifier, event interface{}) error

Send sends a message to the engine registered to the given channel on this mock network and returns an error if one occurs. If no engine is registered, this is a noop.

type NetworkPublishFunc

type NetworkPublishFunc func(network.Channel, interface{}, ...flow.Identifier) error