org.atmosphere.socketio
Interface SocketIOOutbound

All Known Subinterfaces:

SocketIOSessionOutbound, SocketIOWebSocketSessionWrapper

All Known Implementing Classes:

JSONPPollingTransport.XHRPollingSessionHelper, WebSocketTransport.SocketIOWebSocketSessionWrapperImpl, XHRPollingTransport.XHRPollingSessionHelper, XHRTransport.XHRSessionHelper

public interface SocketIOOutbound

Author:

Sebastien Dionne : sebastien.dionne@gmail.com

Method Summary

void	close() force close connection
void	disconnect() disconnect the current connection
void	sendMessage(List<SocketIOPacketImpl> messages) Send messages to the client.
void	sendMessage(SocketIOPacket packet) Send a message to the client formatted is SocketIO format.
void	sendMessage(String message) Send a message to the client.

Method Detail

disconnect

void disconnect()

disconnect the current connection

close

void close()

force close connection

sendMessage

void sendMessage(String message)
                 throws SocketIOException

Send a message to the client. If the session is still active, the message will be cached if the connection is closed.

Parameters:

message - The message to send

Throws:

SocketIOException

sendMessage

void sendMessage(SocketIOPacket packet)
                 throws SocketIOException

Send a message to the client formatted is SocketIO format. If the session is still active, the message will be cached if the connection is closed.

Parameters:

packet - The message to send

Throws:

SocketIOException

sendMessage

void sendMessage(List<SocketIOPacketImpl> messages)
                 throws SocketIOException

Send messages to the client. If the session is still active, the messages will be cached if the connection is closed.

Parameters:

packet - The message to send

Throws:

SocketIOException