Skip to content

Latest commit

 

History

History
199 lines (147 loc) · 8.73 KB

README.md

File metadata and controls

199 lines (147 loc) · 8.73 KB
Raw

Asynchronous Web Application Messaging Protcol (v2)

API Docs Crates.io Code coverage Tests MPL-2.0 licensed Gitter chat loc

Wampire is a asynchronous Web Application Messaging Protcol v2 router library, client library, and a router service, that implements most of the features defined in the advanced profile. The wampire project is written in Rust and designed for highly concurrent asynchronous I/O. The wampire router provides extended functionality. The router and client interaction with other WAMP implementations. Project initially forked from wamp-rs v0.1.0.

WAMP use-cases

WAMP comparison

Alright. So how does WAMP stack up versus other technologies?

Do we really need another wheel? Yes. Please read below to find out why we think so.

Below you’ll find a table comparing WAMP to other technologies according to six criteria:

  1. PubSub Does it support Publish & Subscribe out of the box?

  2. RPC Does it support Remote Procedure Calls out of the box?

  3. Routed RPC Does it support routed (not only point-to-point) Remote Procedure Calls?

  4. Web native Does it run natively on the Web (without tunneling or bridging)?

  5. Cross Language Does it work from different programming languages and run-times?

  6. Open Standard Is there an open, official specification implemented by different vendors?

See also: Web Technologies for the Internet of Things - A master thesis which contains a comparison of WAMP, MQTT, CoAP, REST, SOAP, STOMP and MBWS for IoT applications.

Technology PubSub RPC Routed RPC Web native Cross Language Open Standard
WAMP ✔ ✔ ✔ ✔ ✔ ✔
AJAX - ✔ - ✔ ✔ -
AMQP ✔ (✔) - - ✔ ✔
Apache Thrift - ✔ - - ✔ -
Capn’n’Proto - ✔ - - ✔ -
Comet - - - ✔ ✔ -
OMG DDS ✔ - - - ✔ ✔
D-Bus ✔ ✔ ✔ - ✔ ✔
CORBA ✔ ✔ - - ✔ ✔
DCOM ✔ ✔ - - ✔ -
Java JMS ✔ - - - - ✔
Java RMI - ✔ - - - ✔
JSON-RPC - ✔ - ✔ ✔ ✔
MQTT ✔ - - - ✔ ✔
OPC-UA (✔) ✔ - (✔) ✔
REST - ✔ - ✔ ✔ -
SOAP - ✔ - ✔ ✔ ✔
socket.io ✔ - - ✔ - -
SockJS - - - ✔ ✔ -
STOMP ✔ - - ✔ ✔ ✔
XML-RPC - ✔ - ✔ ✔ ✔
XMPP ✔ - - ✔ ✔ ✔
ZMQ ✔ - - - ✔ -

Implementations

There a lot of implementations for different languages. Read more..

Frequently Asked Questions

Read more..

Full Documentation

See the Wampire Project Wiki for full documentation, examples, and operational details.

At present the entire Basic Profile is supported, as well as pattern based subscriptions and registrations from the Advanced Profile.

You may be looking for:

There is currently no support for secure connections.

To include in your project, place the following in your Cargo.toml

[dependencies]
wampire = "0.2"

Wampire uses serde-rs, which requires Rust 1.15 or greater.

Router

To start router in development mode use

RUST_LOG=info cargo run wampire

Nginx configuration

To pass WebSocket connection to router add it to Nginx config. PS. can be used with SSL too.

location /ws/ {
    proxy_pass http://127.0.0.1:8090;
    
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection $connection_upgrade;
    proxy_read_timeout 1800s;

    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

Systemd

Build router:

  1. Clone repo using git clone https://github.com/ohyo-io/wampire.git
  2. cd wampire && cargo build
  3. Copy wampire from target folder to /usr/local/bin
  4. Copy wampire.service from dist to /usr/lib/systemd/system or /lib/systemd/system (depend on your system).

To start a service:

systemctl start wampire

To enable as system service:

systemctl enable wampire

Examples

Please see the examples directory. For instructions on how to check the examples

RUST_LOG=info cargo run --example api_user
RUST_LOG=info cargo run --example endpoint
RUST_LOG=info cargo run --example pubsubclient

Advanced Profile Feature Support

See FEATURES for details.

Extended Functionality

Wampire provides extended functionality around subscriber black/white listing and in the information available via the session meta API.
This enhances the ability of clients to make desisions about message recipients.

Supporting Wampire

Wampire is an MIT-licensed open source project. It's an independent project with its ongoing development made possible entirely thanks to the support by these awesome backers. If you'd like to join them, please consider:

Become a patron ko-fi

License

This work is licensed under the MIT license. See LICENSE for details.