falcorn-sdk 0.1.0

Falcorn SDK for interacting with the server IPC and plugins.
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use crate::error::{Error, Result};
use crate::wire::{read_frame, write_frame};
use falcorn_proto::logging::{
    PLUGIN_FILTER_ALL, PLUGIN_FRAME_MAGIC, PLUGIN_PROTOCOL_VERSION, PluginErrorFrame, PluginEvent,
    PluginFrameType, PluginPingFrame, PluginPongFrame, PluginSubscribeAck, PluginSubscribeRequest,
};
use std::os::unix::net::UnixStream;
use std::time::Duration;

#[derive(Clone, Debug)]
pub struct LoggingClientBuilder {
    socket: String,
    auth_token: Option<String>,
    client_name: Option<String>,
    filter_mask: u8,
    read_timeout: Option<Duration>,
    write_timeout: Option<Duration>,
}

impl LoggingClientBuilder {
    pub fn new(socket: impl Into<String>) -> Self {
        Self {
            socket: socket.into(),
            auth_token: None,
            client_name: None,
            filter_mask: PLUGIN_FILTER_ALL,
            read_timeout: None,
            write_timeout: None,
        }
    }

    pub fn auth_token(mut self, token: impl Into<String>) -> Self {
        self.auth_token = Some(token.into());
        self
    }

    pub fn client_name(mut self, name: impl Into<String>) -> Self {
        self.client_name = Some(name.into());
        self
    }

    pub fn filter_mask(mut self, mask: u8) -> Self {
        self.filter_mask = mask;
        self
    }

    pub fn read_timeout(mut self, timeout: Duration) -> Self {
        self.read_timeout = Some(timeout);
        self
    }

    pub fn write_timeout(mut self, timeout: Duration) -> Self {
        self.write_timeout = Some(timeout);
        self
    }

    pub fn connect(self) -> Result<LoggingClient> {
        let mut stream = UnixStream::connect(&self.socket)?;
        stream.set_read_timeout(self.read_timeout)?;
        stream.set_write_timeout(self.write_timeout)?;

        let subscribe = PluginSubscribeRequest {
            filter_mask: self.filter_mask,
            auth_token: self.auth_token,
            client_name: self.client_name,
        };
        let payload = bincode::serialize(&subscribe)?;
        write_frame(
            &mut stream,
            PLUGIN_FRAME_MAGIC,
            PLUGIN_PROTOCOL_VERSION,
            PluginFrameType::Subscribe as u8,
            &payload,
        )?;

        let (ft, payload) = read_frame(&mut stream, PLUGIN_FRAME_MAGIC, PLUGIN_PROTOCOL_VERSION)?;
        match PluginFrameType::from_u8(ft) {
            Some(PluginFrameType::Ack) => {
                let _ack: PluginSubscribeAck = bincode::deserialize(&payload)?;
            }
            Some(PluginFrameType::Error) => {
                let err: PluginErrorFrame = bincode::deserialize(&payload)?;
                return Err(Error::Remote {
                    code: err.code,
                    message: err.message,
                });
            }
            _ => {
                return Err(Error::Protocol("unexpected first frame".to_string()));
            }
        }

        Ok(LoggingClient { stream })
    }
}

pub struct LoggingClient {
    stream: UnixStream,
}

impl LoggingClient {
    pub fn builder(socket: impl Into<String>) -> LoggingClientBuilder {
        LoggingClientBuilder::new(socket)
    }

    pub fn next_event(&mut self) -> Result<PluginEvent> {
        loop {
            let (ft, payload) = read_frame(
                &mut self.stream,
                PLUGIN_FRAME_MAGIC,
                PLUGIN_PROTOCOL_VERSION,
            )?;
            match PluginFrameType::from_u8(ft) {
                Some(PluginFrameType::Event) => {
                    let evt: PluginEvent = bincode::deserialize(&payload)?;
                    return Ok(evt);
                }
                Some(PluginFrameType::Ping) => {
                    let ping: PluginPingFrame = bincode::deserialize(&payload)?;
                    let pong = PluginPongFrame {
                        ts_millis: ping.ts_millis,
                    };
                    let payload = bincode::serialize(&pong)?;
                    write_frame(
                        &mut self.stream,
                        PLUGIN_FRAME_MAGIC,
                        PLUGIN_PROTOCOL_VERSION,
                        PluginFrameType::Pong as u8,
                        &payload,
                    )?;
                }
                Some(PluginFrameType::Error) => {
                    let err: PluginErrorFrame = bincode::deserialize(&payload)?;
                    return Err(Error::Remote {
                        code: err.code,
                        message: err.message,
                    });
                }
                _ => {
                    return Err(Error::Protocol("unexpected frame".to_string()));
                }
            }
        }
    }
}