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
146
147

// Copyright 2017 tokio-jsonrpc Developers
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

#![doc(html_root_url = "https://docs.rs/tokio-jsonrpc/0.9.1/tokio_jsonrpc/")]

//! A JSON RPC protocol for the [tokio](https://tokio.rs) framework.
//!
//! This implements the handling of the
//! [JSON RPC 2.0](http://www.jsonrpc.org/specification) specification. The low-level parts are in
//! the [`message`](message/index.html) and the [`codec`](codec/index.html) modules. The first
//! draft of the higher-lever API is in the [`endpoint`](endpoint/index.html) module. Some helpers
//! to compose the server part is in the [`server`](server/index.html) module.
//!
//! # Examples
//!
//! A skeleton of reading messages from the other side, mapping them to answers and sending them
//! back.
//!
//! ```rust
//! # extern crate tokio_core;
//! # extern crate tokio_io;
//! # extern crate tokio_jsonrpc;
//! # extern crate futures;
//! #
//! # use tokio_core::reactor::Core;
//! # use tokio_core::net::TcpListener;
//! # use tokio_io::AsyncRead;
//! # use tokio_jsonrpc::LineCodec;
//! # use futures::{Stream, Sink, Future};
//! #
//! # fn main() {
//! let mut core = Core::new().unwrap();
//! let handle = core.handle();
//!
//! let listener = TcpListener::bind(&"127.0.0.1:2345".parse().unwrap(), &handle).unwrap();
//! let connections = listener.incoming();
//! let service = connections.for_each(|(stream, _)| {
//!     let messages = stream.framed(LineCodec::new());
//!     let (write, read) = messages.split();
//!     let answers = read.filter_map(|message| {
//!         match message {
//!             _ => unimplemented!(),
//!         }
//!     });
//!     handle.spawn(write.send_all(answers).map(|_| ()).map_err(|_| ()));
//!     Ok(())
//! });
//! # }
//! ```
//!
//! Provide a server that greets through an RPC.
//!
//! ```rust,no_run
//! # extern crate tokio_core;
//! # extern crate tokio_io;
//! # extern crate tokio_jsonrpc;
//! # extern crate futures;
//! # extern crate serde_json;
//! #
//! # use tokio_core::reactor::Core;
//! # use tokio_core::net::TcpListener;
//! # use tokio_io::AsyncRead;
//! # use tokio_jsonrpc::{LineCodec, Server, ServerCtl, RpcError, Endpoint};
//! # use futures::{Future, Stream};
//! # use serde_json::Value;
//! #
//! # fn main() {
//! let mut core = Core::new().unwrap();
//! let handle = core.handle();
//!
//! let listener = TcpListener::bind(&"127.0.0.1:2346".parse().unwrap(), &handle).unwrap();
//!
//! struct UselessServer;
//!
//! impl Server for UselessServer {
//!     type Success = String;
//!     type RpcCallResult = Result<String, RpcError>;
//!     type NotificationResult = Result<(), ()>;
//!     fn rpc(&self,
//!            ctl: &ServerCtl,
//!            method: &str,
//!            _params: &Option<Value>)
//!         -> Option<Self::RpcCallResult> {
//!         match method {
//!             // Accept a hello message and finish the greeting
//!             "hello" => Some(Ok("world".to_owned())),
//!             // When the other side says bye, terminate the connection
//!             "bye" => {
//!                 ctl.terminate();
//!                 Some(Ok("bye".to_owned()))
//!             },
//!             _ => None
//!         }
//!     }
//! }
//!
//! let connections = listener.incoming().for_each(|(stream, _)| {
//!     // Greet every new connection
//!     let (client, _) = Endpoint::new(stream.framed(LineCodec::new()), UselessServer)
//!         .start(&handle);
//!     let notified = client.notify("hello".to_owned(), None)
//!         .map(|_| ())
//!         .map_err(|_| ());
//!     handle.spawn(notified);
//!     Ok(())
//! });
//!
//! core.run(connections).unwrap();
//! # }
//! ```

extern crate serde;
// We use the json! macro only in the tests
extern crate bytes;
extern crate futures;
#[macro_use]
extern crate serde_derive;
#[cfg_attr(test, macro_use)]
extern crate serde_json;
#[macro_use]
extern crate slog;
extern crate tokio_core;
extern crate tokio_io;
extern crate uuid;

pub mod codec;
pub mod endpoint;
pub mod message;
pub mod server;

/// This contains some reexports so macros can find them.
///
/// It isn't for the direct use of the library consumer.
pub mod macro_exports {
    pub use serde_json::{from_value, Value};
    pub use std::option::Option;
    pub use std::result::Result;
}

pub use codec::{Boundary as BoundaryCodec, Line as LineCodec};
pub use endpoint::{Client, Endpoint, ServerCtl};
pub use message::{Message, Parsed, RpcError};
pub use server::Server;