message

Documentation

Index

• Variables
• type EchoMessage
• type EchoMsgMain
  • func NewEchoMsgMain(next types.MessageMain, pm types.PeerManager) *EchoMsgMain
  • func (t *EchoMsgMain) AddMessage(senderId string, msg types.Message) error
• type MsgChans
  • func NewMsgChans(bufferLen uint32, ts ...types.MessageType) *MsgChans
  • func (m *MsgChans) Pop(ctx context.Context, t types.MessageType) (types.Message, error)
  • func (m *MsgChans) Push(msg types.Message) error
• type MsgMain
  • func NewMsgMain(id string, peerNum uint32, listener types.StateChangedListener, ...) *MsgMain
  • func (t *MsgMain) AddMessage(senderId string, msg types.Message) error
  • func (t *MsgMain) GetHandler() types.Handler
  • func (t *MsgMain) GetState() types.MainState
  • func (t *MsgMain) Start()
  • func (t *MsgMain) Stop()
• type Peer
  • func NewPeer(id string) *Peer
  • func (p *Peer) AddMessage(msg types.Message) error
  • func (p *Peer) GetMessage(t types.MessageType) types.Message

Variables

var (
	// ErrInvalidMessage is return if the message is invalid
	ErrInvalidMessage = errors.New("invalid message")
	// ErrUndefinedMessage is return if the message is not defined
	ErrUndefinedMessage = errors.New("undefined message")
	// ErrFullChannel is returned if the message channel is full
	ErrFullChannel = errors.New("full channel")
)

var (
	ErrOldMessage             = errors.New("old message")
	ErrBadMsg                 = errors.New("bad message")
	ErrInvalidStateTransition = errors.New("invalid state transition")
	ErrDupMsg                 = errors.New("duplicate message")
)

var (
	ErrNotEchoMsg    = errors.New("not a echo message")
	ErrDifferentHash = errors.New("different hash")
)

var (
	ErrDupMessage = errors.New("duplicate message")
	ErrNotYours   = errors.New("not yours")
)

Types

type EchoMessage

type EchoMessage interface {
	proto.Message
	types.Message
	// GetEchoMessage() return the message to broadcast in echo protocol
	GetEchoMessage() types.Message
}

Message defines the message interface

type EchoMsgMain

type EchoMsgMain struct {
	types.MessageMain
	// contains filtered or unexported fields
}

func NewEchoMsgMain

func NewEchoMsgMain(next types.MessageMain, pm types.PeerManager) *EchoMsgMain

func (*EchoMsgMain) AddMessage

func (t *EchoMsgMain) AddMessage(senderId string, msg types.Message) error

NOTE: Avoid duplicate messages from the same peer should be handled in the caller

type MsgChans

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

func NewMsgChans

func NewMsgChans(bufferLen uint32, ts ...types.MessageType) *MsgChans

func (*MsgChans) Pop

func (m *MsgChans) Pop(ctx context.Context, t types.MessageType) (types.Message, error)

func (*MsgChans) Push

func (m *MsgChans) Push(msg types.Message) error

type MsgMain

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

func NewMsgMain

func NewMsgMain(id string, peerNum uint32, listener types.StateChangedListener, initHandler types.Handler, msgTypes ...types.MessageType) *MsgMain

func (*MsgMain) AddMessage

func (t *MsgMain) AddMessage(senderId string, msg types.Message) error

func (*MsgMain) GetHandler

func (t *MsgMain) GetHandler() types.Handler

func (*MsgMain) GetState

func (t *MsgMain) GetState() types.MainState

func (*MsgMain) Start

func (t *MsgMain) Start()

func (*MsgMain) Stop

func (t *MsgMain) Stop()

type Peer

type Peer struct {
	Id       string
	Messages map[types.MessageType]types.Message
	// contains filtered or unexported fields
}

func NewPeer

func NewPeer(id string) *Peer

func (*Peer) AddMessage

func (p *Peer) AddMessage(msg types.Message) error

func (*Peer) GetMessage

func (p *Peer) GetMessage(t types.MessageType) types.Message