React V4React V4Node.jsPhoneGapWebJavaScriptReact V4 Stream Controller Tutorial for Realtime Apps

 
Requires that the Stream Controller add-on is enabled for your key. How do I enable add-on features for my keys? - see http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys

When enabled via the PubNub Admin Console, the Stream Controller feature provides PubNub developers the ability to efficiently subscribe to multiple channels via Channel Multiplexing (MXing) and Channel Groups.

Channel and Channel Group names are UTF-8 compatible. Name length is limited to 64, and prohibited chars in a channel group are:

  • comma: ,
  • slash: /
  • backslash: \
  • period: .
  • asterisks: *
  • colon: :

Channel Multiplexing enables developers to subscribe to up to 50 channels (not within a channel group) over a single TCP socket. On mobile devices, its easy to realize the network bandwidth and battery power savings gained from channel multiplexing.

 
These code samples build off code defined in the Pub & Sub tutorial, so before proceeding, be sure you have completed the Pub & Sub tutorial first.

The examples below demonstrate how to subscribe and unsubscribe from multiple channels with a single call. The use of callbacks will give you a way to know when your operations complete successfully or with errors.

pubnub.subscribe({
    channels: ['my_channel_1', 'my_channel_2', 'my_channel_3']
});
pubnub.unsubscribe({
	channels: ['chan1', 'chan2', 'chan3']
})
Wildcard subscribes allow the client to subscribe to multiple channels using wildcard. E.g., if you subscribe to a.* you will get all messages for a.b, a.c, a.x. The wildcarded * portion refers to any portion of the channel string name after the dot (.).
 
3 levels (2 dots) of wildcarding is supported, e.g.:
a.*
a.b.*
pubnub.subscribe({
    channels: ['ab.*'] 
});

Channel Groups allows PubNub developers to bundle thousands of channels into a group that can be identified by name. These Channel Groups can then be subscribed to, receiving data from the many backend-channels the channel group contains.

When building with channel-groups, you may create an unlimited number of these uniquely named channel groups, each with up to 2000 channels in them. Up to 10 channel groups may be subscribed to per PubNub instance. The below diagram depicts this design pattern and default limits:

Channel Groups

As an example, for a group chat application, the channel group name would describe the conversation, and the channel names would be the chat audience's channels.

For a user rajat: family, friends and work are the chat room names (channel groups) and the channels are the contact's (channels), your design may look something like this:

  • rajat : family : wife
  • rajat : family : daughter
  • rajat : family : son
  • rajat : friends : pandu
  • rajat : friends : craig
  • rajat : friends : stephen
  • rajat : work : pandu
  • rajat : work : stephen
  • rajat : work : sergey

Given the above design pattern family, friends and work are the 3 channel groups, which each contain a handful of channels in different combinations such as wife, son, pandu, craig, stephen, etc.

Similarly for user alex: mychats is the chat room name (channel group) and the channels general-a-messages, general-a-keyboard-presence, general-j-messages, general-j-keyboard-presence, general-m-messages and general-m-keyboard-presence, your design may look something like this:

  • alex : mychats : general-a-messages
  • alex : mychats : general-a-keyboard-presence
  • alex : mychats : general-j-messages
  • alex : mychats : general-j-keyboard-presence
  • alex : mychats : general-m-messages
  • alex : mychats : general-m-keyboard-presence

Please contact support@pubnub.com if you feel this design pattern and/or default limits will not accommodate your application's design.

 

Each Channel Group and associated channel(s) is identified by a unique name. These names may be a string of up to 64 Unicode characters, excluding reserved characters: , , : , . , / , *, non-printable ASCII control characters and Unicode zero.

Before you use a channel group, you must first add a channel to it. Channels can be added from either a client-side (mobile phone, web page), or a server-side (Java, Ruby, Python) device.

For our example, lets create a chat application around channel groups. Each channel group will contain the members' topic channels for the group. The following steps will demonstrate:

  1. Defining the Channel Group
  2. Adding Channels to a Channel Group
  3. Subscribing to the Channel Group
  4. Unsubscribing to the Channel Group
  5. Receiving Channel Group Presence Messages
  6. Removing Channels from a Channel Group
  7. Listing all Channels in a Channel Group
  8. Removing a Channel from a Channel Group

We'll implicitly define a channel group called family.

// assuming an initialized PubNub instance already exists
pubnub.channelGroups.listChannels(
    {
        channelGroup: "family"
    }, 
    function (status, response) {
    }
);

We'll add the channel wife to the channel group channel_group.

// assuming an initialized PubNub instance already exists

pubnub.channelGroups.addChannels(
	{
		channels: ['wife'],
		channelGroup: "family"
	},
	function (status, response) {
	
    }
);

Continuing creation of the CG, we add the son and daughter channels to this channel group as well.

// assuming an initialized PubNub instance already exists

pubnub.channelGroups.addChannels(
    {
        channels: ['son', 'daughter'],
        channelGroup: "family"
    },
    function (status, response) {
     
    }
);

Now that we've added some channels to our CG, we need to subscribe to it. When a message arrives published to any of the channel group members, the message will arrive via the m variable in the message callback. The c variable will contain the source channel name.

pubnub.subscribe({
    channelGroups: ['family']
})

To stop receiving messages on a channel group you need to unsubscribe from the group:

pubnub.unsubscribe({
    channelGroups : 'family'
});

To enable receiving Presence messages for the CG, just set the presence attribute to the callback you wish to send presences messages to at subscribe-time :

pubnub.subscribe({
    channelGroups: ['family'],
    withPresence: true
});

We'll learn more about using PubNub Presence features in the Presence tutorial.

Lets assume that our son no longer wants to be part of the family chat app, because he is getting irritated with his sister's comments. To remove his channel from the group, we'd just call the following method:

// assuming an initialized PubNub instance already exists
pubnub.channelGroups.removeChannels(
    {
        channels: ['son'],
        channelGroup: "family"
    },
    function (status) {
		if (status.error) {
			console.log("operation failed w/ error:", status);
        } else {
            console.log("operation done!")
        }
    }
);

If he had permissions to remove his sister from the group, he probably would just do that instead, but if PAM was implemented, we could make it so that he only has permissions to either add or remove himself to the group, not add or remove others. We'll discuss PAM in more detail in the PAM, SSL, and AES256 Message Encryption tutorial.

To get a list of all the channels defined within a channel group, call the following method. In this example, we dump all the channels within rajat:family:

// assuming an initialized PubNub instance already exists
pubnub.channelGroups.listChannels(
    {
        channelGroup: "family"
    }, 
    function (status, response) {
    }
);
To remove a Channel Group by name, use the following method:
pubnub.channelGroups.deleteGroup(
    {
        channelGroup: "family"
    },
    function (status) {
        if (status.error) {
            console.log("operation failed w/ error:", status);
        } else {
            console.log("operation done!")
        }
    }
);