Top Inners Methods
org.eclipse.jetty.websocket.core

public Interface Configuration

Known Direct Subinterfaces
org.eclipse.jetty.websocket.core.CoreSession
Known Direct Implementers
org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer
Imports
java.time.Duration

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Configuration.ConfigurationCustomizer

public static interface
Configuration.Customizer

Method Summary

Modifier and TypeMethod and Description
public Duration

Returns:

the idle timeout
getIdleTimeout()

Get the Idle Timeout

public int
getInputBufferSize()

public long
getMaxBinaryMessageSize()

public long
getMaxFrameSize()

public int

Returns:

the max number of frames.
getMaxOutgoingFrames()

Get the maximum number of data frames allowed to be waiting to be sent at any one time.

public long
getMaxTextMessageSize()

public int
getOutputBufferSize()

public Duration

Returns:

the write timeout
getWriteTimeout()

Get the Write Timeout

public boolean
isAutoFragment()

public void
setAutoFragment(boolean autoFragment)

public void
setIdleTimeout(Duration
the timeout duration (timeout <= 0 implies an infinite timeout)
timeout)

Set the Idle Timeout.

public void
setInputBufferSize(int inputBufferSize)

public void
setMaxBinaryMessageSize(long maxSize)

public void
setMaxFrameSize(long maxFrameSize)

public void
setMaxOutgoingFrames(int
the max number of frames.
maxOutgoingFrames)

Set the maximum number of data frames allowed to be waiting to be sent at any one time.

public void
setMaxTextMessageSize(long maxSize)

public void
setOutputBufferSize(int outputBufferSize)

public void
setWriteTimeout(Duration
the timeout duration (timeout <= 0 implies an infinite timeout)
timeout)

Set the Write Timeout.

Method Detail

getIdleTimeoutback to summary
public Duration getIdleTimeout()

Get the Idle Timeout

Returns:Duration

the idle timeout

getInputBufferSizeback to summary
public int getInputBufferSize()
getMaxBinaryMessageSizeback to summary
public long getMaxBinaryMessageSize()
getMaxFrameSizeback to summary
public long getMaxFrameSize()
getMaxOutgoingFramesback to summary
public 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 a java.nio.channels.WritePendingException but the connection is not failed and will remain open.

Returns:int

the max number of frames.

getMaxTextMessageSizeback to summary
public long getMaxTextMessageSize()
getOutputBufferSizeback to summary
public int getOutputBufferSize()
getWriteTimeoutback to summary
public Duration getWriteTimeout()

Get the Write Timeout

Returns:Duration

the write timeout

isAutoFragmentback to summary
public boolean isAutoFragment()
setAutoFragmentback to summary
public void setAutoFragment(boolean autoFragment)
setIdleTimeoutback to summary
public void setIdleTimeout(Duration timeout)

Set the Idle Timeout.

Parameters
timeout:Duration

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

setInputBufferSizeback to summary
public void setInputBufferSize(int inputBufferSize)
setMaxBinaryMessageSizeback to summary
public void setMaxBinaryMessageSize(long maxSize)
setMaxFrameSizeback to summary
public void setMaxFrameSize(long maxFrameSize)
setMaxOutgoingFramesback to summary
public 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 a java.nio.channels.WritePendingException but the connection is not failed and will remain open.

Parameters
maxOutgoingFrames:int

the max number of frames.

setMaxTextMessageSizeback to summary
public void setMaxTextMessageSize(long maxSize)
setOutputBufferSizeback to summary
public void setOutputBufferSize(int outputBufferSize)
setWriteTimeoutback to summary
public void setWriteTimeout(Duration timeout)

Set the Write Timeout.

Parameters
timeout:Duration

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

org.eclipse.jetty.websocket.core back to summary

public Class Configuration.ConfigurationCustomizer

extends Object
implements Configuration, Customizer
Class Inheritance
  • java.lang.Object
  • org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer
All Implemented Interfaces
org.eclipse.jetty.websocket.core.Configuration.Customizer, org.eclipse.jetty.websocket.core.Configuration
Known Direct Subclasses
org.eclipse.jetty.websocket.core.CoreSession.Empty

