Struct Endpoint

pub struct Endpoint<S: ServiceWithClient, T: AsyncRead + AsyncWrite> { /* private fields */ }

A Future for running both a client and a server at the same time.

The client part will be provided to the ServiceWithClient::handle_request and ServiceWithClient::handle_notification methods, so that the server can send back requests and notifications as part of its handling duties. You may also access the client with the client() method if you want to send additional requests.

The returned future needs to be spawned onto a task in order to actually run the server (and the client). It will run until the stream is closed; if the stream encounters an error, the future will propagate it and terminate.

extern crate futures;
extern crate rmp_rpc;
extern crate tokio;

use futures::{Future, Stream};
use rmp_rpc::ServiceWithClient;
use std::net::SocketAddr;
use tokio::net::TcpListener;

struct MyService;
impl ServiceWithClient for MyService {
// ...
}

fn main() {
    let addr: SocketAddr = "127.0.0.1:54321".parse().unwrap();

    // Here's the simplest version: we listen for incoming TCP connections and run an
    // endpoint on each one.
    let server = TcpListener::bind(&addr).unwrap()
        .incoming()
        // Each time the listener finds a new connection, start up an endpoint to handle
        // it.
        .map_err(|e| println!("error on TcpListener: {}", e))
        .for_each(move |stream| {
            Endpoint::new(stream, MyService).map_err(|e| println!("error on endpoint {}", e))
        });
    // Uncomment this to run the server on the tokio event loop. This is blocking.
    // Press ^C to stop
    // tokio::run(server);

    // Here's an alternative, where we take a handle to the client and spawn the endpoint
    // on its own task.
    let addr: SocketAddr = "127.0.0.1:65432".parse().unwrap();
    let server = TcpListener::bind(&addr)
        .unwrap()
        .incoming()
        .map_err(|e| println!("error on TcpListener: {}", e))
        .for_each(move |stream| {
            let end = Endpoint::new(stream, MyService);
            let client = end.client();

            // Spawn the endpoint. It will do its own thing, while we can use the client
            // to send requests.
            tokio::spawn(end.map_err(|_| ()));

            // Send a request with method name "hello" and argument "world!".
            client
                .request("hello", &["world!".into()])
                .map(|response| println!("{:?}", response))
                .map_err(|e| println!("got an error: {:?}", e))
            // We're returning the future that came from `client.request`. This means that
            // `server` (and therefore our entire program) will terminate once the
            // response is received and the messages are printed. If you wanted to keep
            // the endpoint running even after the response is received, you could
            // (instead of spawning `end` on its own task) `join` the two futures (i.e.
            // `end` and the one returned by `client.request`).
        });

    // Uncomment this to run the server on the tokio event loop. This is blocking.
    // Press ^C to stop
    // tokio::run(server);
}

Implementations

impl<S: ServiceWithClient, T: AsyncRead + AsyncWrite> Endpoint<S, T>

pub fn new(stream: T, service: S) -> Self

Creates a new Endpoint on stream, using service to handle requests and notifications.

pub fn client(&self) -> Client

Returns a handle to the client half of this Endpoint, which can be used for sending requests and notifications.

Trait Implementations

impl<S: ServiceWithClient, T: AsyncRead + AsyncWrite> Future for Endpoint<S, T>

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = Error

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<Self::Item, Self::Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>

where Self: Sized,

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F>

where F: FnOnce(Self::Item) -> U, Self: Sized,

Map this future’s result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>

where F: FnOnce(Self::Error) -> E, Self: Sized,

Map this future’s error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E>

where E: From<Self::Error>, Self: Sized,

Map this future’s error to any error implementing From for this future’s Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F>

where F: FnOnce(Result<Self::Item, Self::Error>) -> B, B: IntoFuture, Self: Sized,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F>

where F: FnOnce(Self::Item) -> B, B: IntoFuture<Error = Self::Error>, Self: Sized,

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F>

where F: FnOnce(Self::Error) -> B, B: IntoFuture<Item = Self::Item>, Self: Sized,

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future>

where B: IntoFuture<Item = Self::Item, Error = Self::Error>, Self: Sized,

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future>

where B: IntoFuture, Self: Sized,

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future>

where B: IntoFuture<Error = Self::Error>, Self: Sized,

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>( self, b: B, c: C, ) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future>

where B: IntoFuture<Error = Self::Error>, C: IntoFuture<Error = Self::Error>, Self: Sized,

Same as join, but with more futures.

fn join4<B, C, D>( self, b: B, c: C, d: D, ) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future>

where B: IntoFuture<Error = Self::Error>, C: IntoFuture<Error = Self::Error>, D: IntoFuture<Error = Self::Error>, Self: Sized,

Same as join, but with more futures.

fn join5<B, C, D, E>( self, b: B, c: C, d: D, e: E, ) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future>

where B: IntoFuture<Error = Self::Error>, C: IntoFuture<Error = Self::Error>, D: IntoFuture<Error = Self::Error>, E: IntoFuture<Error = Self::Error>, Self: Sized,

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

where Self: Sized,

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self>

where Self::Item: IntoFuture, <Self::Item as IntoFuture>::Error: From<Self::Error>, Self: Sized,

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self>

where Self::Item: Stream<Error = Self::Error>, Self: Sized,

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

where Self: Sized,

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F>

where F: FnOnce(&Self::Item), Self: Sized,

Do something with the item of a future, passing it on.

fn catch_unwind(self) -> CatchUnwind<Self>

where Self: Sized + UnwindSafe,

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

where Self: Sized,

Create a cloneable handle to this future where all handles will resolve to the same result.