EOS API reference page for EOS_AntiCheatClient_AddNotifyPeerActionRequired

2 mins to read

This function is part of the AntiCheatClient Interface.


Add a callback issued when an action must be applied to a connected client. The bound function will only be called between a successful call to EOS_AntiCheatClient_BeginSession and the matching EOS_AntiCheatClient_EndSession call in mode EOS_ACCM_PeerToPeer. Mode: EOS_ACCM_PeerToPeer.

Return Value

A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise



Parameter Type And NameUsage Information
EOS_HAntiCheatClient Handle
const EOS_AntiCheatClient_AddNotifyPeerActionRequiredOptions* OptionsStructure containing input data
void* ClientDataThis value is returned to the caller when NotificationFn is invoked
EOS_AntiCheatClient_OnPeerActionRequiredCallback NotificationFnThe callback to be fired

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_AntiCheatClient_OnPeerActionRequiredCallback to report the results of its operation.

Callback Remarks

Callback issued when an action must be applied to a connected peer. This callback is always issued from within EOS_Platform_Tick on its calling thread.

Callback Parameters


Parameter Type And NameUsage Information
const EOS_AntiCheatCommon_OnClientActionRequiredCallbackInfo* Data