Fixed javadocs.

Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
This commit is contained in:
Simone Bordet 2023-03-28 20:22:39 +02:00
parent dde6e04731
commit fe11b94da8
No known key found for this signature in database
GPG Key ID: 1677D141BCF3584D
1 changed files with 12 additions and 12 deletions

View File

@ -23,54 +23,54 @@ public final class WebSocketConstants
public static final String SPEC_VERSION_STRING = Integer.toString(SPEC_VERSION);
/**
* Max Binary Message Size - The maximum size of a binary message which can be received.
* The default maximum size of a binary message that can be received.
*/
public static final int DEFAULT_MAX_BINARY_MESSAGE_SIZE = 64 * 1024;
/**
* Max Text Message Size - The maximum size of a text message which can be received.
* The default maximum size of a text message that can be received.
*/
public static final int DEFAULT_MAX_TEXT_MESSAGE_SIZE = 64 * 1024;
/**
* Max Frame Size - The maximum payload size of any WebSocket Frame which can be received.
* The default maximum payload size of any WebSocket frame that can be received.
*/
public static final int DEFAULT_MAX_FRAME_SIZE = 64 * 1024;
/**
* Output Buffer Size - The output (write to network layer) buffer size. This is the raw write operation buffer size and has no relationship to the websocket frame.
* The default input buffer size used to read from network/transport layer.
*/
public static final int DEFAULT_INPUT_BUFFER_SIZE = 4 * 1024;
/**
* Input Buffer Size - The input (read from network layer) buffer size. This is the raw read operation buffer size, before the parsing of the websocket frames.
* The default output buffer size used to write to the network/transport layer.
*/
public static final int DEFAULT_OUTPUT_BUFFER_SIZE = 4 * 1024;
/**
* Max Outgoing Frames - Set the maximum number of data frames allowed to be waiting to be sent at any one time.
* The default maximum number of data frames allowed to be waiting to be sent at any one time.
*/
public static final int DEFAULT_MAX_OUTGOING_FRAMES = -1;
/**
* Auto Fragment - If set to true, frames are automatically fragmented to respect the maximum frame size.
* Whether frames are automatically fragmented to respect the maximum frame size.
*/
public static final boolean DEFAULT_AUTO_FRAGMENT = true;
/**
* Idle Timeout - The duration that a websocket may be idle before being closed by the implementation.
* The default duration that a websocket connection may be idle before being closed by the implementation.
*/
public static final Duration DEFAULT_IDLE_TIMEOUT = Duration.ofSeconds(30);
/**
* Write Timeout - The maximum time a frame may be waiting to be sent.
* The default maximum time a frame may be waiting to be sent.
*/
public static final Duration DEFAULT_WRITE_TIMEOUT = Duration.ZERO;
/**
* Globally Unique Identifier for use in WebSocket handshake within {@code Sec-WebSocket-Accept} and <code>Sec-WebSocket-Key</code> http headers.
* <p>
* See <a href="https://tools.ietf.org/html/rfc6455#section-1.3">Opening Handshake (Section 1.3)</a>
* <p>Globally Unique Identifier for use in WebSocket handshake within {@code Sec-WebSocket-Accept}
* and <code>Sec-WebSocket-Key</code> HTTP headers.</p>
* <p>See <a href="https://tools.ietf.org/html/rfc6455#section-1.3">Opening Handshake (Section 1.3)</a>.</p>
*/
public static final byte[] MAGIC = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11".getBytes(StandardCharsets.ISO_8859_1);