rill-protocol 0.41.0

The RillRate protocol.
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

use crate::io::codec::BinaryCodec;
use crate::io::provider::{Description, EntryId, PackedEvent, PackedState, Path, RecorderRequest};
use crate::io::transport::{DirectId, Origin, ServiceEnvelope};
use meio_protocol::Protocol;
use serde::{Deserialize, Serialize};

pub type ClientReqId = DirectId<ClientProtocol>;

#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Hash)]
pub struct ClientProtocol;

impl Protocol for ClientProtocol {
    type ToServer = ServiceEnvelope<Self, ClientRequest, ClientServiceResponse>;
    type ToClient = ServiceEnvelope<Self, ClientResponse, ClientServiceRequest>;
    type Codec = BinaryCodec;
}

impl Origin for ClientProtocol {}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ClientRequest {
    pub path: Path,
    pub request: RecorderRequest,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ClientResponse {
    Declare(EntryId),
    Flow(Description),
    State(PackedState),
    Delta(PackedEvent),
    /// Stream closed/finished.
    Done,
    Error(String),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ClientServiceRequest {
    //Ping,
    AccessLevel(AccessLevel),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ClientServiceResponse {
    //Pong,
}

/// `AccessLevel` notifies about specific stages of a session:
/// - session created (ready for pings)
/// - client can sign in or sign up
/// - client can work will all accessible flows
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum AccessLevel {
    SessionCreated,
    ReadyToAuth,
    ReadyToWork,
}