daemon-engine 0.6.0

A helper package for writing unix rust daemons with IPC based clients
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

//#![feature(await_macro, async_await, futures_api)]

/**
 * rust-daemon
 * Core module, re-exports client and server components
 *
 * https://github.com/ryankurte/rust-daemon
 * Copyright 2018 Ryan Kurte
 */

extern crate libc;
extern crate users;

extern crate futures;
extern crate bytes;

#[macro_use]
extern crate tokio;
extern crate tokio_io;
extern crate tokio_codec;
extern crate tokio_uds;
extern crate tokio_tcp;
extern crate tokio_udp;
extern crate tokio_timer;

extern crate serde;
extern crate serde_json;

#[cfg(test)]
#[macro_use]
extern crate serde_derive;

extern crate tokio_serde_json_mirror as tokio_serde_json;

#[macro_use]
extern crate log;
extern crate uuid;

trait GenericServer {
    type Address;
    type Request;
    type Response;
    
    fn send(&mut self, _: Self::Address);
    //fn incoming(&mut self) -> Option<UnboundedReceiver<Request<>>>;
}

/// Server provides a generic server over a stream and codec
/// This is used to implement daemon servers (ie. long running processes w/ network communication)
pub mod server;
pub use crate::server::Server;

/// Connection provides a generic connection over a stream and codec
/// This is used to implement clients (ie. for a command line utility)
pub mod connection;
pub use crate::connection::Connection;

/// Codecs implement protocol handling over connectors
pub mod codecs;

/// TCP implements a TCP socket server and connection
pub mod tcp;
pub use crate::tcp::{TcpServer, TcpInfo, TcpConnection};

/// UDP implements a UDP socket connection
/// As UDP is connection-less, no server is required
pub mod udp;
pub use crate::udp::{UdpConnection, UdpInfo};

/// Unix implements a Unix socket server and connection
pub mod unix;
pub use crate::unix::{UnixServer, UnixInfo, UnixConnection};

/// Error implements errors returned by the daemon
pub mod error;
pub use crate::error::Error as DaemonError;


/// JsonCodec re-exports the JSON codec for convenience
/// This is an alias of JsonCodec with default JsonError, use codecs::json::JsonCodec to specify error type manually
pub type JsonCodec<Req, Resp> = codecs::json::JsonCodec<Req, Resp, codecs::json::JsonError>;

use futures::{future, Future, sync::oneshot};

/// AsyncWait implements a `.wait()` equivalent that works from any contex.
/// This is required because at some point in the past `.wait()` stopped doing this,
/// and thus calling it in a polling context causes everything to lock up.
/// see: https://github.com/tokio-rs/tokio-core/issues/182 and related issues.
/// ``` norun
/// // This will block forever if run in the main thread context
/// let _client = TcpConnection::<JsonCodec<Request, Response>>::new(&addr, JsonCodec::new()).wait().unwrap();
/// // This will work in the expected manner and return once connection has completed
/// let _client = TcpConnection::<JsonCodec<Request, Response>>::new(&addr, JsonCodec::new()).async_wait().unwrap();
/// ```
pub trait AsyncWait<I, E> {
    fn async_wait(self) -> Result<I, E>;
}

impl <F, I, E> AsyncWait<I, E> for F 
where 
    F: Future<Item=I, Error=E> + Send + 'static,
    I: Send + 'static,
    E: Send + 'static,
{
    fn async_wait(self) -> Result<I, E> {
        let (tx, rx) = oneshot::channel::<Result<I, E>>();

        tokio::spawn(self.then(|res| tx.send(res) ).map(|_v| () ).map_err(|_e| () ));

        rx.wait().unwrap()
    }
}