bmmc

Documentation

Index

• Constants
• type BMMC
  • func New(cfg *Config) (*BMMC, error)
  • func (b *BMMC) AddMessage(msg any, callbackType string) error
  • func (b *BMMC) AddPeer(p string) error
  • func (b *BMMC) GetMessages() []any
  • func (b *BMMC) GetPeers() []string
  • func (b *BMMC) GossipHandler(body []byte)
  • func (b *BMMC) RemovePeer(p string) error
  • func (b *BMMC) SolicitationHandler(body []byte)
  • func (b *BMMC) Start() error
  • func (b *BMMC) Stop()
  • func (b *BMMC) SynchronizationHandler(body []byte)
• type Config
• type Gossip
• type GossipRound
  • func NewGossipRound() *GossipRound
  • func (r *GossipRound) GetNumber() int64
  • func (r *GossipRound) Increment()
• type Solicitation
• type Synchronization

Constants

const (
	// GossipRoute is the route for gossip messages.
	GossipRoute = "/gossip"
	// SolicitationRoute is the route for solicitation messages.
	SolicitationRoute = "/solicitation"
	// SynchronizationRoute is the route for synchronization messages.
	SynchronizationRoute = "/synchronization"
)

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 any, callbackType string) error

AddMessage adds new message in messages buffer.

func (*BMMC) AddPeer

func (b *BMMC) AddPeer(p string) error

AddPeer adds new peer in peers buffer.

func (*BMMC) GetMessages

func (b *BMMC) GetMessages() []any

GetMessages returns a slice with all user messages from messages buffer.

func (*BMMC) GetPeers

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

GetPeers returns an array with all peers from peers buffer.

func (*BMMC) GossipHandler

func (b *BMMC) GossipHandler(body []byte)

GossipHandler handles a gossip message.

func (*BMMC) RemovePeer

func (b *BMMC) RemovePeer(p string) error

RemovePeer removes given peer from peers buffer.

func (*BMMC) SolicitationHandler

func (b *BMMC) SolicitationHandler(body []byte)

SolicitationHandler handles a solicitation message.

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.

func (*BMMC) SynchronizationHandler

func (b *BMMC) SynchronizationHandler(body []byte)

SynchronizationHandler handles a synchronization message.

type Config

type Config struct {
	// Host is the host peer.
	// Required.
	Host peer.Peer
	// Beta is the expected fanout for gossip rounds.
	// Optional
	Beta float64
	// Logger.
	// Optional
	Logger *slog.Logger
	// Callbacks functions.
	// Optional
	Callbacks map[string]func(any, *slog.Logger) error
	// Gossip round duration.
	// Optional
	RoundDuration time.Duration
	// Buffer size.
	// When the buffer is full, the oldest message will be removed.
	// Required
	BufferSize int
}

Config is the config for the protocol.

type Gossip

type Gossip struct {
	Host        string       `json:"host"`
	RoundNumber *GossipRound `json:"roundNumber"`
	Digest      []string     `json:"digest"`
}

Gossip is gossip message for http server.

type GossipRound

type GossipRound struct {
	Number int64         `json:"number"`
	Mux    *sync.RWMutex `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 Solicitation

type Solicitation struct {
	Host        string       `json:"host"`
	RoundNumber *GossipRound `json:"roundNumber"`
	Digest      []string     `json:"digest"`
}

Solicitation is solicitation message for server.

type Synchronization

type Synchronization struct {
	Host     string           `json:"host"`
	Elements []buffer.Element `json:"elements"`
}

Synchronization is synchronization message for server.