host.anzo.eossdk.eos.sdk.sessions.enums

Enum EOS_EOnlineSessionState

java.lang.Object

java.lang.Enum<EOS_EOnlineSessionState>

host.anzo.eossdk.eos.sdk.sessions.enums.EOS_EOnlineSessionState

All Implemented Interfaces:

com.sun.jna.NativeMapped, java.io.Serializable, java.lang.Comparable<EOS_EOnlineSessionState>

public enum EOS_EOnlineSessionState
extends java.lang.Enum<EOS_EOnlineSessionState>
implements com.sun.jna.NativeMapped

All possible states of an existing named session

Since:

9/5/2023

Enum Constant Summary

Enum Constants

Enum Constant and Description
EOS_OSS_Creating An online session is in the process of being created
EOS_OSS_Destroying The session is being destroyed
EOS_OSS_Ended The session is closed and any stats committed
EOS_OSS_Ending The session is still valid, but the session is no longer being played (post match lobby)
EOS_OSS_InProgress The current session has started.
EOS_OSS_NoSession An online session has not been created yet
EOS_OSS_Pending Session has been created but the session hasn't started (pre match lobby)
EOS_OSS_Starting Session has been asked to start (may take time due to communication with backend)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	fromNative(java.lang.Object nativeValue, com.sun.jna.FromNativeContext context)
java.lang.Class<?>	nativeType()
java.lang.Object	toNative()
static EOS_EOnlineSessionState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EOS_EOnlineSessionState[]	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

EOS_OSS_NoSession

public static final EOS_EOnlineSessionState EOS_OSS_NoSession

An online session has not been created yet

EOS_OSS_Creating

public static final EOS_EOnlineSessionState EOS_OSS_Creating

An online session is in the process of being created

EOS_OSS_Pending

public static final EOS_EOnlineSessionState EOS_OSS_Pending

Session has been created but the session hasn't started (pre match lobby)

EOS_OSS_Starting

public static final EOS_EOnlineSessionState EOS_OSS_Starting

Session has been asked to start (may take time due to communication with backend)

EOS_OSS_InProgress

public static final EOS_EOnlineSessionState EOS_OSS_InProgress

The current session has started. Sessions with join in progress disabled are no longer joinable

EOS_OSS_Ending

public static final EOS_EOnlineSessionState EOS_OSS_Ending

The session is still valid, but the session is no longer being played (post match lobby)

EOS_OSS_Ended

public static final EOS_EOnlineSessionState EOS_OSS_Ended

The session is closed and any stats committed

EOS_OSS_Destroying

public static final EOS_EOnlineSessionState EOS_OSS_Destroying

The session is being destroyed

Method Detail

values

public static EOS_EOnlineSessionState[] 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 (EOS_EOnlineSessionState c : EOS_EOnlineSessionState.values())
    System.out.println(c);

Returns:

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

valueOf

public static EOS_EOnlineSessionState 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

fromNative

public java.lang.Object fromNative(java.lang.Object nativeValue,
                                   com.sun.jna.FromNativeContext context)

Specified by:

fromNative in interface com.sun.jna.NativeMapped

toNative

public java.lang.Object toNative()

Specified by:

toNative in interface com.sun.jna.NativeMapped

nativeType

public java.lang.Class<?> nativeType()

Specified by:

nativeType in interface com.sun.jna.NativeMapped