WebSocketPolicy

Constructors

this

this(WebSocketBehavior behavior)

Undocumented in source.

Members

Functions

assertValidBinaryMessageSize

void assertValidBinaryMessageSize(int requestedSize)

Undocumented in source. Be warned that the author may not have intended to support it.

assertValidTextMessageSize

void assertValidTextMessageSize(int requestedSize)

Undocumented in source. Be warned that the author may not have intended to support it.

clonePolicy

WebSocketPolicy clonePolicy()

Undocumented in source. Be warned that the author may not have intended to support it.

getAsyncWriteTimeout

long getAsyncWriteTimeout()

The timeout in ms (milliseconds) for async write operations. <p> Negative values indicate a disabled timeout.

getBehavior

WebSocketBehavior getBehavior()

Undocumented in source. Be warned that the author may not have intended to support it.

getIdleTimeout

long getIdleTimeout()

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

getInputBufferSize

int getInputBufferSize()

The size of the input (read from network layer) buffer size. <p> This is the raw read operation buffer size, before the parsing of the websocket frames.

getMaxBinaryMessageBufferSize

int getMaxBinaryMessageBufferSize()

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

getMaxBinaryMessageSize

int getMaxBinaryMessageSize()

Get the maximum size of a binary message during parsing. <p> This is a memory conservation option, memory over this limit will not be allocated by Hunt for handling binary messages. This applies to individual frames, whole message handling, and partial message handling. </p> <p> Binary messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE} </p>

getMaxTextMessageBufferSize

int getMaxTextMessageBufferSize()

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

getMaxTextMessageSize

int getMaxTextMessageSize()

Get the maximum size of a text message during parsing. <p> This is a memory conservation option, memory over this limit will not be allocated by Hunt for handling text messages. This applies to individual frames, whole message handling, and partial message handling. </p> <p> Text messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE} </p>

setAsyncWriteTimeout

void setAsyncWriteTimeout(long ms)

The timeout in ms (milliseconds) for async write operations. <p> Negative values indicate a disabled timeout.

setIdleTimeout

void setIdleTimeout(long ms)

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

setInputBufferSize

void setInputBufferSize(int size)

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

setMaxBinaryMessageBufferSize

void setMaxBinaryMessageBufferSize(int size)

The maximum size of a binary message buffer. <p> Used ONLY for stream based binary message writing.

setMaxBinaryMessageSize

void setMaxBinaryMessageSize(int size)

The maximum size of a binary message during parsing. <p> This is a memory conservation option, memory over this limit will not be allocated by Hunt for handling binary messages. This applies to individual frames, whole message handling, and partial message handling. </p> <p> Binary messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE} </p>

setMaxTextMessageBufferSize

void setMaxTextMessageBufferSize(int size)

The maximum size of a text message buffer. <p> Used ONLY for stream based text message writing.

setMaxTextMessageSize

void setMaxTextMessageSize(int size)

The maximum size of a text message during parsing. <p> This is a memory conservation option, memory over this limit will not be allocated by Hunt for handling text messages. This applies to individual frames, whole message handling, and partial message handling. </p> <p> Text messages over this maximum will result in a close code 1009 {@link StatusCode#MESSAGE_TOO_LARGE} </p>

toString

string toString()

Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

newClientPolicy

WebSocketPolicy newClientPolicy()

Undocumented in source. Be warned that the author may not have intended to support it.

newServerPolicy

WebSocketPolicy newServerPolicy()

Undocumented in source. Be warned that the author may not have intended to support it.

• WebSocketPolicy