bmmc

Documentation

Index

• Constants
• type BMMC
  • func New(cfg *Config) (*BMMC, error)
  • func (b *BMMC) AddMessage(msg interface{}, callbackType string) error
  • func (b *BMMC) AddPeer(addr, port string) error
  • func (b *BMMC) GetMessages() []interface{}
  • func (b *BMMC) GetPeers() []string
  • func (b *BMMC) RemovePeer(addr, port string) error
  • func (b *BMMC) Start() error
  • func (b *BMMC) Stop()
• type Config
• type GossipRound
  • func NewGossipRound() *GossipRound
  • func (r *GossipRound) GetNumber() int64
  • func (r *GossipRound) Increment()
• type HTTPGossip
• type HTTPSolicitation
• type HTTPSynchronization

Constants

const (
	// NOCALLBACK is callback type for messages without callback
	NOCALLBACK = callback.NOCALLBACK
)

Types

type BMMC

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

BMMC is the bimodal multicast protocol

func New

func New(cfg *Config) (*BMMC, error)

New creates a new instance for the protocol

func (*BMMC) AddMessage

func (b *BMMC) AddMessage(msg interface{}, callbackType string) error

AddMessage adds new message in messages buffer.

func (*BMMC) AddPeer

func (b *BMMC) AddPeer(addr, port string) error

AddPeer adds new peer in peers buffer

func (*BMMC) GetMessages

func (b *BMMC) GetMessages() []interface{}

GetMessages returns a slice with all messages from messages buffer

func (*BMMC) GetPeers

func (b *BMMC) GetPeers() []string

GetPeers returns an array with all peers from peers buffer

func (*BMMC) RemovePeer

func (b *BMMC) RemovePeer(addr, port string) error

RemovePeer removes given peer from peers buffer

func (*BMMC) Start

func (b *BMMC) Start() error

Start starts the gossip server and the http server

func (*BMMC) Stop

func (b *BMMC) Stop()

Stop stops the gossip server and the http server

type Config

type Config struct {
	// Addr is HTTP address for node which runs http servers
	// Required
	Addr string
	// Port is HTTP port for node which runs http servers
	// Required
	Port string
	// Beta is the expected fanout for gossip rounds
	// Optional
	Beta float64
	// Logger
	// Optional
	Logger *log.Logger
	// Callbacks funtions
	// Optional
	Callbacks map[string]func(interface{}, *log.Logger) error
	// Gossip round duration
	// Optional
	RoundDuration time.Duration
}

Config is the config for the protocol

type GossipRound

type GossipRound struct {
	Number int64       `json:"number"`
	Mux    *sync.Mutex `json:"mux"`
}

GossipRound is the number of gossiper rounds

func NewGossipRound

func NewGossipRound() *GossipRound

NewGossipRound creates new GossipRound

func (*GossipRound) GetNumber

func (r *GossipRound) GetNumber() int64

GetNumber returns the gossip round numbers

func (*GossipRound) Increment

func (r *GossipRound) Increment()

Increment increments the gossip round numbers

type HTTPGossip

type HTTPGossip struct {
	Addr        string              `json:"addr"`
	Port        string              `json:"port"`
	RoundNumber *GossipRound        `json:"roundNumber"`
	Digests     buffer.DigestBuffer `json:"digests"`
}

HTTPGossip is gossip message for http server

type HTTPSolicitation

type HTTPSolicitation struct {
	Addr        string              `json:"addr"`
	Port        string              `json:"port"`
	RoundNumber *GossipRound        `json:"roundNumber"`
	Digests     buffer.DigestBuffer `json:"digests"`
}

HTTPSolicitation is solicitation message for http server

type HTTPSynchronization

type HTTPSynchronization struct {
	Addr     string               `json:"addr"`
	Port     string               `json:"port"`
	Messages buffer.MessageBuffer `json:"messages"`
}

HTTPSynchronization is synchronization message for http server