consumer

Documentation

Index

• Constants
• type FinishedCb
• type Nexus
  • func NewConsumerNexus(belowNexus nexus.Nexus) *Nexus
  • func (c *Nexus) ConsumerFinishedCb()
  • func (c *Nexus) IsLayerMessage(message base2.MoneysocketMessage) bool
  • func (c *Nexus) OnBinMessage(belowNexus nexus.Nexus, msg []byte)
  • func (c *Nexus) OnMessage(belowNexus nexus.Nexus, msg base2.MoneysocketMessage)
  • func (c *Nexus) OnPing(consumerNexus nexus.Nexus, milliseconds int)
  • func (c *Nexus) SendPing()
  • func (c *Nexus) SetOnPing(fn OnPingFn)
  • func (c *Nexus) StartHandshake(cb FinishedCb)
  • func (c *Nexus) StartPinging()
  • func (c *Nexus) StopPinging()
• type OnPingFn

Constants

const NexusName = "ConsumerNexus"

NexusName is the name of the consumer nexus.

Types

type FinishedCb

type FinishedCb func(consumerNexus Nexus)

FinishedCb is a callback for when the Nexus finishes.

type Nexus

type Nexus struct {
	*base.NexusBase
	// contains filtered or unexported fields
}

Nexus is a consumer nexus to manage websockets as a consumer of the protocol.

func NewConsumerNexus

func NewConsumerNexus(belowNexus nexus.Nexus) *Nexus

NewConsumerNexus creates a new consumer nexus.

func (*Nexus) ConsumerFinishedCb

func (c *Nexus) ConsumerFinishedCb()

ConsumerFinishedCb is wether or not the consumer callback is finished.

func (*Nexus) IsLayerMessage

func (c *Nexus) IsLayerMessage(message base2.MoneysocketMessage) bool

IsLayerMessage determines whether or not a message should be processed by this layer.

func (*Nexus) OnBinMessage

func (c *Nexus) OnBinMessage(belowNexus nexus.Nexus, msg []byte)

OnBinMessage processes a binary message.

func (*Nexus) OnMessage

func (c *Nexus) OnMessage(belowNexus nexus.Nexus, msg base2.MoneysocketMessage)

OnMessage processes a passed message.

func (*Nexus) OnPing

func (c *Nexus) OnPing(consumerNexus nexus.Nexus, milliseconds int)

OnPing calls the onPing method passed to the Nexus.

func (*Nexus) SendPing

func (c *Nexus) SendPing()

SendPing sends a ping up the nexus chain.

func (*Nexus) SetOnPing

func (c *Nexus) SetOnPing(fn OnPingFn)

SetOnPing sets the ping function.

func (*Nexus) StartHandshake

func (c *Nexus) StartHandshake(cb FinishedCb)

StartHandshake starts a handshake/sets a finished callback.

func (*Nexus) StartPinging

func (c *Nexus) StartPinging()

StartPinging on a set interval.

func (*Nexus) StopPinging

func (c *Nexus) StopPinging()

StopPinging stops the consumer from pinging.

type OnPingFn

type OnPingFn func(nexus nexus.Nexus, msecs int)

OnPingFn is a function to trigger a ping on an given interval announcing to a passed in nexus.