state

Documentation

Overview

Package state contains everything related to the synchronization state for MVDS.

Index

• Variables
• func NewMemorySyncState() *memorySyncState
• func NewPersistentSyncState(db *sql.DB) *sqliteSyncState
• type GroupID
  • func ToGroupID(b []byte) GroupID
• type MessageID
  • func ToMessageID(b []byte) MessageID
• type PeerID
• type RecordType
• type State
• type SyncState

Variables

var (
	ErrStateNotFound = errors.New("state not found")
)

Functions

func NewMemorySyncState

func NewMemorySyncState() *memorySyncState

func NewPersistentSyncState

func NewPersistentSyncState(db *sql.DB) *sqliteSyncState

Types

type GroupID

type GroupID [32]byte

func ToGroupID

func ToGroupID(b []byte) GroupID

ToGroupID converts a byte array to a GroupID.

type MessageID

type MessageID [32]byte

func ToMessageID

func ToMessageID(b []byte) MessageID

ToMessageID converts a byte array to a MessageID.

type PeerID

type PeerID [65]byte

PeerID is the ID for a specific peer.

type RecordType

type RecordType int

RecordType is the type for a specific record, either `OFFER`, `REQUEST` or `MESSAGE`.

const (
	OFFER RecordType = iota
	REQUEST
	MESSAGE
)

type State

type State struct {
	Type      RecordType
	SendCount uint64
	SendEpoch int64
	// GroupID is optional, thus nullable
	GroupID   *GroupID
	PeerID    PeerID
	MessageID MessageID
}

State is a struct used to store a records state(https://github.com/status-im/bigbrother-specs/blob/master/data_sync/mvds.md#state).

type SyncState

type SyncState interface {
	Add(newState State) error
	Remove(id MessageID, peer PeerID) error
	All(epoch int64) ([]State, error)
	Map(epoch int64, process func(State) State) error
}