host.anzo.eossdk.eos.sdk.lobby

Class EOS_Lobby_Attribute

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.lobby.EOS_Lobby_Attribute

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Lobby_Attribute.ByReference, EOS_Lobby_Attribute.ByValue

@Structure.FieldOrder(value={"ApiVersion","Data","Visibility"})
public class EOS_Lobby_Attribute
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

An attribute and its visibility setting stored with a lobby. Used to store both lobby and lobby member data

Since:

8/16/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Lobby_Attribute.ByReference
static class	EOS_Lobby_Attribute.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_LOBBY_ATTRIBUTE_API_LATEST.
EOS_Lobby_AttributeData.ByReference	Data Key/Value pair describing the attribute
static int	EOS_LOBBY_ATTRIBUTE_API_LATEST The most recent version of the EOS_Lobby_Attribute struct.
EOS_ELobbyAttributeVisibility	Visibility Is this attribute public or private to the lobby and its members

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_Lobby_Attribute()
EOS_Lobby_Attribute(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method and Description
void	close()
void	release() Release the memory associated with a lobby attribute.

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_LOBBY_ATTRIBUTE_API_LATEST

public static final int EOS_LOBBY_ATTRIBUTE_API_LATEST

The most recent version of the EOS_Lobby_Attribute struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LOBBY_ATTRIBUTE_API_LATEST.

Data

public EOS_Lobby_AttributeData.ByReference Data

Key/Value pair describing the attribute

Visibility

public EOS_ELobbyAttributeVisibility Visibility

Is this attribute public or private to the lobby and its members

Constructor Detail

EOS_Lobby_Attribute

public EOS_Lobby_Attribute()

EOS_Lobby_Attribute

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

Method Detail

release

public void release()

Release the memory associated with a lobby attribute. This must be called on data retrieved from the various Copy functions in the LobbyDetails interface which return an EOS_Lobby_Attribute.

See Also:

EOSLibrary.EOS_LobbyDetails_CopyAttributeByIndex(host.anzo.eossdk.eos.sdk.lobby.EOS_LobbyDetails, host.anzo.eossdk.eos.sdk.lobby.options.EOS_LobbyDetails_CopyAttributeByIndexOptions, com.sun.jna.ptr.PointerByReference), EOSLibrary.EOS_LobbyDetails_CopyAttributeByKey(host.anzo.eossdk.eos.sdk.lobby.EOS_LobbyDetails, host.anzo.eossdk.eos.sdk.lobby.options.EOS_LobbyDetails_CopyAttributeByKeyOptions, com.sun.jna.ptr.PointerByReference), EOSLibrary.EOS_LobbyDetails_CopyMemberAttributeByIndex(host.anzo.eossdk.eos.sdk.lobby.EOS_LobbyDetails, host.anzo.eossdk.eos.sdk.lobby.options.EOS_LobbyDetails_CopyMemberAttributeByIndexOptions, com.sun.jna.ptr.PointerByReference), EOSLibrary.EOS_LobbyDetails_CopyMemberAttributeByKey(host.anzo.eossdk.eos.sdk.lobby.EOS_LobbyDetails, host.anzo.eossdk.eos.sdk.lobby.options.EOS_LobbyDetails_CopyMemberAttributeByKeyOptions, 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