EOS_P2P_AddNotifyIncomingPacketQueueFull

EOS API reference page for EOS_P2P_AddNotifyIncomingPacketQueueFull

Choose your implementation method:

C

C#

This function is part of the P2P Interface.

Remarks

Listen for when our packet queue has become full. This event gives an opportunity to read packets to make room for new incoming packets. If this event fires and no packets are read by calling EOS_P2P_ReceivePacket or the packet queue size is not increased by EOS_P2P_SetPacketQueueSize, any packets that are received after this event are discarded until there is room again in the queue.

Return Value

A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise

Parameters

EOS_P2P_AddNotifyIncomingPacketQueueFull

Parameter Type And Name

Usage Information

EOS_HP2P Handle

const EOS_P2P_AddNotifyIncomingPacketQueueFullOptions* Options

Information about what version of the EOS_P2P_AddNotifyIncomingPacketQueueFull API is supported

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

EOS_P2P_OnIncomingPacketQueueFullCallback IncomingPacketQueueFullHandler

The callback to be fired when the incoming packet queue is full

This function enables your callback (the IncomingPacketQueueFullHandler 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_P2P_OnIncomingPacketQueueFullCallback to report the results of its operation.

Callback Remarks

Callback for information related to incoming connection requests.

Callback Parameters

EOS_P2P_OnIncomingPacketQueueFullCallback

Parameter Type And Name

Usage Information

const EOS_P2P_OnIncomingPacketQueueFullInfo* Data

Related API Members

This function is part of the P2P Interface.

Remarks

Listen for when our packet queue has become full. This event gives an opportunity to read packets to make room for new incoming packets. If this event fires and no packets are read by calling {ReceivePacket} or the packet queue size is not increased by {SetPacketQueueSize}, any packets that are received after this event are discarded until there is room again in the queue.

Return Value

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

Parameters

P2P.P2PInterface.AddNotifyIncomingPacketQueueFull

Parameter Type And Name

Usage Information

AddNotifyIncomingPacketQueueFullOptions options

Information about what version of the EOS_P2P_AddNotifyIncomingPacketQueueFull API is supported

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnIncomingPacketQueueFullCallback incomingPacketQueueFullHandler

The callback to be fired when the incoming packet queue is full

This function enables your callback (the IncomingPacketQueueFullHandler 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 P2P.OnIncomingPacketQueueFullCallback to report the results of its operation.

Callback Remarks

Callback for information related to incoming connection requests.

Callback Parameters

P2P.OnIncomingPacketQueueFullCallback

Parameter Type And Name

Usage Information

OnIncomingPacketQueueFullInfo data

Related API Members