NAME

grpc_cancel - Cancels a session.

SYNOPSIS

grpc_error_t grpc_cancel(grpc_sessionid_t session_id)

ARGUMENTS

grpc_sessionid_t session_id
The session ID

DESCRIPTION

The grpc_cancel() function cancels the current session.

grpc_cancel() is a non-blocking function. It does not wait for the completion of the cancellation.

A cancelled session should be taken care by a wait function such as grpc_wait() so that the allocated resources for the session can be released.

Wait functions such as grpc_wait() return GRPC_SESSION_FAILED if those functions detect the cancelled session. grpc_get_error(sessionID) returns GRPC_CANCELED_NP if the cancel was successfully completed. Otherwise, it returns an error.

This function is MT-safe.


RETURN VALUE

If successful, GRPC_NO_ERROR is returned. In the case of an error, Error code is returned.

ERRORS

GRPC_NOT_INITIALIZED
GRPC client is not initialized yet.
GRPC_INVALID_SESSION_ID
Session ID is not valid.
GRPC_OTHER_ERROR_CODE
Internal error detected.
last update : $Date: 2005/07/11 07:11:24 $