Wampire is a 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.
Check the examples/webrtc-simple folder for nodejs based example using wampire as signaling server for WebRTC connection.
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:
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
toml
[dependencies]
wampire = "0.1"
Wampire uses serde-rs, which requires Rust 1.15 or greater.
To start router in development mode use
bash
RUST_LOG=info cargo run wampire
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;
} ```
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:
bash
systemctl start wampire
To enable as system service:
bash
systemctl enable wampire
Please see the examples directory. For instructions on how to check the examples
bash
RUST_LOG=info cargo run --example api_user
bash
RUST_LOG=info cargo run --example endpoint
bash
RUST_LOG=info cargo run --example pubsubclient
| Feature | Supported | | ------- | --------- | | progressivecallresults | Yes | | progressivecalls | No | | calltimeout | Yes | | callcanceling | Yes | | calleridentification | Yes | | calltrustlevels | No | | registrationmetaapi | Yes | patternbasedregistration | Yes | | sharedregistration | Yes | | shardedregistration | No | | registrationrevocation | No | | procedure_reflection | No |
| Feature | Supported | | ------- | --------- | | subscriberblackwhitelisting | Yes | | publisherexclusion | Yes | | publisheridentification | Yes | | publicationtrustlevels | No| | subscriptionmetaapi | Yes | | patternbasedsubscription | Yes | | shardedsubscription | No | | eventhistory | No | | topicreflection | No | | testamentmetaapi | Yes |
| Feature | Supported | | ------- | --------- | | challenge-response authentication | Yes | | cookie authentication | Yes | | ticket authentication | Yes | | rawsocket transport | Yes | | batched WS transport | No | | longpoll transport | No | | session meta api | Yes | | TLS for websockets | Yes | | TLS for rawsockets | Yes | | websocket compression | Yes |
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.
This work is licensed under the MIT license. See LICENSE for details.