org.projectodd.sockjs

Class SockJsConnection

java.lang.Object

org.projectodd.sockjs.SockJsConnection

public class SockJsConnection
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SockJsConnection.OnCloseHandler
static interface	SockJsConnection.OnDataHandler

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,String>	headers Hash containing various headers copied from last request received on this connection.
String	id Unique identifier of this connection
String	pathname `pathname` from parsed url, for convenience.
String	prefix Prefix of the url on which the request was handled.
String	protocol Protocol used by the connection.
String	remoteAddress Last known IP address of the client.
int	remotePort Last known port number of the client.
String	url The entire url string copied from the last request.

Constructor Summary

Constructors

Constructor and Description
SockJsConnection(Session session)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	close() Ask the remote client to disconnect with default 'code' and 'reason' values
boolean	close(int code, String reason) Asks the remote client to disconnect with the given 'code' and 'reason' values
void	destroy()
void	emitClose()
void	emitData(String message)
void	end() Asks the remote client to disconnect with default 'code' and 'reason' values.
void	end(String message) Write a message and then ask the remote client to disconnect with default 'code' and 'reason' values.
Transport.READY_STATE	getReadyState() Current state of the connection
void	onClose(SockJsConnection.OnCloseHandler onCloseHandler) Called when a connection to a client is closed.
void	onData(SockJsConnection.OnDataHandler onDataHandler) Called for every message received from a client
String	toString()
boolean	write(String message, boolean async) Sends a message over the opened connection.

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

Unique identifier of this connection

remoteAddress

public String remoteAddress

Last known IP address of the client.

remotePort

public int remotePort

Last known port number of the client.

headers

public Map<String,String> headers

Hash containing various headers copied from last request received on this connection. Exposed headers include: `origin`, `referer` and `x-forwarded-for` (and friends), all lowercase. This explicitly does not grant access to the `cookie` header, as using it may easily lead to security issues (for details read the section "Authorisation" at https://github.com/sockjs/sockjs-node).

url

public String url

The entire url string copied from the last request.

pathname

public String pathname

`pathname` from parsed url, for convenience.

prefix

public String prefix

Prefix of the url on which the request was handled. For SockJsServlet, this is the servlet's context path

protocol

public String protocol

Protocol used by the connection. Keep in mind that some protocols are indistinguishable - for example "xhr-polling" and "xdr-polling".

Constructor Detail

SockJsConnection

public SockJsConnection(Session session)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

write

public boolean write(String message,
            boolean async)

Sends a message over the opened connection. A message must be a non-empty string. It's illegal to send a message after the connection was closed (either after 'close' or 'end' method or 'close' event).

Parameters:

message - the message to send

Returns:

true on success, false on failure

end

public void end()

Asks the remote client to disconnect with default 'code' and 'reason' values.

end

public void end(String message)

Write a message and then ask the remote client to disconnect with default 'code' and 'reason' values.

Parameters:

message - message to write

close

public boolean close()

Ask the remote client to disconnect with default 'code' and 'reason' values

Returns:

false if the connection was already closed, true otherwise

close

public boolean close(int code,
            String reason)

Asks the remote client to disconnect with the given 'code' and 'reason' values

Parameters:

code - The code, typically one of CloseReason.CloseCodes.getCode()

reason - A string describing the reason for closure

Returns:

false if the connection was already closed, true otherwise

destroy

public void destroy()

onData

public void onData(SockJsConnection.OnDataHandler onDataHandler)

Called for every message received from a client

Parameters:

onDataHandler - The handler to call when messages arrive

emitData

public void emitData(String message)

onClose

public void onClose(SockJsConnection.OnCloseHandler onCloseHandler)

Called when a connection to a client is closed. This is triggered exactly once for every connection.

Parameters:

onCloseHandler - The handler to call when a connection is closed

emitClose

public void emitClose()

getReadyState

public Transport.READY_STATE getReadyState()

Current state of the connection