io.mats3.matssocket

Enum MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType

java.lang.Object

java.lang.Enum<MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType>

io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType>

Enclosing interface:

MatsSocketServer.SessionRemovedEvent

public static enum MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType
extends java.lang.Enum<MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType>

Type of "remove": Either DEREGISTER, CLOSE or TIMEOUT. You may get one or several invocations for a session: You may get a CLOSE by itself: The user has logged in, does some stuff, and then "logs out" / closes the browser tab (i.e. invoking client.close()), thus actively closing the session explicitly. Or, you may first get a DEREGISTER e.g. due to the Client driving through a tunnel and loosing connection, in which case the most likely result is (hopefully) that the Client again SessionEstablishedEventType.RECONNECT - but if not, the Server may shortly get a CLOSE - or much later a TIMEOUT. This means that the session may alter back and forth between DEREGISTER and RECONNECT multiple times, but will always eventually get a CLOSE or TIMEOUT.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE The MatsSocketSession was explicitly closed.
DEREGISTER The WebSocket connection was severed without an explicit MatsSocketSession closing, e.g.
TIMEOUT The MatsSocketSession was previously DEREGISTER, but was now "cleaned out" by the timeouter.

Method Summary

Modifier and Type	Method and Description
boolean	isSessionClosed()
static MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEREGISTER

public static final MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType DEREGISTER

The WebSocket connection was severed without an explicit MatsSocketSession closing, e.g. because the user driving through a Tunnel or closing the lid of his laptop, or similar things that break the WebSocket connection. The MatsSocketSession is now still NOT closed - the session will either SessionEstablishedEventType.RECONNECT again, or you will get a CLOSE or TIMEOUT at a later point.

CLOSE

public static final MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType CLOSE

The MatsSocketSession was explicitly closed. This may, or may not, have implied that the WebSocket connection was closed (either it was open, and was closed with this event - or it was already closed (DEREGISTER)). The MatsSocketSession is now closed.

TIMEOUT

public static final MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType TIMEOUT

The MatsSocketSession was previously DEREGISTER, but was now "cleaned out" by the timeouter. The MatsSocketSession is now closed.

Method Detail

values

public static MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType c : MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType.values())
    System.out.println(c);

Returns:

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

valueOf

public static MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isSessionClosed

public boolean isSessionClosed()

Returns:

whether this event type represents a closing of the session (i.e. removing all traces of it - type CLOSE or TIMEOUT), or if it can still RECONNECT with the same MatsSocketSessionId (type DEREGISTER).