Field Summary

Modifier and TypeField and Description
private Boolean
autoFragment

private Duration
idleTimeout

private Integer
inputBufferSize

private Long
maxBinaryMessageSize

private Long
maxFrameSize

private Integer
maxOutgoingFrames

private Long
maxTextMessageSize

private Integer
outputBufferSize

private Duration
writeTimeout

Constructor Summary

AccessConstructor and Description
public
ConfigurationCustomizer()

Method Summary

Modifier and TypeMethod and Description
public void
customize(Configuration configurable)

Implements org.eclipse.jetty.websocket.core.Configuration.Customizer.customize.

public Duration
getIdleTimeout()

Implements org.eclipse.jetty.websocket.core.Configuration.getIdleTimeout.

Get the Idle Timeout

public int
getInputBufferSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getInputBufferSize.

public long
getMaxBinaryMessageSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getMaxBinaryMessageSize.

public long
getMaxFrameSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getMaxFrameSize.

public int
getMaxOutgoingFrames()

Implements org.eclipse.jetty.websocket.core.Configuration.getMaxOutgoingFrames.

Get the maximum number of data frames allowed to be waiting to be sent at any one time.

public long
getMaxTextMessageSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getMaxTextMessageSize.

public int
getOutputBufferSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getOutputBufferSize.

public Duration
getWriteTimeout()

Implements org.eclipse.jetty.websocket.core.Configuration.getWriteTimeout.

Get the Write Timeout

public boolean
isAutoFragment()

Implements org.eclipse.jetty.websocket.core.Configuration.isAutoFragment.

public void
setAutoFragment(boolean autoFragment)

Implements org.eclipse.jetty.websocket.core.Configuration.setAutoFragment.

public void
setIdleTimeout(Duration
the timeout duration (timeout <= 0 implies an infinite timeout)
timeout)

Implements org.eclipse.jetty.websocket.core.Configuration.setIdleTimeout.

Set the Idle Timeout.

