backbone

Documentation

Index

• Constants
• Variables
• type Backbone
• type BackboneAddress
  • func NewWebsocketAddress(token string, networkAddress, path string, secured bool, ...) BackboneAddress
• type BackboneHandler
  • func NewBackboneHandler(onCreate func(b Backbone), onClosed func(b Backbone)) BackboneHandler
• type Packet
  • func NewPacket(id common.Id, packetType PacketType, data []byte) (Packet, error)
• type PacketHandler
  • func NewPacketHandler(onReceive func(backboneId common.Id, packet Packet)) PacketHandler
• type PacketType
• type Protocol
• type Registry
  • func NewRegistry() (Registry, error)

Constants

const HeaderToken = "x-token"

Variables

var (
	ErrAddressNil       = errors.New("address is nil")
	ErrAddressInvalid   = errors.New("invalid address")
	ErrCertRootInvalid  = errors.New("root ca is invalid")
	ErrCertPrivInvalid  = errors.New("private key is invalid")
	ErrCertPubInvalid   = errors.New("public key is invalid")
	ErrUnableDial       = errors.New("unable to dial")
	ErrUnableListen     = errors.New("unable to listen")
	ErrIllegalState     = errors.New("illegal state")
	ErrBackboneNotFound = errors.New("backbone is not found")
	ErrBackboneInvalid  = errors.New("backbone is invalid")
	ErrBackboneClosed   = errors.New("backbone is closed")
	ErrPacketInvalid    = errors.New("packet is invalid")
)

Types

type Backbone

type Backbone interface {
	Id() common.Id
	Serve() error
	Send(packet Packet) error
	IsClosed() bool
	Close() error
}

type BackboneAddress

type BackboneAddress interface {
	Protocol() Protocol
	String() string
}

func NewWebsocketAddress

func NewWebsocketAddress(
	token string, networkAddress, path string, secured bool, rootCAPath, privKeyPath, pubKeyPath string,
) BackboneAddress

type BackboneHandler

type BackboneHandler interface {
	OnCreate(b Backbone)
	OnClosed(b Backbone)
}

func NewBackboneHandler

func NewBackboneHandler(onCreate func(b Backbone), onClosed func(b Backbone)) BackboneHandler

type Packet

type Packet interface {
	Id() common.Id
	Type() PacketType
	Data() []byte
}

func NewPacket

func NewPacket(id common.Id, packetType PacketType, data []byte) (Packet, error)

type PacketHandler

type PacketHandler interface {
	OnReceive(backboneId common.Id, packet Packet)
}

func NewPacketHandler

func NewPacketHandler(onReceive func(backboneId common.Id, packet Packet)) PacketHandler

type PacketType

type PacketType int

const (
	PacketTypeUnknown PacketType = iota
	PacketTypeOpen
	PacketTypeOpenAckSuccess
	PacketTypeOpenAckFailed
	PacketTypeEdgeCreate
	PacketTypeEdgeCreateAckSuccess
	PacketTypeEdgeCreateAckFailed
	PacketTypeEdgeClose
	PacketTypeMessage
)

type Protocol

type Protocol int

const (
	ProtocolWebsocket Protocol = iota
)

type Registry

type Registry interface {
	SetAddress(address BackboneAddress) error
	SetPacketHandler(handler PacketHandler) error
	SetBackboneHandler(handler BackboneHandler) error

	Start() error
	IsRunning() bool
	Listen() error
	Dial() error
	Shutdown(ctx context.Context) error

	GetAll() ([]Backbone, error)
	GetById(backboneId common.Id) (Backbone, error)
	Send(backboneId common.Id, packet Packet) error
}

func NewRegistry

func NewRegistry() (Registry, error)