gpSetTransferThrottle
This function can be used to set a throttle on a transfer.
NOTE: Throttling is not currently implemented. Throttle information is transmitted between the local profile and remote profile, but no throttling actually occurs.
- GPResult gpSetTransferThrottle(
- GPConnection * connection,
- GPTransfer transfer,
- int throttle );
| Routine | Required Header | Distribution |
|---|---|---|
| gpSetTransferThrottle | <gp.h> | SDKZIP |
Return Value
This function returns GP_NO_ERROR upon success. Otherwise a valid GPResult is returned.
Parameters
- connection
- [in] A GP connection interface.
- transfer
- [in] A pointer to a GPTransfer object.
- throttle
- [in] The throttle setting.
Remarks
NOTE: Throttling is not currently implemented.
This function can be used to either pause a transfer or limit a transfer to a maximum rate. It can be called by either the sender or the receiver. After a call to this function, both the local profile and remote profile will receive a gpTransferCallback of type GP_TRANSFER_THROTTLE.
Section Reference: Gamespy Presence SDK