yengine 0.0.8

Communication library for the Yate Engine external module 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

use futures::{AsyncRead, AsyncWrite};

use crate::{
    engine::{Engine, Error, Request},
    wire::MessageAck,
};

/// Abstraction of an external [`Module`].
pub trait Module {
    /// Errors which may occur while processing messages.
    type Error: From<Error>;

    /// Install handlers and watches for processing.
    ///
    /// After installing your handlers and watches,
    /// you might want to **.await** on some signal
    /// (`SIGINT` for example) and then call [`Engine::quit`].
    /// This will make the engine stop sending us messages
    /// and exit upon processing the last one.
    fn install<I, O>(&self, engine: &Engine<I, O>) -> impl Future<Output = Result<(), Self::Error>>
    where
        I: AsyncRead + Send + Unpin,
        O: AsyncWrite + Send + Unpin;

    /// Process an incoming `watch` from the engine.
    fn on_watch<I, O>(
        &self,
        _engine: &Engine<I, O>,
        _watch: MessageAck,
    ) -> impl Future<Output = Result<(), Self::Error>>
    where
        I: AsyncRead + Send + Unpin,
        O: AsyncWrite + Send + Unpin,
    {
        futures::future::ok(())
    }

    /// Process an incoming `message` from the engine.
    fn on_message<I, O>(
        &self,
        _engine: &Engine<I, O>,
        _request: &mut Request,
    ) -> impl Future<Output = Result<bool, Self::Error>>
    where
        I: AsyncRead + Send + Unpin,
        O: AsyncWrite + Send + Unpin,
    {
        futures::future::ok(false)
    }
}