messagebus

Documentation

Overview

Package messagebus - a queuing system for all message packets whether internally generated or received from peers

Index

• Constants
• Variables
• type BroadcastQueue
  • func (queue *BroadcastQueue) Chan(size int) <-chan Message
  • func (queue *BroadcastQueue) Release()
  • func (queue *BroadcastQueue) Send(command string, parameters ...[]byte)
• type Message
• type Queue
  • func (queue *Queue) Chan() <-chan Message
  • func (queue *Queue) Release()
  • func (queue *Queue) Send(command string, parameters ...[]byte)

Constants

const Default = -1

for select the default queue size

Variables

var Bus busses

Bus - all available message queues

Types

type BroadcastQueue

type BroadcastQueue struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

BroadcastQueue - a 1:M queue out is synchronous, so messages to routines not waiting are dropped

func (*BroadcastQueue) Chan

func (queue *BroadcastQueue) Chan(size int) <-chan Message

Chan - get a new channel to read from a 1:M queue each call gets a distinct channel

func (*BroadcastQueue) Release

func (queue *BroadcastQueue) Release()

Release - release the incoming and outgoing queue

func (*BroadcastQueue) Send

func (queue *BroadcastQueue) Send(command string, parameters ...[]byte)

Send - send a message to a 1:M queue

type Message

type Message struct {
	Command    string   // type of packed data
	Parameters [][]byte // array of parameters
}

Message - message to put into a queue

type Queue

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

Queue - a 1:1 queue

func (*Queue) Chan

func (queue *Queue) Chan() <-chan Message

Chan - channel to read from 1:1 queue can only be called once

func (*Queue) Release

func (queue *Queue) Release()

Release - give the channel back

func (*Queue) Send

func (queue *Queue) Send(command string, parameters ...[]byte)

Send - send a message to a 1:1 queue but only if listener is connected