host.anzo.eossdk.eos.sdk.sessions

Class EOS_SessionDetails_Info

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.sessions.EOS_SessionDetails_Info

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_SessionDetails_Info.ByReference, EOS_SessionDetails_Info.ByValue

@Structure.FieldOrder(value={"ApiVersion","SessionId","HostAddress","NumOpenPublicConnections","Settings","OwnerUserId","OwnerServerClientId"})
public class EOS_SessionDetails_Info
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

Internal details about a session, found on both active sessions and within search results

Since:

9/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_SessionDetails_Info.ByReference
static class	EOS_SessionDetails_Info.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
int	ApiVersion API Version: Set this to EOS_SESSIONDETAILS_INFO_API_LATEST.
static int	EOS_SESSIONDETAILS_INFO_API_LATEST The most recent version of the EOS_SessionDetails_Info struct.
java.lang.String	HostAddress IP address of this session as visible by the backend service
int	NumOpenPublicConnections Number of remaining open spaces on the session (NumPublicConnections - RegisteredPlayers
com.sun.jna.Pointer	OwnerServerClientId The client id of the session owner.
EOS_ProductUserId	OwnerUserId The Product User ID of the session owner.
java.lang.String	SessionId Session ID assigned by the backend service
EOS_SessionDetails_Settings.ByReference	Settings Reference to the additional settings associated with this session

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_SessionDetails_Info()
EOS_SessionDetails_Info(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method and Description
void	close()
void	release() Release the memory associated with an EOS_SessionDetails_Info structure.

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EOS_SESSIONDETAILS_INFO_API_LATEST

public static final int EOS_SESSIONDETAILS_INFO_API_LATEST

The most recent version of the EOS_SessionDetails_Info struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_SESSIONDETAILS_INFO_API_LATEST.

SessionId

public java.lang.String SessionId

Session ID assigned by the backend service

HostAddress

public java.lang.String HostAddress

IP address of this session as visible by the backend service

NumOpenPublicConnections

public int NumOpenPublicConnections

Number of remaining open spaces on the session (NumPublicConnections - RegisteredPlayers

Settings

public EOS_SessionDetails_Settings.ByReference Settings

Reference to the additional settings associated with this session

OwnerUserId

public EOS_ProductUserId OwnerUserId

The Product User ID of the session owner. Null if the session is not owned by a user.

OwnerServerClientId

public com.sun.jna.Pointer OwnerServerClientId

The client id of the session owner. Null if the session is not owned by a server. The session is owned by a server if EOS_Platform_Options.IsServer is EOS_TRUE.

Constructor Detail

EOS_SessionDetails_Info

public EOS_SessionDetails_Info()

EOS_SessionDetails_Info

public EOS_SessionDetails_Info(com.sun.jna.Pointer peer)

Method Detail

release

public void release()

Release the memory associated with an EOS_SessionDetails_Info structure. This must be called on data retrieved from EOSLibrary.EOS_SessionDetails_CopyInfo(host.anzo.eossdk.eos.sdk.sessions.EOS_SessionDetails, host.anzo.eossdk.eos.sdk.sessions.options.EOS_SessionDetails_CopyInfoOptions, com.sun.jna.ptr.PointerByReference).

See Also:

EOS_SessionDetails_Info, EOSLibrary.EOS_SessionDetails_CopyInfo(host.anzo.eossdk.eos.sdk.sessions.EOS_SessionDetails, host.anzo.eossdk.eos.sdk.sessions.options.EOS_SessionDetails_CopyInfoOptions, com.sun.jna.ptr.PointerByReference)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception