Package org.glassfish.tyrus.core

Class TyrusWebSocketEngine.TyrusWebSocketEngineBuilder

java.lang.Object

org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder

Enclosing class:

TyrusWebSocketEngine

public static class TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
extends Object

TyrusWebSocketEngine builder.

Method Summary

Modifier and Type	Method	Description
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	applicationEventListener(ApplicationEventListener applicationEventListener)	Set ApplicationEventListener.
TyrusWebSocketEngine	build()	Create new TyrusWebSocketEngine instance with current set of parameters.
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	clusterContext(ClusterContext clusterContext)	Set ClusterContext.
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	incomingBufferSize(Integer incomingBufferSize)	Set incoming buffer size.
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	maxSessionsPerApp(Integer maxSessionsPerApp)	Set maximal number of open sessions per server application.
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	maxSessionsPerRemoteAddr(Integer maxSessionsPerRemoteAddr)	Set maximal number of open sessions from remote address.
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	parallelBroadcastEnabled(Boolean parallelBroadcastEnabled)
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	tracingThreshold(DebugContext.TracingThreshold tracingThreshold)	Set tracing threshold.
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	tracingType(DebugContext.TracingType tracingType)	Set type of tracing.

Methods inherited from class java.lang.Object

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

Method Details

build

public TyrusWebSocketEngine build()

Create new TyrusWebSocketEngine instance with current set of parameters.

Returns:

new TyrusWebSocketEngine instance.

applicationEventListener

public TyrusWebSocketEngine.TyrusWebSocketEngineBuilder applicationEventListener(ApplicationEventListener applicationEventListener)

Set ApplicationEventListener.

Listener can be used for monitoring various events and properties, such as deployed endpoints, ongoing sessions etc...

Parameters:

applicationEventListener - listener instance used for building .TyrusWebSocketEngine. Can be null.

Returns:

updated builder.

incomingBufferSize

public TyrusWebSocketEngine.TyrusWebSocketEngineBuilder incomingBufferSize(Integer incomingBufferSize)

Set incoming buffer size.

Parameters:

incomingBufferSize - maximal incoming buffer size (this engine won't be able to process messages bigger than this number. If null, default value will be used).

Returns:

updated builder.

clusterContext

public TyrusWebSocketEngine.TyrusWebSocketEngineBuilder clusterContext(ClusterContext clusterContext)

Set ClusterContext.

ClusterContext provides clustering functionality.

Parameters:

clusterContext - cluster context instance. null indicates standalone mode.

Returns:

updated builder.

maxSessionsPerApp

public TyrusWebSocketEngine.TyrusWebSocketEngineBuilder maxSessionsPerApp(Integer maxSessionsPerApp)

Set maximal number of open sessions per server application.

Parameters:

maxSessionsPerApp - maximal number of open sessions. If null, no limit is applied.

Returns:

updated builder.

maxSessionsPerRemoteAddr

public TyrusWebSocketEngine.TyrusWebSocketEngineBuilder maxSessionsPerRemoteAddr(Integer maxSessionsPerRemoteAddr)

Set maximal number of open sessions from remote address.

Parameters:

maxSessionsPerRemoteAddr - maximal number of open sessions from remote address. If null, no limit is applied.

Returns:

updated builder.

tracingType

public TyrusWebSocketEngine.TyrusWebSocketEngineBuilder tracingType(DebugContext.TracingType tracingType)

Set type of tracing.

Parameters:

tracingType - tracing type.

Returns:

updated builder.

tracingThreshold

public TyrusWebSocketEngine.TyrusWebSocketEngineBuilder tracingThreshold(DebugContext.TracingThreshold tracingThreshold)

Set tracing threshold.

Parameters:

tracingThreshold - tracing threshold.

Returns:

updated builder.

parallelBroadcastEnabled

public TyrusWebSocketEngine.TyrusWebSocketEngineBuilder parallelBroadcastEnabled(Boolean parallelBroadcastEnabled)