org.eclipse.jetty.websocket.api

Class WebSocketPolicy

java.lang.Object

org.eclipse.jetty.websocket.api.WebSocketPolicy

public class WebSocketPolicy
extends Object

Settings for WebSocket operations.

Constructor Summary

Constructors

Constructor and Description
WebSocketPolicy(WebSocketBehavior behavior)

Method Summary

Methods

Modifier and Type	Method and Description
void	assertValidBinaryMessageSize(int requestedSize)
void	assertValidTextMessageSize(int requestedSize)
WebSocketPolicy	clonePolicy()
long	getAsyncWriteTimeout() The timeout in ms (milliseconds) for async write operations.
WebSocketBehavior	getBehavior()
long	getIdleTimeout() The time in ms (milliseconds) that a websocket connection mad by idle before being closed automatically.
int	getInputBufferSize() The size of the input (read from network layer) buffer size.
int	getMaxBinaryMessageBufferSize() Get the maximum size of a binary message buffer (for streaming writing)
int	getMaxBinaryMessageSize() Get the maximum size of a binary message during parsing/generating.
int	getMaxTextMessageBufferSize() Get the maximum size of a text message buffer (for streaming writing)
int	getMaxTextMessageSize() Get the maximum size of a text message during parsing/generating.
static WebSocketPolicy	newClientPolicy()
static WebSocketPolicy	newServerPolicy()
void	setAsyncWriteTimeout(long ms) The timeout in ms (milliseconds) for async write operations.
void	setIdleTimeout(long ms) The time in ms (milliseconds) that a websocket may be idle before closing.
void	setInputBufferSize(int size) The size of the input (read from network layer) buffer size.
void	setMaxBinaryMessageBufferSize(int size) The maximum size of a binary message buffer.
void	setMaxBinaryMessageSize(int size) The maximum size of a binary message during parsing/generating.
void	setMaxTextMessageBufferSize(int size) The maximum size of a text message buffer.
void	setMaxTextMessageSize(int size) The maximum size of a text message during parsing/generating.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketPolicy

public WebSocketPolicy(WebSocketBehavior behavior)

Method Detail

newClientPolicy

public static WebSocketPolicy newClientPolicy()

newServerPolicy

public static WebSocketPolicy newServerPolicy()

assertValidBinaryMessageSize

public void assertValidBinaryMessageSize(int requestedSize)

assertValidTextMessageSize

public void assertValidTextMessageSize(int requestedSize)

clonePolicy

public WebSocketPolicy clonePolicy()

getAsyncWriteTimeout

public long getAsyncWriteTimeout()

The timeout in ms (milliseconds) for async write operations.

Negative values indicate a disabled timeout.

Returns:

the timeout for async write operations. negative values indicate disabled timeout.

getBehavior

public WebSocketBehavior getBehavior()

getIdleTimeout

public long getIdleTimeout()

The time in ms (milliseconds) that a websocket connection mad by idle before being closed automatically.

Returns:

the timeout in milliseconds for idle timeout.

getInputBufferSize

public int getInputBufferSize()

The size of the input (read from network layer) buffer size.

This is the raw read operation buffer size, before the parsing of the websocket frames.

Returns:

the raw network bytes read operation buffer size.

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

Get the maximum size of a binary message buffer (for streaming writing)

Returns:

the maximum size of a binary message buffer

getMaxBinaryMessageSize

public int getMaxBinaryMessageSize()

Get the maximum size of a binary message during parsing/generating.

Binary messages over this maximum will result in a close code 1009 StatusCode.MESSAGE_TOO_LARGE

Returns:

the maximum size of a binary message

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

Get the maximum size of a text message buffer (for streaming writing)

Returns:

the maximum size of a text message buffer

getMaxTextMessageSize

public int getMaxTextMessageSize()

Get the maximum size of a text message during parsing/generating.

Text messages over this maximum will result in a close code 1009 StatusCode.MESSAGE_TOO_LARGE

Returns:

the maximum size of a text message.

setAsyncWriteTimeout

public void setAsyncWriteTimeout(long ms)

The timeout in ms (milliseconds) for async write operations.

Negative values indicate a disabled timeout.

Parameters:

ms - the timeout in milliseconds

setIdleTimeout

public void setIdleTimeout(long ms)

The time in ms (milliseconds) that a websocket may be idle before closing.

Parameters:

ms - the timeout in milliseconds

setInputBufferSize

public void setInputBufferSize(int size)

The size of the input (read from network layer) buffer size.

Parameters:

size - the size in bytes

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int size)

The maximum size of a binary message buffer.

Used ONLY for stream based message writing.

Parameters:

size - the maximum size of the binary message buffer

setMaxBinaryMessageSize

public void setMaxBinaryMessageSize(int size)

The maximum size of a binary message during parsing/generating.

Binary messages over this maximum will result in a close code 1009 StatusCode.MESSAGE_TOO_LARGE

Parameters:

size - the maximum allowed size of a binary message.

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int size)

The maximum size of a text message buffer.

Used ONLY for stream based message writing.

Parameters:

size - the maximum size of the text message buffer

setMaxTextMessageSize

public void setMaxTextMessageSize(int size)

The maximum size of a text message during parsing/generating.

Text messages over this maximum will result in a close code 1009 StatusCode.MESSAGE_TOO_LARGE

Parameters:

size - the maximum allowed size of a text message.

toString

public String toString()

Overrides:

toString in class Object