host.anzo.eossdk.eos.sdk.anticheat.server.options

Class EOS_AntiCheatServer_RegisterClientOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.anticheat.server.options.EOS_AntiCheatServer_RegisterClientOptions

Direct Known Subclasses:

EOS_AntiCheatServer_RegisterClientOptions.ByReference, EOS_AntiCheatServer_RegisterClientOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","ClientHandle","ClientType","ClientPlatform","AccountId_DEPRECATED","IpAddress","UserId","Reserved01"})
public class EOS_AntiCheatServer_RegisterClientOptions
extends com.sun.jna.Structure

Input parameters for the EOSLibrary.EOS_AntiCheatServer_RegisterClient(host.anzo.eossdk.eos.sdk.EOS_AntiCheatServer_Interface, host.anzo.eossdk.eos.sdk.anticheat.server.options.EOS_AntiCheatServer_RegisterClientOptions) function.

Since:

8/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_AntiCheatServer_RegisterClientOptions.ByReference
static class	EOS_AntiCheatServer_RegisterClientOptions.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
java.lang.String	AccountId_DEPRECATED DEPRECATED - New code should set this to null and specify UserId instead.
int	ApiVersion API Version: Set this to EOS_ANTICHEATSERVER_REGISTERCLIENT_API_LATEST.
EOS_AntiCheatCommon_ClientHandle	ClientHandle Locally unique value describing the remote user (e.g. a player object pointer)
EOS_EAntiCheatCommonClientPlatform	ClientPlatform Remote user's platform, if known
EOS_EAntiCheatCommonClientType	ClientType Type of remote user being registered
static int	EOS_ANTICHEATSERVER_REGISTERCLIENT_API_LATEST The most recent version of the EOS_AntiCheatServer_RegisterClient API.
java.lang.String	IpAddress Optional IP address for the remote user.
int	Reserved01 Reserved for future use.
EOS_ProductUserId	UserId The Product User ID for the remote user who is being registered.

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_AntiCheatServer_RegisterClientOptions()
EOS_AntiCheatServer_RegisterClientOptions(@NotNull AEOSNetworkClient client)
EOS_AntiCheatServer_RegisterClientOptions(com.sun.jna.Pointer peer)

Method Summary

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_ANTICHEATSERVER_REGISTERCLIENT_API_LATEST

public static int EOS_ANTICHEATSERVER_REGISTERCLIENT_API_LATEST

The most recent version of the EOS_AntiCheatServer_RegisterClient API.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_ANTICHEATSERVER_REGISTERCLIENT_API_LATEST.

ClientHandle

public EOS_AntiCheatCommon_ClientHandle ClientHandle

Locally unique value describing the remote user (e.g. a player object pointer)

ClientType

public EOS_EAntiCheatCommonClientType ClientType

Type of remote user being registered

ClientPlatform

public EOS_EAntiCheatCommonClientPlatform ClientPlatform

Remote user's platform, if known

AccountId_DEPRECATED

public java.lang.String AccountId_DEPRECATED

DEPRECATED - New code should set this to null and specify UserId instead. Identifier for the remote user. This is typically a string representation of an account ID, but it can be any string which is both unique (two different users will never have the same string) and consistent (if the same user connects to this game session twice, the same string will be used) in the scope of a single protected game session.

IpAddress

public java.lang.String IpAddress

Optional IP address for the remote user. May be null if not available. IPv4 format: "0.0.0.0" IPv6 format: "0:0:0:0:0:0:0:0"

UserId

public EOS_ProductUserId UserId

The Product User ID for the remote user who is being registered.

Reserved01

public int Reserved01

Reserved for future use. Must be set to 0.

Constructor Detail

EOS_AntiCheatServer_RegisterClientOptions

public EOS_AntiCheatServer_RegisterClientOptions()

EOS_AntiCheatServer_RegisterClientOptions

public EOS_AntiCheatServer_RegisterClientOptions(@NotNull
                                                 @NotNull AEOSNetworkClient client)

EOS_AntiCheatServer_RegisterClientOptions

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