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

Class EOS_AntiCheatClient_RegisterPeerOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.anticheat.client.options.EOS_AntiCheatClient_RegisterPeerOptions

Direct Known Subclasses:

EOS_AntiCheatClient_RegisterPeerOptions.ByReference, EOS_AntiCheatClient_RegisterPeerOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","PeerHandle","ClientType","ClientPlatform","AuthenticationTimeout","AccountId_DEPRECATED","IpAddress","PeerProductUserId"})
public class EOS_AntiCheatClient_RegisterPeerOptions
extends com.sun.jna.Structure

Input parameters for the EOSLibrary.EOS_AntiCheatClient_RegisterPeer(host.anzo.eossdk.eos.sdk.EOS_AntiCheatClient_Interface, host.anzo.eossdk.eos.sdk.anticheat.client.options.EOS_AntiCheatClient_RegisterPeerOptions) function.

Since:

8/16/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_AntiCheatClient_RegisterPeerOptions.ByReference
static class	EOS_AntiCheatClient_RegisterPeerOptions.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 - use PeerProductUserId instead
int	ApiVersion API Version: Set this to EOS_ANTICHEATCLIENT_REGISTERPEER_API_LATEST.
int	AuthenticationTimeout Time in seconds to allow newly registered peers to send the initial message containing their token.
EOS_EAntiCheatCommonClientPlatform	ClientPlatform Remote user's platform, if known
EOS_EAntiCheatCommonClientType	ClientType Type of remote user being registered
static EOS_AntiCheatCommon_ClientHandle	EOS_ANTICHEATCLIENT_PEER_SELF A special peer handle that represents the client itself.
static int	EOS_ANTICHEATCLIENT_REGISTERPEER_API_LATEST The most recent version of the EOS_AntiCheatClient_RegisterPeerOptions API.
static int	EOS_ANTICHEATCLIENT_REGISTERPEER_MAX_AUTHENTICATIONTIMEOUT The maximum value for the AuthenticationTimeout parameter in the EOS_AntiCheatClient_RegisterPeerOptions struct.
static int	EOS_ANTICHEATCLIENT_REGISTERPEER_MIN_AUTHENTICATIONTIMEOUT The minimum value for the AuthenticationTimeout parameter in the EOS_AntiCheatClient_RegisterPeerOptions struct.
java.lang.String	IpAddress Optional IP address for the remote user.
EOS_AntiCheatCommon_ClientHandle	PeerHandle Locally unique value describing the remote user (e.g. a player object pointer)
EOS_ProductUserId	PeerProductUserId EOS_ProductUserId Identifier for the remote user

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_AntiCheatClient_RegisterPeerOptions()
EOS_AntiCheatClient_RegisterPeerOptions(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_ANTICHEATCLIENT_PEER_SELF

public static final EOS_AntiCheatCommon_ClientHandle EOS_ANTICHEATCLIENT_PEER_SELF

A special peer handle that represents the client itself. It does not need to be registered or unregistered and is used in OnPeerActionRequiredCallback to quickly signal to the user that they will not be able to join online play.

EOS_ANTICHEATCLIENT_REGISTERPEER_MIN_AUTHENTICATIONTIMEOUT

public static final int EOS_ANTICHEATCLIENT_REGISTERPEER_MIN_AUTHENTICATIONTIMEOUT

The minimum value for the AuthenticationTimeout parameter in the EOS_AntiCheatClient_RegisterPeerOptions struct.

See Also:

Constant Field Values

EOS_ANTICHEATCLIENT_REGISTERPEER_MAX_AUTHENTICATIONTIMEOUT

public static final int EOS_ANTICHEATCLIENT_REGISTERPEER_MAX_AUTHENTICATIONTIMEOUT

The maximum value for the AuthenticationTimeout parameter in the EOS_AntiCheatClient_RegisterPeerOptions struct.

See Also:

Constant Field Values

EOS_ANTICHEATCLIENT_REGISTERPEER_API_LATEST

public static final int EOS_ANTICHEATCLIENT_REGISTERPEER_API_LATEST

The most recent version of the EOS_AntiCheatClient_RegisterPeerOptions API.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_ANTICHEATCLIENT_REGISTERPEER_API_LATEST.

PeerHandle

public EOS_AntiCheatCommon_ClientHandle PeerHandle

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

AuthenticationTimeout

public int AuthenticationTimeout

Time in seconds to allow newly registered peers to send the initial message containing their token.
Minimum value: EOS_ANTICHEATCLIENT_REGISTERPEER_MIN_AUTHENTICATIONTIMEOUT
Maximum value: EOS_ANTICHEATCLIENT_REGISTERPEER_MAX_AUTHENTICATIONTIMEOUT

AccountId_DEPRECATED

public java.lang.String AccountId_DEPRECATED

Deprecated - use PeerProductUserId instead

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"

PeerProductUserId

public EOS_ProductUserId PeerProductUserId

EOS_ProductUserId Identifier for the remote user

Constructor Detail

EOS_AntiCheatClient_RegisterPeerOptions

public EOS_AntiCheatClient_RegisterPeerOptions()

EOS_AntiCheatClient_RegisterPeerOptions

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