Package org.eclipse.jetty.websocket.core
Interface Configuration
- All Known Subinterfaces:
CoreSession
- All Known Implementing Classes:
Configuration.ConfigurationCustomizer
,CoreSession.Empty
,CreatorNegotiator
,JettyWebSocketFrameHandlerMetadata
,WebSocketCoreSession
,WebSocketNegotiator.AbstractNegotiator
public interface Configuration
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
static interface
-
Method Summary
Modifier and TypeMethodDescriptionGet the Idle Timeoutint
long
long
int
Get the maximum number of data frames allowed to be waiting to be sent at any one time.long
int
Get the Write Timeoutboolean
void
setAutoFragment
(boolean autoFragment) void
setIdleTimeout
(Duration timeout) Set the Idle Timeout.void
setInputBufferSize
(int inputBufferSize) void
setMaxBinaryMessageSize
(long maxSize) void
setMaxFrameSize
(long maxFrameSize) void
setMaxOutgoingFrames
(int maxOutgoingFrames) Set the maximum number of data frames allowed to be waiting to be sent at any one time.void
setMaxTextMessageSize
(long maxSize) void
setOutputBufferSize
(int outputBufferSize) void
setWriteTimeout
(Duration timeout) Set the Write Timeout.
-
Method Details
-
getIdleTimeout
Duration getIdleTimeout()Get the Idle Timeout- Returns:
- the idle timeout
-
getWriteTimeout
Duration getWriteTimeout()Get the Write Timeout- Returns:
- the write timeout
-
setIdleTimeout
Set the Idle Timeout.- Parameters:
timeout
- the timeout duration (timeout <= 0 implies an infinite timeout)
-
setWriteTimeout
Set the Write Timeout.- Parameters:
timeout
- the timeout duration (timeout <= 0 implies an infinite timeout)
-
isAutoFragment
boolean isAutoFragment() -
setAutoFragment
void setAutoFragment(boolean autoFragment) -
getMaxFrameSize
long getMaxFrameSize() -
setMaxFrameSize
void setMaxFrameSize(long maxFrameSize) -
getOutputBufferSize
int getOutputBufferSize() -
setOutputBufferSize
void setOutputBufferSize(int outputBufferSize) -
getInputBufferSize
int getInputBufferSize() -
setInputBufferSize
void setInputBufferSize(int inputBufferSize) -
getMaxBinaryMessageSize
long getMaxBinaryMessageSize() -
setMaxBinaryMessageSize
void setMaxBinaryMessageSize(long maxSize) -
getMaxTextMessageSize
long getMaxTextMessageSize() -
setMaxTextMessageSize
void setMaxTextMessageSize(long maxSize) -
getMaxOutgoingFrames
int getMaxOutgoingFrames()Get the maximum number of data frames allowed to be waiting to be sent at any one time. The default value is -1, this indicates there is no limit on how many frames can be queued to be sent by the implementation. If the limit is exceeded, subsequent frames sent are failed with aWritePendingException
but the connection is not failed and will remain open.- Returns:
- the max number of frames.
-
setMaxOutgoingFrames
void setMaxOutgoingFrames(int maxOutgoingFrames) Set the maximum number of data frames allowed to be waiting to be sent at any one time. The default value is -1, this indicates there is no limit on how many frames can be queued to be sent by the implementation. If the limit is exceeded, subsequent frames sent are failed with aWritePendingException
but the connection is not failed and will remain open.- Parameters:
maxOutgoingFrames
- the max number of frames.
-