EOS_AntiCheatClient_AddNotifyMessageToServer

EOS API reference page for EOS_AntiCheatClient_AddNotifyMessageToServer

Choose your implementation method:

C

C#

This function is part of the AntiCheatClient Interface.

Remarks

Add a callback issued when a new message must be dispatched to the game server. 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_ClientServer. Mode: EOS_ACCM_ClientServer.

Return Value

A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise

Parameters

EOS_AntiCheatClient_AddNotifyMessageToServer

Parameter Type And Name

Usage Information

EOS_HAntiCheatClient Handle

const EOS_AntiCheatClient_AddNotifyMessageToServerOptions* Options

Structure containing input data

void* ClientData

This value is returned to the caller when NotificationFn is invoked

EOS_AntiCheatClient_OnMessageToServerCallback 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_OnMessageToServerCallback to report the results of its operation. See the EOS_AntiCheatClient_OnMessageToServerCallbackInfo page for more details, or check the Callback Data section below.

Callback Remarks

Callback issued when a new message must be dispatched to the game server. Messages contain opaque binary data of up to 256 bytes and must be transmitted to the game server using the game's own networking layer, then delivered to the server anti-cheat instance using the EOS_AntiCheatServer_ReceiveMessageFromClient function. This callback is always issued from within EOS_Platform_Tick on its calling thread.

Callback Parameters

EOS_AntiCheatClient_OnMessageToServerCallback

Parameter Type And Name

Usage Information

const EOS_AntiCheatClient_OnMessageToServerCallbackInfo* Data

Callback Data

The EOS SDK passes the following data structure to the callback function:

EOS_AntiCheatClient_OnMessageToServerCallbackInfo

Property

Value

void* ClientData

Caller-specified context data

const void* MessageData

The message data that must be sent to the server

uint32_t MessageDataSizeBytes

The size in bytes of MessageData

For more information, see the EOS_AntiCheatClient_OnMessageToServerCallbackInfo page.

Related API Members

This function is part of the AntiCheatClient Interface.

Remarks

Add a callback issued when a new message must be dispatched to the game server. The bound function will only be called between a successful call to {BeginSession} and the matching {EndSession} call in mode {AntiCheatClientMode.ClientServer}. Mode: {AntiCheatClientMode.ClientServer}.

Return Value

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

Parameters

AntiCheatClient.AntiCheatClientInterface.AddNotifyMessageToServer

Parameter Type And Name

Usage Information

AddNotifyMessageToServerOptions options

Structure containing input data

object clientData

This value is returned to the caller when NotificationFn is invoked

OnMessageToServerCallback 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.OnMessageToServerCallback to report the results of its operation. See the AntiCheatClient.OnMessageToServerCallbackInfo page for more details, or check the Callback Data section below.

Callback Remarks

Callback issued when a new message must be dispatched to the game server. Messages contain opaque binary data of up to 256 bytes and must be transmitted to the game server using the game's own networking layer, then delivered to the server anti-cheat instance using the {AntiCheatServer.AntiCheatServerInterface.ReceiveMessageFromClient} function. This callback is always issued from within {Platform.PlatformInterface.Tick} on its calling thread.

Callback Parameters

AntiCheatClient.OnMessageToServerCallback

Parameter Type And Name

Usage Information

OnMessageToServerCallbackInfo data

Callback Data

The EOS SDK passes the following data structure to the callback function:

AntiCheatClient.OnMessageToServerCallbackInfo

Property

Value

object ClientData

Caller-specified context data

byte[] MessageData

The message data that must be sent to the server

For more information, see the AntiCheatClient.OnMessageToServerCallbackInfo page.

Related API Members

Tags