gt2SetReceiveDump

GameSpy SDK

gt2SetReceiveDump

Sets a callback to which all incoming UDP packets are passed. This is at a lower level than the filters, can only be used for monitoring, and is designed for debugging purposes.

void gt2SetReceiveDump(
GT2Socket socket,
gt2DumpCallback callback );
RoutineRequired HeaderDistribution
gt2SetReceiveDump<gt2.h>SDKZIP

Parameters

socket
[in] The handle to the socket.
callback
[in] The dump callback to set.

Remarks

Sets a callback to be called whenever a UDP datagram or a connection reset is received. Pass in a callback of NULL to remove the callback. The dump sit at a lower level than the filters, and allow an app to keep an eye on exactly what datagrams are being received, allowing for close monitoring. The dump cannot be used to modify data, only monitor it. The dump is useful for debugging purposes, and to keep track of data receive rates (e.g., the Quake 3 engine's netgraph). Note that these are the actual UDP datagrams being received - datagrams may be dropped, repeated, or out-of-order. Control datagrams (those used internally by the protocol) will be passed to the dump callback, and certain application messages will have a header at the beginning.