Module types

Structs

Pid

Support struct used for uniquely identifying Participant over the Network.

Promises

use promises to modify the behavior of Streams. see the consts in this struct for

Sid

Unique ID per Stream, in one Channel. one side will always start with 0, while the other start with u64::MAX / 2. number increases for each created Stream.

Constants

HIGHEST_PRIO

Maximal possible Prio to choose (for performance reasons)

STREAM_ID_OFFSET1 🔒

STREAM_ID_OFFSET2 🔒

VELOREN_MAGIC_NUMBER 🔒

VELOREN_NETWORK_VERSION

When this semver differs, 2 Networks can’t communicate.

Functions

sixlet_to_str 🔒

Type Aliases

Bandwidth

guaranteed Bandwidth. See Prio

Cid

ChannelID, unique ID per Channel (Protocol)

Mid

MessageID, unique ID per Message.

Prio

Every Stream has a Prio and guaranteed Bandwidth. Every send, the guarantees part is used first. If there is still bandwidth left, it will be shared by all Streams with the same priority. Prio 0 will be send first, then 1, … till the last prio 7 is send. Prio must be < 8!