org.eclipse.jetty.websocket.api

Interface Session

All Known Implementing Classes:

WebSocketSession

public interface Session

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the current conversation with a normal status code and no reason phrase.
void	close(CloseStatus closeStatus) Close the current conversation, giving a reason for the closure.
long	getIdleTimeout() Return the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received in that time.
long	getMaximumMessageSize() The maximum total length of messages, text or binary, that this Session can handle.
String	getProtocolVersion() Returns the version of the websocket protocol currently being used.
RemoteEndpoint	getRemote() Return a reference to the RemoteEndpoint object representing the other end of this conversation.
UpgradeRequest	getUpgradeRequest() Get the UpgradeRequest used to create this session
UpgradeResponse	getUpgradeResponse() Get the UpgradeResponse used to create this session
boolean	isOpen() Return true if and only if the underlying socket is open.
boolean	isSecure() Return true if and only if the underlying socket is using a secure transport.
void	setIdleTimeout(long ms) Set the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received.
void	setMaximumMessageSize(long length) Sets the maximum total length of messages, text or binary, that this Session can handle.

Method Detail

close

void close()
           throws IOException

Close the current conversation with a normal status code and no reason phrase.

Throws:

IOException

close

void close(CloseStatus closeStatus)
           throws IOException

Close the current conversation, giving a reason for the closure. Note the websocket spec defines the acceptable uses of status codes and reason phrases.

Parameters:

closeStatus - the reason for the closure

Throws:

IOException

getIdleTimeout

long getIdleTimeout()

Return the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received in that time.

Returns:

the timeout in milliseconds.

getMaximumMessageSize

long getMaximumMessageSize()

The maximum total length of messages, text or binary, that this Session can handle.

Returns:

the message size

getProtocolVersion

String getProtocolVersion()

Returns the version of the websocket protocol currently being used. This is taken as the value of the Sec-WebSocket-Version header used in the opening handshake. i.e. "13".

Returns:

the protocol version

getRemote

RemoteEndpoint getRemote()

Return a reference to the RemoteEndpoint object representing the other end of this conversation.

Returns:

the remote endpoint

getUpgradeRequest

UpgradeRequest getUpgradeRequest()

Get the UpgradeRequest used to create this session

Returns:

the UpgradeRequest used to create this session

getUpgradeResponse

UpgradeResponse getUpgradeResponse()

Get the UpgradeResponse used to create this session

Returns:

the UpgradeResponse used to create this session

isOpen

boolean isOpen()

Return true if and only if the underlying socket is open.

Returns:

whether the session is open

isSecure

boolean isSecure()

Return true if and only if the underlying socket is using a secure transport.

Returns:

whether its using a secure transport

setIdleTimeout

void setIdleTimeout(long ms)

Set the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received.

Parameters:

ms - the number of milliseconds.

setMaximumMessageSize

void setMaximumMessageSize(long length)

Sets the maximum total length of messages, text or binary, that this Session can handle.