Enum Class ConcurrentwebSocketSessionDecorator.OverflowStrategy

java.lang.Object

java.lang.Enum<ConcurrentwebSocketSessionDecorator.OverflowStrategy>

org.springframework.web.socket.handler.ConcurrentwebSocketSessionDecorator.OverflowStrategy

All Implemented Interfaces:

Serializable, Comparable<ConcurrentwebSocketSessionDecorator.OverflowStrategy>, Constable

Enclosing class:

ConcurrentwebSocketSessionDecorator

public static enum ConcurrentwebSocketSessionDecorator.OverflowStrategy
extends Enum<ConcurrentwebSocketSessionDecorator.OverflowStrategy>

Enum for options of what to do when the buffer fills up.

Since:

5.1

Author:

Rossen Stoyanchev, Juergen Hoeller

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DROP	Drop the oldest messages from the buffer.
TERMINATE	Throw SessionLimitExceededException that will result in the session being terminated.

Method Summary

Modifier and Type	Method	Description
static ConcurrentwebSocketSessionDecorator.OverflowStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConcurrentwebSocketSessionDecorator.OverflowStrategy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TERMINATE

public static final ConcurrentwebSocketSessionDecorator.OverflowStrategy TERMINATE

Throw SessionLimitExceededException that will result in the session being terminated.

DROP

public static final ConcurrentwebSocketSessionDecorator.OverflowStrategy DROP

Drop the oldest messages from the buffer.

Method Details

values

public static ConcurrentwebSocketSessionDecorator.OverflowStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ConcurrentwebSocketSessionDecorator.OverflowStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null