types

Documentation

Index

• type ClientID
  • func NewClientIDFromInt(id int) ClientID
  • func (cid ClientID) Bytes() []byte
  • func (cid ClientID) Pb() string
• type EpochNr
  • func (e EpochNr) Bytes() []byte
  • func (e EpochNr) Pb() uint64
• type RetentionIndex
  • func (ri RetentionIndex) Bytes() []byte
  • func (ri RetentionIndex) Pb() uint64
• type SeqNr
  • func (sn SeqNr) Bytes() []byte
  • func (sn SeqNr) Pb() uint64
• type TxID
• type TxNo
  • func (rn TxNo) Bytes() []byte
  • func (rn TxNo) Pb() uint64
• type VoteWeight
  • func (vw VoteWeight) Bytes() []byte

Types

type ClientID

type ClientID string

ClientID represents the ID of a client.

func NewClientIDFromInt

func NewClientIDFromInt(id int) ClientID

func (ClientID) Bytes

func (cid ClientID) Bytes() []byte

func (ClientID) Pb

func (cid ClientID) Pb() string

Pb converts a ClientID to its underlying native type.

type EpochNr

type EpochNr uint64

EpochNr represents the number of an epoch.

func (EpochNr) Bytes

func (e EpochNr) Bytes() []byte

func (EpochNr) Pb

func (e EpochNr) Pb() uint64

Pb converts an EpochNr number to its underlying native type.

type RetentionIndex

type RetentionIndex uint64

RetentionIndex represents an abstract notion of system progress used in garbage collection. The basic idea is to associate various parts of the system (parts of the state, even whole modules) that are subject to eventual garbage collection with a retention index. As the system progresses, the retention index monotonically increases and parts of the system associated with a lower retention index can be garbage-collected.

func (RetentionIndex) Bytes

func (ri RetentionIndex) Bytes() []byte

Bytes converts a RetentionIndex to a slice of bytes (useful for serialization).

func (RetentionIndex) Pb

func (ri RetentionIndex) Pb() uint64

Pb converts a RetentionIndex to its underlying native type.

type SeqNr

type SeqNr uint64

SeqNr represents the sequence number of a batch as assigned by the ordering protocol.

func (SeqNr) Bytes

func (sn SeqNr) Bytes() []byte

Bytes converts a SeqNr to a slice of bytes (useful for serialization).

func (SeqNr) Pb

func (sn SeqNr) Pb() uint64

Pb converts a SeqNr to its underlying native type.

type TxID

type TxID = string

TxID is a unique identifier of a transaction.

type TxNo

type TxNo uint64

TxNo represents a request number a client assigns to its requests.

func (TxNo) Bytes

func (rn TxNo) Bytes() []byte

Bytes converts a TxNo to a slice of bytes (useful for serialization).

func (TxNo) Pb

func (rn TxNo) Pb() uint64

Pb converts a TxNo to its underlying native type.

type VoteWeight

type VoteWeight uint64

VoteWeight represents the weight of a node's vote when gathering quorums.

func (VoteWeight) Bytes

func (vw VoteWeight) Bytes() []byte