Basic pub-sub
Ably Pub/Sub enables you to implement the publish-subscribe (pub-sub) pattern. Any number of publishers can send messages to a channel, and any number of subscribers can receive those messages. Publishers and subscribers are completely decoupled from one another.
Channels are used to separate messages into different topics. Messages contain the data that a client is communicating, such as the contents of an individual chat message, or an event that has occurred, such as updated financial information. Whilst billions of messages may be delivered by Ably, clients receive only the messages on the channels they subscribe to.
To get started with sending and receiving messages, all you need to do is:
Use a channel
Channels are used to separate your message traffic into different topics, and are identified by a unique name. Clients create or retrieve a channel and can then subscribe to them, and send messages to them.
Use the get() method to create or retrieve a channel instance:
const channel = realtime.channels.get('lab-gum-all');
CopyCopied!Subscribe to a channel
Clients subscribe to a channel to receive the messages published to it. Clients can subscribe to all messages, or only messages identified by specific names.
Subscribing is an operation that is only available to the realtime interface of Pub/Sub SDKs. This is because it requires establishing a persistent connection to Ably in order to receive messages in realtime.
Use the subscribe() method on a channel to receive any messages that are published to it.
The following is an example of subscribing to all messages on a channel:
const realtime = new Ably.Realtime('<loading API key, please wait>');
const channel = realtime.channels.get('lab-gum-all');
await channel.subscribe((message) => {
alert('Received: ' + message.data);
});
Demo OnlyCopyCopied!The following is an example of only subscribing to messages with a specific name:
await channel.subscribe('myEvent', (message) => {
console.log('message received for event ' + message.name);
console.log('message data:' + message.data);
});
CopyCopied!Publish a message
Publishing messages to a channel is how clients communicate with one another. Any subscribers will receive published messages as long as they are subscribed and have the subscribe capability for that channel.
Publishing is an operation available to the realtime and REST interfaces of Pub/Sub SDKs. REST publishing is more efficient if you don’t need to establish a persistent connection to Ably, such as to subscribe to messages. For example, if you have a server publishing messages to channels that doesn’t need to receive any updates from them.
Use the publish() method to send messages to a channel.
const realtime = new Ably.Realtime('<loading API key, please wait>');
const channel = realtime.channels.get('lab-gum-all');
await channel.publish('example', 'message data');
Demo OnlyCopyCopied!