base

Documentation

Index

• type NexusBase
  • func NewBaseNexus(name string) *NexusBase
  • func NewBaseNexusBelow(name string, belowNexus nexus.Nexus) *NexusBase
  • func NewBaseNexusFull(name string, belowNexus nexus.Nexus, layer layer.Base) NexusBase
  • func (b *NexusBase) CheckCrossedNexus(belowNexus nexus.Nexus)
  • func (b NexusBase) GetDownwardNexusList() (belowList []nexus.Nexus)
  • func (b *NexusBase) InitiateClose()
  • func (b *NexusBase) IsEqual(n nexus.Nexus) bool
  • func (b *NexusBase) Name() string
  • func (b *NexusBase) OnBinMessage(belowNexus nexus.Nexus, msg []byte)
  • func (b *NexusBase) OnMessage(belowNexus nexus.Nexus, msg base.MoneysocketMessage)
  • func (b *NexusBase) Send(msg base.MoneysocketMessage) error
  • func (b *NexusBase) SendBin(msg []byte) error
  • func (b *NexusBase) SetOnBinMessage(messageBinFunc nexus.OnBinMessage)
  • func (b *NexusBase) SetOnMessage(messageFunc nexus.OnMessage)
  • func (b NexusBase) SharedSeed() *beacon.SharedSeed
  • func (b *NexusBase) UUID() uuid.UUID

Types

type NexusBase

type NexusBase struct {
	BelowNexus *nexus.Nexus
	Layer      layer.Base
	// contains filtered or unexported fields
}

NexusBase is the nexus superclass. It contains common functions for a nexus.

func NewBaseNexus

func NewBaseNexus(name string) *NexusBase

NewBaseNexus creates a new nexus base.

func NewBaseNexusBelow

func NewBaseNexusBelow(name string, belowNexus nexus.Nexus) *NexusBase

NewBaseNexusBelow creates a new base nexus and sets the below nexus.

func NewBaseNexusFull

func NewBaseNexusFull(name string, belowNexus nexus.Nexus, layer layer.Base) NexusBase

NewBaseNexusFull creates a new base nexus and sets a below nexus/layer for comms.

func (*NexusBase) CheckCrossedNexus

func (b *NexusBase) CheckCrossedNexus(belowNexus nexus.Nexus)

CheckCrossedNexus checks if the nexus has been crossed.

func (NexusBase) GetDownwardNexusList

func (b NexusBase) GetDownwardNexusList() (belowList []nexus.Nexus)

GetDownwardNexusList gets the nexus list.

func (*NexusBase) InitiateClose

func (b *NexusBase) InitiateClose()

InitiateClose closes the websocket.

func (*NexusBase) IsEqual

func (b *NexusBase) IsEqual(n nexus.Nexus) bool

IsEqual checks if a nexus is equal to another nexus.

func (*NexusBase) Name

func (b *NexusBase) Name() string

Name gets the name of the nexus.

func (*NexusBase) OnBinMessage

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

OnBinMessage calls the binary message method.

func (*NexusBase) OnMessage

func (b *NexusBase) OnMessage(belowNexus nexus.Nexus, msg base.MoneysocketMessage)

OnMessage handles the message callback.

func (*NexusBase) Send

func (b *NexusBase) Send(msg base.MoneysocketMessage) error

Send sends a message.

func (*NexusBase) SendBin

func (b *NexusBase) SendBin(msg []byte) error

SendBin sends a binary message.

func (*NexusBase) SetOnBinMessage

func (b *NexusBase) SetOnBinMessage(messageBinFunc nexus.OnBinMessage)

SetOnBinMessage sets the binary message callback function.

func (*NexusBase) SetOnMessage

func (b *NexusBase) SetOnMessage(messageFunc nexus.OnMessage)

SetOnMessage sets the message callback function.

func (NexusBase) SharedSeed

func (b NexusBase) SharedSeed() *beacon.SharedSeed

SharedSeed gets the shared seed.

func (*NexusBase) UUID

func (b *NexusBase) UUID() uuid.UUID

UUID gets the uuid of the nexus base.