Package org.eclipse.jetty.websocket.core

Class Configuration.ConfigurationCustomizer

java.lang.Object

org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer

All Implemented Interfaces:

Configuration, Configuration.Customizer

Direct Known Subclasses:

CoreSession.Empty, JettyWebSocketFrameHandlerMetadata, WebSocketNegotiator.AbstractNegotiator

Enclosing interface:

Configuration

public static class Configuration.ConfigurationCustomizer
extends Object
implements Configuration, Configuration.Customizer

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.websocket.core.Configuration

Configuration.ConfigurationCustomizer, Configuration.Customizer

Constructor Summary

Constructors

Constructor	Description
ConfigurationCustomizer()

Method Summary

Modifier and Type	Method	Description
void	customize(Configuration configurable)
Duration	getIdleTimeout()	Get the Idle Timeout
int	getInputBufferSize()
long	getMaxBinaryMessageSize()
long	getMaxFrameSize()
int	getMaxOutgoingFrames()	Get the maximum number of data frames allowed to be waiting to be sent at any one time.
long	getMaxTextMessageSize()
int	getOutputBufferSize()
Duration	getWriteTimeout()	Get the Write Timeout
boolean	isAutoFragment()
void	setAutoFragment(boolean autoFragment)
void	setIdleTimeout(Duration timeout)	Set the Idle Timeout.
void	setInputBufferSize(int inputBufferSize)
void	setMaxBinaryMessageSize(long maxBinaryMessageSize)
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 maxTextMessageSize)
void	setOutputBufferSize(int outputBufferSize)
void	setWriteTimeout(Duration timeout)	Set the Write Timeout.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationCustomizer

public ConfigurationCustomizer()

Method Details

getIdleTimeout

public Duration getIdleTimeout()

Description copied from interface: Configuration

Get the Idle Timeout

Specified by:

getIdleTimeout in interface Configuration

Returns:

the idle timeout

getWriteTimeout

public Duration getWriteTimeout()

Description copied from interface: Configuration

Get the Write Timeout

Specified by:

getWriteTimeout in interface Configuration

Returns:

the write timeout

setIdleTimeout

public void setIdleTimeout(Duration timeout)

Description copied from interface: Configuration

Set the Idle Timeout.

Specified by:

setIdleTimeout in interface Configuration

Parameters:

timeout - the timeout duration (timeout <= 0 implies an infinite timeout)

setWriteTimeout

public void setWriteTimeout(Duration timeout)

Description copied from interface: Configuration

Set the Write Timeout.

Specified by:

setWriteTimeout in interface Configuration

Parameters:

timeout - the timeout duration (timeout <= 0 implies an infinite timeout)

isAutoFragment

public boolean isAutoFragment()

Specified by:

isAutoFragment in interface Configuration

setAutoFragment

public void setAutoFragment(boolean autoFragment)

Specified by:

setAutoFragment in interface Configuration

getMaxFrameSize

public long getMaxFrameSize()

Specified by:

getMaxFrameSize in interface Configuration

setMaxFrameSize

public void setMaxFrameSize(long maxFrameSize)

Specified by:

setMaxFrameSize in interface Configuration

getOutputBufferSize

public int getOutputBufferSize()

Specified by:

getOutputBufferSize in interface Configuration

setOutputBufferSize

public void setOutputBufferSize(int outputBufferSize)

Specified by:

setOutputBufferSize in interface Configuration

getInputBufferSize

public int getInputBufferSize()

Specified by:

getInputBufferSize in interface Configuration

setInputBufferSize

public void setInputBufferSize(int inputBufferSize)

Specified by:

setInputBufferSize in interface Configuration

getMaxBinaryMessageSize

public long getMaxBinaryMessageSize()

Specified by:

getMaxBinaryMessageSize in interface Configuration

setMaxBinaryMessageSize

public void setMaxBinaryMessageSize(long maxBinaryMessageSize)

Specified by:

setMaxBinaryMessageSize in interface Configuration

getMaxTextMessageSize

public long getMaxTextMessageSize()

Specified by:

getMaxTextMessageSize in interface Configuration

setMaxTextMessageSize

public void setMaxTextMessageSize(long maxTextMessageSize)

Specified by:

setMaxTextMessageSize in interface Configuration

getMaxOutgoingFrames

public int getMaxOutgoingFrames()

Description copied from interface: Configuration

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 a WritePendingException but the connection is not failed and will remain open.

Specified by:

getMaxOutgoingFrames in interface Configuration

Returns:

the max number of frames.

setMaxOutgoingFrames

public void setMaxOutgoingFrames(int maxOutgoingFrames)

Description copied from interface: Configuration

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 a WritePendingException but the connection is not failed and will remain open.

Specified by:

setMaxOutgoingFrames in interface Configuration

Parameters:

maxOutgoingFrames - the max number of frames.

customize

public void customize(Configuration configurable)

Specified by:

customize in interface Configuration.Customizer

toString

public String toString()

Overrides:

toString in class Object