public void
setInputBufferSize(int inputBufferSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setInputBufferSize.

public void
setMaxBinaryMessageSize(long maxBinaryMessageSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setMaxBinaryMessageSize.

public void
setMaxFrameSize(long maxFrameSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setMaxFrameSize.

public void
setMaxOutgoingFrames(int
the max number of frames.
maxOutgoingFrames)

Implements org.eclipse.jetty.websocket.core.Configuration.setMaxOutgoingFrames.

Set the maximum number of data frames allowed to be waiting to be sent at any one time.

public void
setMaxTextMessageSize(long maxTextMessageSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setMaxTextMessageSize.

public void
setOutputBufferSize(int outputBufferSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setOutputBufferSize.

public void
setWriteTimeout(Duration
the timeout duration (timeout <= 0 implies an infinite timeout)
timeout)

Implements org.eclipse.jetty.websocket.core.Configuration.setWriteTimeout.

Set the Write Timeout.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

autoFragmentback to summary
private Boolean autoFragment
idleTimeoutback to summary
private Duration idleTimeout
inputBufferSizeback to summary
private Integer inputBufferSize
maxBinaryMessageSizeback to summary
private Long maxBinaryMessageSize
maxFrameSizeback to summary
private Long maxFrameSize
maxOutgoingFramesback to summary
private Integer maxOutgoingFrames
maxTextMessageSizeback to summary
private Long maxTextMessageSize
outputBufferSizeback to summary
private Integer outputBufferSize
writeTimeoutback to summary
private Duration writeTimeout

Constructor Detail

ConfigurationCustomizerback to summary
public ConfigurationCustomizer()

Method Detail

customizeback to summary
public void customize(Configuration configurable)

Implements org.eclipse.jetty.websocket.core.Configuration.Customizer.customize.

Annotations
@Override
getIdleTimeoutback to summary
public Duration getIdleTimeout()

Implements org.eclipse.jetty.websocket.core.Configuration.getIdleTimeout.

Doc from org.eclipse.jetty.websocket.core.Configuration.getIdleTimeout.

Get the Idle Timeout

Returns:Duration

the idle timeout

Annotations
@Override
getInputBufferSizeback to summary
public int getInputBufferSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getInputBufferSize.

Annotations
@Override
getMaxBinaryMessageSizeback to summary
public long getMaxBinaryMessageSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getMaxBinaryMessageSize.

Annotations
@Override
getMaxFrameSizeback to summary
public long getMaxFrameSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getMaxFrameSize.

Annotations
@Override
getMaxOutgoingFramesback to summary
public int getMaxOutgoingFrames()

Implements org.eclipse.jetty.websocket.core.Configuration.getMaxOutgoingFrames.

Doc from org.eclipse.jetty.websocket.core.Configuration.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 a java.nio.channels.WritePendingException but the connection is not failed and will remain open.

Returns:int

the max number of frames.

Annotations
@Override
getMaxTextMessageSizeback to summary
public long getMaxTextMessageSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getMaxTextMessageSize.

Annotations
@Override
getOutputBufferSizeback to summary
public int getOutputBufferSize()

Implements org.eclipse.jetty.websocket.core.Configuration.getOutputBufferSize.

Annotations
@Override
getWriteTimeoutback to summary
public Duration getWriteTimeout()

Implements org.eclipse.jetty.websocket.core.Configuration.getWriteTimeout.

Doc from org.eclipse.jetty.websocket.core.Configuration.getWriteTimeout.

Get the Write Timeout

Returns:Duration

the write timeout

Annotations
@Override
isAutoFragmentback to summary
public boolean isAutoFragment()

Implements org.eclipse.jetty.websocket.core.Configuration.isAutoFragment.

Annotations
@Override
setAutoFragmentback to summary
public void setAutoFragment(boolean autoFragment)

Implements org.eclipse.jetty.websocket.core.Configuration.setAutoFragment.

Annotations
@Override
setIdleTimeoutback to summary
public void setIdleTimeout(Duration timeout)

Implements org.eclipse.jetty.websocket.core.Configuration.setIdleTimeout.

Doc from org.eclipse.jetty.websocket.core.Configuration.setIdleTimeout.

Set the Idle Timeout.

Parameters
timeout:Duration

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

Annotations
@Override
setInputBufferSizeback to summary
public void setInputBufferSize(int inputBufferSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setInputBufferSize.

Annotations
@Override
setMaxBinaryMessageSizeback to summary
public void setMaxBinaryMessageSize(long maxBinaryMessageSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setMaxBinaryMessageSize.

Annotations
@Override
setMaxFrameSizeback to summary
public void setMaxFrameSize(long maxFrameSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setMaxFrameSize.

Annotations
@Override
setMaxOutgoingFramesback to summary
public void setMaxOutgoingFrames(int maxOutgoingFrames)

Implements org.eclipse.jetty.websocket.core.Configuration.setMaxOutgoingFrames.

Doc from org.eclipse.jetty.websocket.core.Configuration.setMaxOutgoingFrames.

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

Parameters
maxOutgoingFrames:int

the max number of frames.

Annotations
@Override
setMaxTextMessageSizeback to summary
public void setMaxTextMessageSize(long maxTextMessageSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setMaxTextMessageSize.

Annotations
@Override
setOutputBufferSizeback to summary
public void setOutputBufferSize(int outputBufferSize)

Implements org.eclipse.jetty.websocket.core.Configuration.setOutputBufferSize.

Annotations
@Override
setWriteTimeoutback to summary
public void setWriteTimeout(Duration timeout)

Implements org.eclipse.jetty.websocket.core.Configuration.setWriteTimeout.

Doc from org.eclipse.jetty.websocket.core.Configuration.setWriteTimeout.

Set the Write Timeout.

Parameters
timeout:Duration

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

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.eclipse.jetty.websocket.core back to summary

public Interface Configuration.Customizer

Known Direct Implementers
org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer

Method Summary

Modifier and TypeMethod and Description
public void
customize(Configuration configurable)

Method Detail

customizeback to summary
public void customize(Configuration configurable)