public class EOS_AntiCheatServer_Interface
extends com.sun.jna.PointerType
| Constructor and Description |
|---|
EOS_AntiCheatServer_Interface() |
EOS_AntiCheatServer_Interface(com.sun.jna.Pointer address) |
| Modifier and Type | Method and Description |
|---|---|
EOS_NotificationId |
addNotifyClientActionRequired(com.sun.jna.Pointer clientData,
EOS_AntiCheatServer_OnClientActionRequiredCallback notificationFn)
Add a callback issued when an action must be applied to a connected client.
|
EOS_NotificationId |
addNotifyClientAuthStatusChanged(com.sun.jna.Pointer clientData,
EOS_AntiCheatServer_OnClientAuthStatusChangedCallback notificationFn)
Add an optional callback issued when a connected client's authentication status changes.
|
EOS_NotificationId |
addNotifyMessageToClient(com.sun.jna.Pointer clientData,
EOS_AntiCheatServer_OnMessageToClientCallback notificationFn)
Add a callback issued when a new message must be dispatched to a connected client.
|
EOS_EResult |
beginSession(EOS_AntiCheatServer_BeginSessionOptions options)
Begin the gameplay session.
|
EOS_EResult |
endSession()
End the gameplay session.
|
int |
getProtectMessageOutputLength(int dataSize)
Optional NetProtect feature for game message encryption.
|
EOS_EResult |
logEvent(EOS_AntiCheatCommon_LogEventOptions options)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logGameRoundEnd(int winningTeamId)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logGameRoundStart(EOS_AntiCheatCommon_LogGameRoundStartOptions options)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logPlayerDespawn(EOS_AntiCheatCommon_LogPlayerDespawnOptions options)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logPlayerRevive(EOS_AntiCheatCommon_LogPlayerReviveOptions options)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logPlayerSpawn(EOS_AntiCheatCommon_LogPlayerSpawnOptions options)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logPlayerTakeDamage(EOS_AntiCheatCommon_LogPlayerTakeDamageOptions options)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logPlayerTick(EOS_AntiCheatCommon_LogPlayerTickOptions options)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logPlayerUseAbility(EOS_AntiCheatCommon_LogPlayerUseAbilityOptions options)
Optional Cerberus feature for gameplay data collection.
|
EOS_EResult |
logPlayerUseWeapon(EOS_AntiCheatCommon_LogPlayerUseWeaponOptions options)
Optional Cerberus feature for gameplay data collection.
|
java.nio.ByteBuffer |
protectMessage(EOS_AntiCheatCommon_ClientHandle clientHandle,
byte[] data,
int outBufferSizeBytes)
Optional NetProtect feature for game message encryption.
|
EOS_EResult |
receiveMessageFromClient(@NotNull EOS_AntiCheatCommon_ClientHandle clientHandle,
byte[] data)
Call when an anti-cheat message is received from a client.
|
EOS_EResult |
registerClient(EOS_AntiCheatServer_RegisterClientOptions options)
Register a connected client.
|
EOS_EResult |
registerEvent(EOS_AntiCheatCommon_RegisterEventOptions options)
Optional Cerberus feature for gameplay data collection.
|
void |
removeNotifyClientActionRequired(EOS_NotificationId notificationId)
Remove a previously bound EOS_AntiCheatServer_AddNotifyClientActionRequired handler.
|
void |
removeNotifyClientAuthStatusChanged(EOS_NotificationId notificationId)
Remove a previously bound EOS_AntiCheatServer_AddNotifyClientAuthStatusChanged handler.
|
void |
removeNotifyMessageToClient(EOS_NotificationId notificationId)
Remove a previously bound EOS_AntiCheatServer_AddNotifyMessageToClient handler.
|
EOS_EResult |
setClientDetails(EOS_AntiCheatCommon_SetClientDetailsOptions options)
Optional.
|
EOS_EResult |
setClientNetworkState(EOS_AntiCheatCommon_ClientHandle clientHandle,
boolean isNetworkActive)
Optional.
|
EOS_EResult |
setGameSessionId(java.lang.String gameSessionId)
Optional.
|
java.nio.ByteBuffer |
unprotectMessage(EOS_AntiCheatCommon_ClientHandle clientHandle,
byte[] data)
Optional NetProtect feature for game message encryption.
|
EOS_EResult |
unregisterClient(@NotNull EOS_AntiCheatCommon_ClientHandle clientHandle)
Unregister a disconnected client.
|
public EOS_AntiCheatServer_Interface(com.sun.jna.Pointer address)
public EOS_AntiCheatServer_Interface()
public EOS_NotificationId addNotifyMessageToClient(com.sun.jna.Pointer clientData, EOS_AntiCheatServer_OnMessageToClientCallback notificationFn)
clientData - This value is returned to the caller when NotificationFn is invokednotificationFn - The callback to be firedEOS_NotificationId.EOS_INVALID_NOTIFICATIONID otherwisepublic void removeNotifyMessageToClient(EOS_NotificationId notificationId)
notificationId - The previously bound notification IDpublic EOS_NotificationId addNotifyClientActionRequired(com.sun.jna.Pointer clientData, EOS_AntiCheatServer_OnClientActionRequiredCallback notificationFn)
clientData - This value is returned to the caller when NotificationFn is invokednotificationFn - The callback to be firedEOS_NotificationId.EOS_INVALID_NOTIFICATIONID otherwisepublic void removeNotifyClientActionRequired(EOS_NotificationId notificationId)
notificationId - The previously bound notification IDpublic EOS_NotificationId addNotifyClientAuthStatusChanged(com.sun.jna.Pointer clientData, EOS_AntiCheatServer_OnClientAuthStatusChangedCallback notificationFn)
clientData - This value is returned to the caller when NotificationFn is invokednotificationFn - The callback to be firedEOS_NotificationId.EOS_INVALID_NOTIFICATIONID otherwisepublic void removeNotifyClientAuthStatusChanged(EOS_NotificationId notificationId)
notificationId - The previously bound notification IDpublic EOS_EResult beginSession(EOS_AntiCheatServer_BeginSessionOptions options)
options - Structure containing input data.EOS_EResult.EOS_Success - If the initialization succeeded
EOS_EResult.EOS_InvalidParameters - If input data was invalidpublic EOS_EResult endSession()
EOS_EResult.EOS_Success - If the initialization succeeded
EOS_EResult.EOS_InvalidParameters - If input data was invalidpublic EOS_EResult registerClient(EOS_AntiCheatServer_RegisterClientOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the player was registered successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalidpublic EOS_EResult unregisterClient(@NotNull @NotNull EOS_AntiCheatCommon_ClientHandle clientHandle)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
clientHandle - Locally unique value describing the remote user, as previously passed to RegisterClientEOS_EResult.EOS_Success - If the player was unregistered successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalidpublic EOS_EResult receiveMessageFromClient(@NotNull @NotNull EOS_AntiCheatCommon_ClientHandle clientHandle, byte[] data)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
clientHandle - Locally unique value describing the corresponding remote user, as previously passed to RegisterClientdata - The data receivedEOS_EResult.EOS_Success - If the message was processed successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_InvalidRequest - If message contents were corrupt and could not be processedpublic EOS_EResult setClientDetails(EOS_AntiCheatCommon_SetClientDetailsOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the flags were updated successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalidpublic EOS_EResult setGameSessionId(java.lang.String gameSessionId)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
gameSessionId - Game session identifierEOS_EResult.EOS_Success - If the game session identifier was set successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalidpublic EOS_EResult setClientNetworkState(EOS_AntiCheatCommon_ClientHandle clientHandle, boolean isNetworkActive)
The IsNetworkActive flag must be set back to true when users enter normal gameplay, otherwise anti-cheat enforcement will not work correctly.
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
clientHandle - Locally unique value describing the remote user (e.g. a player object pointer)isNetworkActive - true if the network is functioning normally, false if temporarily interruptedEOS_EResult.EOS_Success - If the network state was updated successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalidpublic int getProtectMessageOutputLength(int dataSize)
throws EOSException
dataSize - input data sizeEOSInvalidParametersException - If input data was invalidEOSExceptionpublic java.nio.ByteBuffer protectMessage(EOS_AntiCheatCommon_ClientHandle clientHandle, byte[] data, int outBufferSizeBytes) throws EOSException
Options.Data and OutBuffer may refer to the same buffer to encrypt in place.
clientHandle - Locally unique value describing the remote user to whom the message will be sentdata - The data to encryptoutBufferSizeBytes - The size in bytes of OutBufferEOSInvalidParametersException - If input data was invalidEOSInvalidUserException - If the specified ClientHandle was invalid or not currently registered. See registerClient(EOS_AntiCheatServer_RegisterClientOptions)EOSExceptionpublic java.nio.ByteBuffer unprotectMessage(EOS_AntiCheatCommon_ClientHandle clientHandle, byte[] data) throws EOSException
Options.Data and OutBuffer may refer to the same buffer to decrypt in place.
clientHandle - Locally unique value describing the remote user from whom the message was receiveddata - The data to decryptEOSInvalidParametersException - If input data was invalidEOSExceptionpublic EOS_EResult registerEvent(EOS_AntiCheatCommon_RegisterEventOptions options)
All custom game events must be registered before EOS_AntiCheatServer_BeginSession is called for the first time. After the first call to EOS_AntiCheatServer_BeginSession, this function cannot be called any longer.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was registered successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalidpublic EOS_EResult logEvent(EOS_AntiCheatCommon_LogEventOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logGameRoundStart(EOS_AntiCheatCommon_LogGameRoundStartOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logGameRoundEnd(int winningTeamId)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
winningTeamId - Optional identifier for the winning teamEOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logPlayerSpawn(EOS_AntiCheatCommon_LogPlayerSpawnOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logPlayerDespawn(EOS_AntiCheatCommon_LogPlayerDespawnOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logPlayerRevive(EOS_AntiCheatCommon_LogPlayerReviveOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logPlayerTick(EOS_AntiCheatCommon_LogPlayerTickOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logPlayerUseWeapon(EOS_AntiCheatCommon_LogPlayerUseWeaponOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logPlayerUseAbility(EOS_AntiCheatCommon_LogPlayerUseAbilityOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundariespublic EOS_EResult logPlayerTakeDamage(EOS_AntiCheatCommon_LogPlayerTakeDamageOptions options)
This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
options - Structure containing input data.EOS_EResult.EOS_Success - If the event was logged successfully
EOS_EResult.EOS_InvalidParameters - If input data was invalid
EOS_EResult.EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries