uniudp 1.0.0

Unidirectional UDP transport with chunking, redundancy, and Reed-Solomon FEC.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

#![doc = include_str!("../README.md")]
#![forbid(unsafe_code)]

mod checksum;
mod error;
pub mod fec;
mod header_validation;
pub mod packet;
pub mod receiver;
pub mod sender;
mod types;

pub use error::{
    DecodeContext, EncodeContext, ErrorDetail, ReceiveRejectReason, Result, UniUdpError,
    ValidationContext,
};

pub mod auth {
    pub use crate::types::{PacketAuth, PacketAuthKey};
}

pub mod config {
    pub use crate::types::{
        AuthMode, ReceiverConfig, ReceiverRuntimeConfig, DEDUP_WINDOW, DEFAULT_CHUNK_SIZE,
        DEFAULT_MESSAGE_FRESHNESS_WINDOW, HEADER_LENGTH, MAX_COMPLETED_MESSAGES, MAX_PENDING_BYTES,
        MAX_PENDING_MESSAGES, MAX_RECEIVE_CHUNKS, MAX_RECEIVE_DATAGRAM_SIZE,
        MAX_RECEIVE_MESSAGE_LEN, MAX_TRACKED_SESSIONS_PER_SENDER, MAX_TRACKED_SESSIONS_TOTAL,
        PACKET_AUTH_KEY_LENGTH, PACKET_AUTH_TAG_LENGTH, PACKET_CHECKSUM_OFFSET, PENDING_MAX_AGE,
        SAFE_UDP_PAYLOAD, SESSION_FRESHNESS_RETENTION,
    };
}

pub mod message {
    pub use crate::types::{
        CompletionReason, IncompletePayloadError, MessageChunk, MessageKey, MessageReport,
        SenderId, SourcePolicy,
    };
}

pub mod options {
    pub use crate::fec::FecMode;
    pub use crate::types::{
        ReceiveDiagnostics, ReceiveOptions, SendIdentityOverrides, SendOptions,
    };
}

pub mod prelude {
    pub use crate::auth::{PacketAuth, PacketAuthKey};
    pub use crate::config::{AuthMode, ReceiverConfig, ReceiverRuntimeConfig};
    pub use crate::message::{
        CompletionReason, IncompletePayloadError, MessageKey, MessageReport, SenderId, SourcePolicy,
    };
    pub use crate::options::{
        FecMode, ReceiveDiagnostics, ReceiveOptions, SendIdentityOverrides, SendOptions,
    };
    pub use crate::receiver::{ReceiveLoopControl, Receiver};
    pub use crate::sender::{
        MessageIdStart, SendFailure, SendRequest, SendScratch, Sender, SenderBuilder,
    };
    pub use crate::{Result, UniUdpError};
}

// Compile-time assertions for documented threading guarantees.
#[doc(hidden)]
const _: fn() = || {
    fn assert_send_sync<T: Send + Sync>() {}
    assert_send_sync::<crate::sender::Sender>();
    assert_send_sync::<crate::receiver::Receiver>();
};