org.phoenixframework.channels

Class Socket

java.lang.Object

org.phoenixframework.channels.Socket

public class Socket
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Socket.PhoenixWSListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	RECONNECT_INTERVAL_MS

Constructor Summary

Constructors

Constructor and Description
Socket(java.lang.String endpointUri)
Socket(java.lang.String endpointUri, int heartbeatIntervalInMs)

Method Summary

Modifier and Type	Method and Description
Channel	chan(java.lang.String topic, com.fasterxml.jackson.databind.JsonNode payload) Retrieve a channel instance for the specified topic
void	connect()
void	disconnect()
boolean	isConnected()
Socket	onClose(ISocketCloseCallback callback) Register a callback for SocketEvent.ERROR events
Socket	onError(IErrorCallback callback) Register a callback for SocketEvent.ERROR events
Socket	onMessage(IMessageCallback callback) Register a callback for SocketEvent.MESSAGE events
Socket	onOpen(ISocketOpenCallback callback) Register a callback for SocketEvent.OPEN events
Socket	push(Envelope envelope) Sends a message envelope on this socket
void	reconectOnFailure(boolean reconnectOnFailure) Should the socket attempt to reconnect if websocket.onFailure is called.
void	remove(Channel channel) Removes the specified channel if it is known to the socket
void	removeAllChannels()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RECONNECT_INTERVAL_MS

public static final int RECONNECT_INTERVAL_MS

See Also:

Constant Field Values

Constructor Detail

Socket

public Socket(java.lang.String endpointUri)
       throws java.io.IOException

Throws:

java.io.IOException

Socket

public Socket(java.lang.String endpointUri,
              int heartbeatIntervalInMs)

Method Detail

chan

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

Retrieve a channel instance for the specified topic

Parameters:

topic - The channel topic

payload - The message payload

Returns:

A Channel instance to be used for sending and receiving events for the topic

connect

public void connect()
             throws java.io.IOException

Throws:

java.io.IOException

disconnect

public void disconnect()
                throws java.io.IOException

Throws:

java.io.IOException

isConnected

public boolean isConnected()

Returns:

true if the socket connection is connected

onClose

public Socket onClose(ISocketCloseCallback callback)

Register a callback for SocketEvent.ERROR events

Parameters:

callback - The callback to receive CLOSE events

Returns:

This Socket instance

onError

public Socket onError(IErrorCallback callback)

Register a callback for SocketEvent.ERROR events

Parameters:

callback - The callback to receive ERROR events

Returns:

This Socket instance

onMessage

public Socket onMessage(IMessageCallback callback)

Register a callback for SocketEvent.MESSAGE events

Parameters:

callback - The callback to receive MESSAGE events

Returns:

This Socket instance

onOpen

public Socket onOpen(ISocketOpenCallback callback)

Register a callback for SocketEvent.OPEN events

Parameters:

callback - The callback to receive OPEN events

Returns:

This Socket instance

push

public Socket push(Envelope envelope)
            throws java.io.IOException

Sends a message envelope on this socket

Parameters:

envelope - The message envelope

Returns:

This socket instance

Throws:

java.io.IOException - Thrown if the message cannot be sent

reconectOnFailure

public void reconectOnFailure(boolean reconnectOnFailure)

Should the socket attempt to reconnect if websocket.onFailure is called.

Parameters:

reconnectOnFailure - reconnect value

remove

public void remove(Channel channel)

Removes the specified channel if it is known to the socket

Parameters:

channel - The channel to be removed

removeAllChannels

public void removeAllChannels()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object