vice

Documentation

Index

• type Err
  • func (e Err) Error() string
• type Transport

Types

type Err

type Err struct {
	Message []byte
	Name    string
	Err     error
}

Err represents a vice error.

func (Err) Error

func (e Err) Error() string

type Transport

type Transport interface {
	// Receive gets a channel on which to receive messages
	// with the specified name.
	Receive(name string) <-chan event.NormalizedEvent
	// Send gets a channel on which messages with the
	// specified name may be sent.
	Send(name string) chan<- event.NormalizedEvent
	ReceiveBool(name string) <-chan bool
	// Send gets a channel on which messages with the
	// specified name may be sent.
	SendBool(name string) chan<- bool
	// ErrChan gets a channel through which errors
	// are sent.
	ErrChan() <-chan error

	// Stop stops the transport. The channel returned from Done() will be closed
	// when the transport has stopped.
	Stop()
	// Done gets a channel which is closed when the
	// transport has successfully stopped.
	Done() chan struct{}
}

Transport provides message sending and receiving capabilities over a messaging queue technology. Clients should always check for errors coming through ErrChan.