SOIcmpCancel

Syntax

#include <cafe.h>
#include <cafe/network.h>

int SOIcmpCancel(int handle);

Parameters

handle Handle to cancel pings from.

Return Values

0 upon success. Upon failure, -1 is returned and errno is set appropriately.

Errors

SO_ELIBNOTREADY Socket library is not initialized.
SO_ENOMEM Insufficient memory in the stack.
SO_EINVAL Invalid handle passed.
SO_EALREADY No pending ping.
SO_EFAULT An abnormal operation occurred in the stack. The corresponding handle should be closed for this type of serious error.

Description

Cancels any pending pings associated with the handle. If SOIcmpCancel is successful, SOIcmpPing will return -1 and errno will be set to SO_EABORTED.

For information on an ICMP API overview, see SOIcmpCreateHandle.

Do Not Call From

Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.

See Also

SOIcmpCreateHandle
SOIcmpPing
SOIcmpCloseHandle
SOIcmpLastCodeType

Revision History

2014/01/24 Initial version.


CONFIDENTIAL