xavi-client v0.2.3-0

Xavi - Realtime Channel Server

WebSocket interface for highly distributed systems

Client library

Features

• Channel Subscriptions: subscribe to multiple distributed channels and backend services via a unified API
• Two-way Messaging: communicate with backend services in an event driven fashion
• Message Integrity: messages are queued until sent, preserving order and data integrity

Getting started

Install Xavi

$ bower install xavi

Include dependency

<script src="xavi.min.js"></script>

Or load with RequireJS

define(["xavi"], function(xavi) {
	// ...
});

Create new client and connect to server

var client = new xavi.Client({
	host: "localhost",
	port: 8080
});

client.connect();

Subscribe to channels

client.subscribe("test.*");

Send and receive messages

client.on("test.channel", "command", function(message) {
	// ...
});

client.send(new xavi.Message({
	channel: "test.channel",
	command: "command",
	data: "Test message"
}));

To get up and running with the server library, please visit the xavi repository.

Contributing

Xavi is completely open source, and welcomes community contributions.

Before you start, please read our contribution guidelines.

At a glance

• Fork this repository
• Create a new branch
• When ready, submit a pull request

To contribute to other Xavi projects, visit the relevant repos:

• xavi - Server library
• xavi-middleware-auth - Authentication middleware
• xavi-middleware-cookie - Cookie middleware
• xavi-service-echo - Echo service binding
• xavi-service-irc - IRC service binding
• xavi-service-rabbitmq - RabbitMQ service binding
• xavi-service-redis - Redis service binding
• xavi-service-thrift - Thrift service binding
• xavi-service-zookeeper - ZooKeeper service wrapper

License

Xavi is distributed under the terms of the MIT License.

© 2014 Football Radar