API - SCChannel (Server)

Instances of the SCChannel object let you subscribe to and watch for incoming data which is published on that channel by other clients or publishers. This object is the server-side equivalent to the client-side SCChannel object.

Inherits from:

Emitter

Properties:

name	The channel's name. Must be a string.
state	Holds a string which indicates the state of this channel. Can be 'subscribed', 'unsubscribed' or 'pending'.
waitForAuth	A boolean which indicates whether or not this channel will wait for socket authentication before subscribing to the server. It will remain in the 'pending' state until the socket becomes authenticated.
SUBSCRIBED	A string constant which is used to indicate that this channel is in a subscribed state. See getState() method.
PENDING	A string constant which is used to indicate that this channel is in a pending state. See getState() method.
UNSUBSCRIBED	A string constant which is used to indicate that this channel is in an unsubscribed state. See getState() method.

Events:

'dropOut'	This is emitted whenever the subscription to this channel is lost.
'subscribe'	When the subscription succeeds.
'subscribeFail'	Happens when the subscription fails.
'unsubscribe'	When the channel becomes deactivated (unsubscribed from the server).
'subscribeStateChange'	Whenever the channel's subscription state changes. The handler received an object with three properties: channel, oldState and newState.

Methods:

getState()	Returns the state of the channel as a string. Can be channel.SUBSCRIBED, channel.PENDING or channel.UNSUBSCRIBED.
subscribe()	Activate this channel so that it will receive all data published to it from the backend.
unsubscribe()	Deactivate this channel.
isSubscribed([includePending])	Check whether or not this channel is active (subscribed to the backend). The includePending argument is optional, if true, the function will return true if the channel subscription is in a pending state.
publish(data, [callback])	Publish data to this channel. The optional callback is in the form callback(err).
watch(handler)	Capture any data which is published to this channel. The handler is a function in the form handler(data).
unwatch([handler])	Unbind the specified handler from this channel. If no handler is specified, it will unbind all handlers.
watchers()	Get a list of functions which are currently observing this channel.
destroy()	Destroy the current SCChannel object - This makes it unusable and it will allow it to be garbage collected.