concurrent

Documentation

Index

• Variables
• type ListenerOp
• type Signal
• type Signaller
  • func NewSignaller() *Signaller
  • func (s *Signaller) Drop(out chan Signal) error
  • func (s *Signaller) Listen() chan Signal
  • func (s *Signaller) Retire()
  • func (s *Signaller) Send(sig Signal) error

Variables

var (
	ErrSignallerRetired = fmt.Errorf("Signaller retiered")
	ErrUnknownListener  = fmt.Errorf("Unknown signal listener")
)

Error codes

var (
	LISTENER_ADD  = 0
	LISTENER_DROP = 1
)

ListenerOp codes

Types

type ListenerOp

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

ListenerOp represents an operation on the listener list:

type Signal

type Signal interface{}

Signal can be any object (intrinsic or custom); it is the responsibility of the senders and receivers of signals to handle them accordingly.

type Signaller

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

Signaller manages signals send by senders for multiple listeners.

func NewSignaller

func NewSignaller() *Signaller

NewSignaller instantiates a new signal manager:

func (*Signaller) Drop

func (s *Signaller) Drop(out chan Signal) error

Drop removes a listener from the list.

func (*Signaller) Listen

func (s *Signaller) Listen() chan Signal

Listen returns a channel to listen on

func (*Signaller) Retire

func (s *Signaller) Retire()

Retire a signaller: This will terminate the dispatch loop for signals; no further send or listen operations are supported. A retired signaller cannot be re-activated.

func (*Signaller) Send

func (s *Signaller) Send(sig Signal) error

Send a signal to be dispatched to all listeners.