faye

What is faye?

Faye is a publish-subscribe messaging system based on the Bayeux protocol. It is designed to be used in both Node.js and browser environments, allowing for real-time messaging and communication between clients and servers.

What are faye's main functionalities?

Publish-Subscribe Messaging

This code demonstrates how to set up a Faye server and client for publish-subscribe messaging. The server listens on port 8000, and the client subscribes to the '/messages' channel to receive messages. The client also publishes a message to the same channel.

const faye = require('faye');

// Create a new Faye server
const server = new faye.NodeAdapter({mount: '/faye', timeout: 45});

// Start the server
server.listen(8000);

// Create a client
const client = new faye.Client('http://localhost:8000/faye');

// Subscribe to a channel
client.subscribe('/messages', function(message) {
  console.log('Received message:', message);
});

// Publish a message to the channel
client.publish('/messages', {text: 'Hello, world!'});

Client-Server Communication

This code demonstrates client-server communication using Faye. The server is set up to listen on port 8000, and the client subscribes to the '/chat' channel to handle incoming messages. The client also publishes a message to the '/chat' channel.

const faye = require('faye');

// Create a new Faye server
const server = new faye.NodeAdapter({mount: '/faye', timeout: 45});

// Start the server
server.listen(8000);

// Create a client
const client = new faye.Client('http://localhost:8000/faye');

// Define a function to handle incoming messages
function handleMessage(message) {
  console.log('Received message:', message);
}

// Subscribe to a channel
client.subscribe('/chat', handleMessage);

// Publish a message to the channel
client.publish('/chat', {user: 'Alice', text: 'Hi there!'});

Browser Integration

This code demonstrates how to integrate Faye with a browser environment. It includes the Faye browser script and sets up a client that subscribes to the '/notifications' channel to receive messages. The client also publishes a message to the same channel.

<script src="https://cdn.jsdelivr.net/npm/faye/browser/faye-browser-min.js"></script>
<script>
  // Create a client
  var client = new Faye.Client('http://localhost:8000/faye');

  // Subscribe to a channel
  client.subscribe('/notifications', function(message) {
    console.log('Received notification:', message);
  });

  // Publish a message to the channel
  client.publish('/notifications', {title: 'New Notification', body: 'You have a new message!'});
</script>

Other packages similar to faye

socket.io

Socket.IO is a library that enables real-time, bidirectional and event-based communication between web clients and servers. It is built on top of WebSockets and provides additional features such as fallback to HTTP long-polling, automatic reconnection, and rooms/namespaces. Compared to Faye, Socket.IO offers more advanced features and is widely used for real-time applications.

primus

Primus is a flexible and extensible library for real-time communication. It abstracts various real-time frameworks (including WebSockets, Engine.IO, and SockJS) and provides a unified API. Primus allows developers to switch between different real-time frameworks without changing the application code. Compared to Faye, Primus offers more flexibility in terms of underlying transport mechanisms.

pusher

Pusher is a hosted service that provides real-time messaging and event broadcasting. It offers a simple API for sending and receiving messages and supports various client libraries for different platforms. Pusher is a managed service, which means developers do not need to set up and maintain their own servers. Compared to Faye, Pusher is easier to set up but comes with a cost for the managed service.

README

Faye

Faye is a set of tools for simple publish-subscribe messaging between web clients. It ships with easy-to-use message routing servers for Node.js and Rack applications, and clients that can be used on the server and in the browser.

• Documentation: http://faye.jcoglan.com
• Mailing list: http://groups.google.com/group/faye-users
• Bug tracker: http://github.com/faye/faye/issues
• Source code: http://github.com/faye/faye

Changelog

1.4.0 / 2020-07-31

• Implement TLS certificate verification and enable it by default in the Ruby client class Faye::Client
• Add a :tls option to the Ruby client with sub-field :verify_peer for configuring TLS verification
• Officially support the tls option in the Node.js client, whose contents are forward to the https and tls modules as appropriate