org.phoenixframework.channels

Class Channel

java.lang.Object

org.phoenixframework.channels.Channel

public class Channel
extends java.lang.Object

Encapsulation of a Phoenix channel: a Socket, a topic and the channel's state.

Constructor Summary

Constructors

Constructor and Description
Channel(java.lang.String topic, com.fasterxml.jackson.databind.JsonNode payload, Socket socket)

Method Summary

Modifier and Type	Method and Description
Socket	getSocket()
java.lang.String	getTopic()
boolean	isMember(java.lang.String topic)
Push	join() Initiates a channel join event
Push	leave()
Channel	off(java.lang.String event) Unsubscribe for event notifications
Channel	on(java.lang.String event, IMessageCallback callback)
Push	push(java.lang.String event)
Push	push(java.lang.String event, com.fasterxml.jackson.databind.JsonNode payload)
void	scheduleRepeatingTask(java.util.TimerTask timerTask, long ms)
void	scheduleTask(java.util.TimerTask timerTask, long ms)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Channel

public Channel(java.lang.String topic,
               com.fasterxml.jackson.databind.JsonNode payload,
               Socket socket)

Method Detail

getSocket

public Socket getSocket()

getTopic

public java.lang.String getTopic()

isMember

public boolean isMember(java.lang.String topic)

join

public Push join()
          throws java.lang.IllegalStateException,
                 java.io.IOException

Initiates a channel join event

Returns:

This Push instance

Throws:

java.lang.IllegalStateException - Thrown if the channel has already been joined

java.io.IOException - Thrown if the join could not be sent

leave

public Push leave()
           throws java.io.IOException

Throws:

java.io.IOException

off

public Channel off(java.lang.String event)

Unsubscribe for event notifications

Parameters:

event - The event name

Returns:

The instance's self

on

public Channel on(java.lang.String event,
                  IMessageCallback callback)

Parameters:

event - The event name

callback - The callback to be invoked with the event's message

Returns:

The instance's self

push

public Push push(java.lang.String event,
                 com.fasterxml.jackson.databind.JsonNode payload)
          throws java.io.IOException

Throws:

java.io.IOException

push

public Push push(java.lang.String event)
          throws java.io.IOException

Throws:

java.io.IOException

scheduleRepeatingTask

public void scheduleRepeatingTask(java.util.TimerTask timerTask,
                                  long ms)

scheduleTask

public void scheduleTask(java.util.TimerTask timerTask,
                         long ms)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object