EOS_AntiCheatClient_AddNotifyPeerActionRequired

EOS API reference page for EOS_AntiCheatClient_AddNotifyPeerActionRequired

Choose your implementation method:

C

C#

This function is part of the AntiCheatClient Interface.

Remarks

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

Parameters

EOS_AntiCheatClient_AddNotifyPeerActionRequired

Parameter Type And Name

Usage Information

EOS_HAntiCheatClient Handle

const EOS_AntiCheatClient_AddNotifyPeerActionRequiredOptions* Options

Structure containing input data

void* ClientData

This value is returned to the caller when NotificationFn is invoked

EOS_AntiCheatClient_OnPeerActionRequiredCallback NotificationFn

The callback to be fired

This function enables your callback (the NotificationFn parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.

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

EOS_AntiCheatClient_OnPeerActionRequiredCallback

Parameter Type And Name

Usage Information

const EOS_AntiCheatCommon_OnClientActionRequiredCallbackInfo* Data

Related API Members

This function is part of the AntiCheatClient Interface.

Remarks

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 {BeginSession} and the matching {EndSession} call in mode {AntiCheatClientMode.PeerToPeer}. Mode: {AntiCheatClientMode.PeerToPeer}.

Return Value

A valid notification ID if successfully bound, or {Common.InvalidNotificationid} otherwise

Parameters

AntiCheatClient.AntiCheatClientInterface.AddNotifyPeerActionRequired

Parameter Type And Name

Usage Information

AddNotifyPeerActionRequiredOptions options

Structure containing input data

object clientData

This value is returned to the caller when NotificationFn is invoked

OnPeerActionRequiredCallback notificationFn

The callback to be fired

This function enables your callback (the NotificationFn parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.

Callback Function Information

Because this function is asynchronous, it employs a callback of type 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 {Platform.PlatformInterface.Tick} on its calling thread.

Callback Parameters

AntiCheatClient.OnPeerActionRequiredCallback

Parameter Type And Name

Usage Information

AntiCheatCommon.OnClientActionRequiredCallbackInfo data

Related API Members

Tags