package
0.3.5
Repository: https://github.com/netrixframework/netrix.git
Documentation: pkg.go.dev

# Functions

GetParsedMessage[V] type casts [Message.ParsedMessage] to the specified type V.
Max[T] abstracts the max function for all ordered types T.
NewBaseService instantiates BaseService.
NewChannel[V] creates a Channel[V] object.
NewCounter returns a counter.
NewEmptyList[V] creates an empty List.
NewEvent creates an [Event] with the specified values.
NewEventDag creates a new [EventDAG].
NewEventNode creates a new [EventNode].
NewEventNodeSet creates an empty [EventNodeSet].
NewGenericEventType instantiates GenericEventType.
NewList[V] copies the contents of the specified list onto a new List object.
NewMap[T,V] creates an empty Map.
NewMessageReceiveEventType instantiates MessageReceiveEventType.
NewMessageSendEventType instantiates MessageSendEventType.
NewQueue[V] returns an empty Queue[V].
NewReplicaStore creates an empty ReplicaStore.
No description provided by the author
NewSet[T] creates an empty Set.
NewTimeoutEndEventType creates a new [TimeoutEventEventType].
NewTimeoutStartEventType creates a new [TimeoutStartEventType] with the specified timeout.
NewVarSet instantiates Vars.
No description provided by the author
VarSetGet returns the value with the specified label and typecasts it.
ZeroClock creates a new empty ClockValue.

# Variables

ErrBadParse occurs when [MessageParser] is nil.
ErrNoData occurs when [Message.Data] is empty.
ErrReplicaStoreFull is returned when more than the intended number of replicas register with the scheduler tool.

# Structs

BaseService provides the basic nuts an bolts needed to implement a service.
Channel[V] is a synchronized channel that can be reset (closed and opened) multiple times.
Counter threadsafe counter.
Event is a generic event that occurs at a replica.
EventDAG is directed acyclic graph (DAG) of the events.
EventNode encapsulates an [Event] with information about parents, children, clock value.
EventNodeSet is a thread safe node set.
GenericEventType is the event type published by a replica It can be specific to the algorithm that is implemented.
List[V] is a generic thread safe list.
Map[T,V] is a generic thread safe map of key type [T] and value type [V].
Message stores a message that has been intercepted between two replicas.
MessageReceiveEventType is the event type when a replica receives a message.
MessageSendEventType is the event type where a message is sent from the replica.
Queue is a generic pub-sub queue that is thread safe.
Replica immutable representation of the attributes of a replica.
ReplicaStore to store all replica information, thread safe.
No description provided by the author
No description provided by the author
Set[T] is thread safe generic set implementation.
TimeoutEndEventType represents a timeout end event.
TimeoutStartEventType represents a timeout start event.
VarSet is a dictionary for storing auxiliary state during the execution of the testcase VarSet is stored in the context passed to actions and conditions.

# Interfaces

Clonable is any type which returns a copy of itself on Clone().
EventType abstract type for representing different types of events.
MessageParser defines a generic parsing interface.
ParsedMessage encapsulates a message returned by [MessageParser].
RestartableService is a service which can be restarted.
Service is any entity which runs on a separate thread.

# Type aliases

ClockValue represents a vector clock value.
EventID is a unique identifier for each event.
MessageID is a unique identifier for each message.
ReplicaID is an identifier for the replica encoded as a string.