client

Documentation

Index

• type FlowMessageStreamReader
  • func (fmsr *FlowMessageStreamReader) Next() (flow.Identifier, interface{}, error)
• type GhostClient
  • func NewGhostClient(addr string) (*GhostClient, error)
  • func (c *GhostClient) Close() error
  • func (c *GhostClient) Send(ctx context.Context, channelID string, event interface{}, ...) error
  • func (c *GhostClient) Subscribe(ctx context.Context) (*FlowMessageStreamReader, error)

Types

type FlowMessageStreamReader

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

func (*FlowMessageStreamReader) Next

func (fmsr *FlowMessageStreamReader) Next() (flow.Identifier, interface{}, error)

type GhostClient

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

GhostClient is a client for the ghost node.

The ghost node is a special node type, used for testing purposes. It can "impersonate" any other node role, send messages to other nodes on the network, and listen to broadcast messages.

NOTE: currently the ghost node is limited to 1-K messages (ie. messages sent to at least 2 other nodes). The ghost node WILL NOT receive a 1-1 message, unless the message is explicitly sent to it.

func NewGhostClient

func NewGhostClient(addr string) (*GhostClient, error)

func (*GhostClient) Close

func (c *GhostClient) Close() error

Close closes the client connection.

func (*GhostClient) Send

func (c *GhostClient) Send(ctx context.Context, channelID string, event interface{}, targetIDs ...flow.Identifier) error

func (*GhostClient) Subscribe

func (c *GhostClient) Subscribe(ctx context.Context) (*FlowMessageStreamReader, error)