pallas-network 1.1.1

Ouroboros networking stack using async IO
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

use thiserror::Error;

use crate::miniprotocols::localmsgsubmission::DmqMsg;
use crate::multiplexer;

/// Errors produced by the local-message-notification protocol.
#[derive(Error, Debug)]
pub enum Error {
    /// Tried to receive while we hold agency.
    #[error("attempted to receive message while agency is ours")]
    AgencyIsOurs,

    /// Tried to send while the peer holds agency.
    #[error("attempted to send message while agency is theirs")]
    AgencyIsTheirs,

    /// Inbound message is not valid for the current state.
    #[error("inbound message is not valid for current state")]
    InvalidInbound,

    /// Outbound message is not valid for the current state.
    #[error("outbound message is not valid for current state")]
    InvalidOutbound,

    /// Caller tried to re-initialize an already-running protocol.
    #[error("protocol is already initialized, no need to wait for init message")]
    AlreadyInitialized,

    /// Underlying multiplexer error.
    #[error("error while sending or receiving data through the channel")]
    Plexer(multiplexer::Error),
}

/// Local-message-notification state-machine state.
#[derive(Debug, PartialEq, Eq, Clone)]
pub enum State {
    /// Idle: client may request messages or terminate.
    Idle,
    /// Server is collecting messages, blocking until at least one arrives.
    BusyBlocking,
    /// Server is collecting messages, returning whatever is available immediately.
    BusyNonBlocking,
    /// Protocol terminated.
    Done,
}

/// Local-message-notification protocol message.
#[derive(Debug)]
pub enum Message {
    /// Client → server: return queued messages without blocking.
    RequestMessagesNonBlocking,
    /// Server → client: messages plus a flag indicating whether more are available.
    ReplyMessagesNonBlocking(Vec<DmqMsg>, bool),
    /// Client → server: block until at least one message is available.
    RequestMessagesBlocking,
    /// Server → client: the awaited batch of messages.
    ReplyMessagesBlocking(Vec<DmqMsg>),
    /// Client → server: terminate the protocol.
    ClientDone,
}