5 releases (3 breaking)

0.3.1 Apr 4, 2021
0.3.0 Jan 14, 2021
0.2.0 Jan 14, 2021
0.1.0 Apr 6, 2020
0.0.1 Feb 20, 2020

#185 in Network programming

Download history 1/week @ 2021-02-23 9/week @ 2021-03-02 1/week @ 2021-03-09 4/week @ 2021-03-16 11/week @ 2021-03-23 29/week @ 2021-03-30 21/week @ 2021-04-06 18/week @ 2021-04-13 16/week @ 2021-04-20 17/week @ 2021-04-27 20/week @ 2021-05-04 2/week @ 2021-05-11 8/week @ 2021-05-18 3/week @ 2021-05-25 2/week @ 2021-06-01 8/week @ 2021-06-08

57 downloads per month

MIT/Apache

130KB
3K SLoC

wamp_async

crates.io mio Lines of Code

An asynchronous WAMP client implementation written in rust.

Usage

For usage examples, see :

  • Publisher/Subscriber

    // Publish event with no arguments and with acknowledgment
    let ack_id = client.publish("peer.heartbeat", None, None, true).await?;
    println!("Ack id {}", ack_id.unwrap());
    
    // Register for events
    let (_sub_id, mut event_queue) = client.subscribe("peer.heartbeat").await?;
    // Wait for the next event
    match event_queue.recv().await {
        Some((_pub_id, args, kwargs)) => println!("Event(args: {:?}, kwargs: {:?})", args, kwargs),
        None => println!("Event queue closed"),
    };
    
  • RPC caller & callee

    // Call endpoint with one argument
    let (args, kwargs) = client.call("peer.echo", Some(vec![12.into()]), None).await?;
    println!("RPC returned {:?} {:?}", args, kwargs);
    
    // Declare your RPC function
    async fn rpc_echo(args: Option<WampArgs>, kwargs: Option<WampKwArgs>) -> Result<(Option<WampArgs>, Option<WampKwArgs>), WampError> {
        println!("peer.echo {:?} {:?}", args, kwargs);
        Ok((args, kwargs))
    }
    
    // Register the function
    let rpc_id = client.register("peer.echo", rpc_echo).await?;
    

Structs Serialization and Deserialization

// Call endpoint with one argument
let (args, kwargs) = client.call("peer.echo", Some(vec![12.into()]), None).await?;
// or
let (args, kwargs) = client.call("peer.echo", Some(wamp_async::try_into_args((12,))), None).await?;
println!("RPC returned {:?} {:?}", args, kwargs);
#[derive(serde::Deserialize, serde::Serialize)]
struct MyKwArgs {
    name: String,
}

// Declare your RPC function
async fn rpc_echo(args: Option<WampArgs>, kwargs: Option<WampKwArgs>) -> Result<(Option<WampArgs>, Option<WampKwArgs>), WampError> {
    // You only need serde-deserializable structure (e.g. a tuple of two integers)
    let valid_args: (i32, i32) = if let Some(args) = args {
        wamp_async::try_from_args(args)?
    } else {
        return Err(wamp_async::WampError::UnknownError("positional args are required".to_string()));
    };
    println!("Two integers are: {}, {}", valid_args.0, valid_args.1);

    // You can also use a custom struct and use a little bit of Rust helpers
    let valid_kwargs: Option<MyKwArgs> = kwargs.map(wamp_async::try_from_kwargs).transpose()?;

    if let Some(MyKwArgs { name }) = valid_kwargs {
        println!("Name is {}", name);
    } else {
        println!("There were no kwargs specified");
    }

    Ok((
        Some(wamp_async::try_into_args(valid_args)?),
        valid_kwargs.map(wamp_async::try_into_kwargs).transpose()?,
    ))
}

// Register the function
let rpc_id = client.register("peer.echo", rpc_echo).await?;

Features

Feature Desciption Status
Websocket Use websocket as the transport
Secure Websocket Websocket over HTTPS
RawSocket Use lightweight TCP as the transport
Secure RawSocket RawSocket with TLS
MsgPack Use MessagePack for message serialization
JSON Uses JSON for message serialization

Client

Basic profile :

Feature Desciption Status
Publisher Ability to publish messages on topics
Subscriber Can subscribe and receive events for a topic
Caller Ability to call RPC endpoints
Callee Ability to register RPC endpoints

Advanced profile:

Feature Desciption Status
Client Authentication Low-level support for Client Authentication (Ticket-based, CRA)
Progressive Calls Partial results reported from Callee to Caller help wanted

License

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~10MB
~207K SLoC