messenger

README

messenger

A messenger module, that is necessary for every distributed system

![GoDoc] (https://godoc.org/github.com/go-distributed/messenger?status.png)

####Install

$ go get github.com/tools/godep
$ godep get github.com/go-distributed/messenger

Documentation

Index

• type MessageHandler
• type Messenger
  • func New(codec codec.Codec, tr transporter.Transporter, enableRecv, enableHandler bool) *Messenger
  • func (m *Messenger) Destroy() error
  • func (m *Messenger) Recv() (interface{}, error)
  • func (m *Messenger) RegisterHandler(msg interface{}, msgHandler MessageHandler) error
  • func (m *Messenger) RegisterMessage(msg interface{}) error
  • func (m *Messenger) Send(hostport string, msg interface{}) error
  • func (m *Messenger) Start() error
  • func (m *Messenger) Stop() error

Types

type MessageHandler

type MessageHandler func(interface{})

MessageHandler is a callback that handles the messages. One can register the message with the callback by calling RegisterHandler.

type Messenger

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

Messenger is an abstraction that can send and receive messages.

func New

func New(codec codec.Codec, tr transporter.Transporter,
	enableRecv, enableHandler bool) *Messenger

New create a new messenger. If enableRecv is set to true, then the user should be responsible to consume the message via Recv(), otherwise the the underlying reading will stop if the queue is full. At least one of the enableRecv and enableHandler should be set to true.

func (*Messenger) Destroy

func (m *Messenger) Destroy() error

Destroy the messenger.

func (*Messenger) Recv

func (m *Messenger) Recv() (interface{}, error)

Recv a message.

func (*Messenger) RegisterHandler

func (m *Messenger) RegisterHandler(msg interface{}, msgHandler MessageHandler) error

RegisterHandler regists a message with a handler. When such a message comes in, it will be passed to the handler.

func (*Messenger) RegisterMessage

func (m *Messenger) RegisterMessage(msg interface{}) error

RegisterMessage Regists a message in the messenger. It will call the undelying codec to register the message as well.

func (*Messenger) Send

func (m *Messenger) Send(hostport string, msg interface{}) error

Send a message.

func (*Messenger) Start

func (m *Messenger) Start() error

Start the messenger.

func (*Messenger) Stop

func (m *Messenger) Stop() error

Stop the messenger.