river

type Bus ¶

type Bus interface {
	River
	ID() uint64
}

Bus is a River implemented by the mangos BUS protocol.

func NewBus(id, streamID string, tx *bolt.Tx) (r Bus, e error)

type GlobalTopic ¶

type GlobalTopic struct{}

GlobalTopic is a Subscribe Topic which messages not belonging to any other Topic should be sent on.

func (GlobalTopic) Code() []byte

func (GlobalTopic) Len() int

func (GlobalTopic) Name() string

func (GlobalTopic) Prefix() byte

type Missing ¶

type Missing interface {
	error
	IDs() []uint64
}

Missing is an interface which can be implemented by an error value to show that some IDs were missing in a survey.

type Pub ¶

type Pub interface {
	Close() error
	Send([]byte) error
}

Pub is a Publisher River which can only Send. To send on a Topic, prefix the Send with the desired Topic code and Prefix byte. Only Subs which are created on the given Topic, connected to the PubRiver, will receive messages on that Topic.

NOTE: The go-mangos implementation of Pub (returned by NewPub) sends

messages to all connected SubRivers, but they are filtered
before Recv.  This is not a technique which guarantees
unauthorized hosts will not receive the sent bytes; they will.
But their Sub Recv method will not behave as though it received
the message.

func NewPub(id, streamID string, tx *bolt.Tx) (r Pub, e error)

type Responder ¶

type Responder interface {
	Send([]byte) error
	Recv() ([]byte, error)
	Close() error

	ID() uint64
}

Responder is a River which implements the RESPONDENT end of the SURVEYOR/RESPONDENT scalable protocol.

func NewResponder(
	tx *bolt.Tx,
	buckets ...store.Bucket,
) (rsp Responder, e error)

type Response ¶

type Response []byte

Response is a response request constant (may be suffixed with an ID.)

type River ¶

type River interface {
	Close() error
	Send([]byte) error
	Recv() ([]byte, error)
}

River is a simplified sender and receiver which can be implemented by mangos.Socket.

type Sub ¶

type Sub interface {
	Close() error
	Recv() ([]byte, error)
}

Sub is a Subscriber River which can only Recv. It can be implemented on a byte prefix Topic, which is to be removed before Recv returns.

func NewSub(
	streamID string,
	tx *bolt.Tx,
	topics ...Topic,
) (r Sub, e error)

type Survey ¶

type Survey []byte

Survey is a survey request constant.

type Surveyor ¶

type Surveyor interface {
	Recv() ([]byte, error)
	Send([]byte) error
	Close() error

	Expect() map[uint64]bool
}

Surveyor is a River which implements the Surveyor end of the SURVEYOR/RESPONDENT scalable protocol.

func NewSurvey(
	tx *bolt.Tx,
	timeout time.Duration,
	buckets ...store.Bucket,
) (Surveyor, error)

type Topic ¶

type Topic interface {
	// Prefix must be prepended to Code.  This permits a quick match
	// on message prefix.
	Prefix() byte
	Code() []byte
	Name() string
	Len() int
}

Topic is a Pub/Sub topic. Package users should export and manage their own Topic constants. Note that this means collisions can happen if the package user does not take care to review imported Topics.