wamp_async

Lines of Code

An asynchronous WAMP client implementation written in rust.

Usage

For usage examples, see :

Publisher/Subscriber

rust // 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());

rust // 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

rust // Call endpoint with one argument let (args, kwargs) = client.call("peer.echo", Some(vec![12.into()]), None).await?; println!("RPC returned {:?} {:?}", args, kwargs);

```rust // Declare your RPC function async fn rpc_echo(args: Option, kwargs: Option) -> Result<(Option, Option), WampError> { println!("peer.echo {:?} {:?}", args, kwargs); Ok((args, kwargs)) }

// Register the function let rpcid = client.register("peer.echo", rpcecho).await?; ```

Structs Serialization and Deserialization

rust // 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);

```rust

[derive(serde::Deserialize, serde::Serialize)]

struct MyKwArgs { name: String, }

// Declare your RPC function async fn rpcecho(args: Option, kwargs: Option) -> Result<(Option, Option), WampError> { // You only need serde-deserializable structure (e.g. a tuple of two integers) let validargs: (i32, i32) = if let Some(args) = args { wampasync::tryfromargs(args)? } else { return Err(wampasync::WampError::UnknownError("positional args are required".tostring())); }; println!("Two integers are: {}, {}", validargs.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 rpcid = client.register("peer.echo", rpcecho).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.