aranya-daemon-api 6.0.0

IPC API between the Aranya client and daemon
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

#![cfg(feature = "afc")]
#![cfg_attr(docsrs, doc(cfg(feature = "afc")))]

pub use aranya_fast_channels::{shm, LocalChannelId as AfcLocalChannelId};
use aranya_id::custom_id;
use serde::{Deserialize, Serialize};

use crate::{DeviceId, LabelId};

custom_id! {
    /// An globally unique AFC channel ID.
    pub struct AfcChannelId;
}

/// A serialized command for AFC.
pub type AfcCtrl = Box<[u8]>;

/// AFC shared-memory info.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct AfcShmInfo {
    pub path: Box<shm::Path>,
    pub max_chans: usize,
}

/// Information returned when creating an AFC send channel.
#[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd, Serialize, Deserialize)]
pub struct AfcSendChannelInfo {
    pub ctrl: AfcCtrl,
    pub local_channel_id: AfcLocalChannelId,
    pub channel_id: AfcChannelId,
}

/// Information returned when receiving an AFC receive channel.
#[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd, Serialize, Deserialize)]
pub struct AfcReceiveChannelInfo {
    pub local_channel_id: AfcLocalChannelId,
    pub channel_id: AfcChannelId,
    pub label_id: LabelId,
    pub peer_id: DeviceId,
}