consumer

Documentation

Index

• type Layer
  • func NewConsumerLayer() *Layer
  • func (c *Layer) AnnounceNexus(belowNexus nexus.Nexus)
  • func (c *Layer) ConsumerFinishedCb(consumerNexus consumer.Nexus)
  • func (c *Layer) OnPing(consumerNexus nexus.Nexus, milliseconds int)
  • func (c *Layer) RegisterAboveLayer(belowLayer layer.Base)
  • func (c *Layer) RevokeNexus(belowNexus nexus.Nexus)
  • func (c *Layer) SetOnPing(fn consumer.OnPingFn)
  • func (c *Layer) SetupConsumerNexus(belowNexus nexus.Nexus)

Types

type Layer

type Layer struct {
	layer.BaseLayer
	// contains filtered or unexported fields
}

Layer is the ConsumerLayer.

func NewConsumerLayer

func NewConsumerLayer() *Layer

NewConsumerLayer creates a new consumer layer.

func (*Layer) AnnounceNexus

func (c *Layer) AnnounceNexus(belowNexus nexus.Nexus)

AnnounceNexus creates a new consumer.ConsumerNexus and starts the handshake.

func (*Layer) ConsumerFinishedCb

func (c *Layer) ConsumerFinishedCb(consumerNexus consumer.Nexus)

ConsumerFinishedCb is a call back for when a consumer is finished.

func (*Layer) OnPing

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

OnPing is an event fired on ping.

func (*Layer) RegisterAboveLayer

func (c *Layer) RegisterAboveLayer(belowLayer layer.Base)

RegisterAboveLayer registers the current nexuses announce/revoke nexuses to the below layer.

func (*Layer) RevokeNexus

func (c *Layer) RevokeNexus(belowNexus nexus.Nexus)

RevokeNexus is a revoked nexus.

func (*Layer) SetOnPing

func (c *Layer) SetOnPing(fn consumer.OnPingFn)

SetOnPing sets up the on ping function.

func (*Layer) SetupConsumerNexus

func (c *Layer) SetupConsumerNexus(belowNexus nexus.Nexus)

SetupConsumerNexus initializes consumer nexus and tie the onping event back to this layer.