host.anzo.eossdk.eos.sdk.sessions

Class EOS_ActiveSession_Info

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.sessions.EOS_ActiveSession_Info

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_ActiveSession_Info.ByReference, EOS_ActiveSession_Info.ByValue

@Structure.FieldOrder(value={"ApiVersion","SessionName","LocalUserId","State","SessionDetails"})
public class EOS_ActiveSession_Info
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

Since:

9/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_ActiveSession_Info.ByReference
static class	EOS_ActiveSession_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_ACTIVESESSION_INFO_API_LATEST.
static int	EOS_ACTIVESESSION_INFO_API_LATEST The most recent version of the EOS_ActiveSession_Info struct.
EOS_ProductUserId	LocalUserId The Product User ID of the local user who created or joined the session
EOS_SessionDetails_Info.ByReference	SessionDetails Session details
com.sun.jna.Pointer	SessionName Name of the session
EOS_EOnlineSessionState	State Current state of the 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_ActiveSession_Info()
EOS_ActiveSession_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_ActiveSession_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_ACTIVESESSION_INFO_API_LATEST

public static final int EOS_ACTIVESESSION_INFO_API_LATEST

The most recent version of the EOS_ActiveSession_Info struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_ACTIVESESSION_INFO_API_LATEST.

SessionName

public com.sun.jna.Pointer SessionName

Name of the session

LocalUserId

public EOS_ProductUserId LocalUserId

The Product User ID of the local user who created or joined the session

State

public EOS_EOnlineSessionState State

Current state of the session

SessionDetails

public EOS_SessionDetails_Info.ByReference SessionDetails

Session details

Constructor Detail

EOS_ActiveSession_Info

public EOS_ActiveSession_Info()

EOS_ActiveSession_Info

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

Method Detail

release

public void release()

Release the memory associated with an EOS_ActiveSession_Info structure. This must be called on data retrieved from EOS_ActiveSession_CopyInfo.

See Also:

EOS_ActiveSession.copyInfo(EOS_ActiveSession_CopyInfoOptions)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception