Legacy Document

Inside Macintosh: Networking With Open Transport / Part 2 - Open Transport Reference

Chapter 22 - Endpoints Reference / Functions

Functions for Connectionless Transaction-Based Endpoints /

OTCancelURequest

Cancels a request that was made using the OTSndURequest function.

C INTERFACE

OSStatus OTCancelURequest(EndpointRef ref, OTSequence seq);

C++ INTERFACE

OSStatus TEndpoint::CancelURequest(OTSequence seq);

PARAMETERS

ref

The endpoint reference of the endpoint that has sent the request being cancelled.

seq

A 32-bit value specifying the transaction ID of the request you want to cancel. This is the same value as the one you specified for the sequence field of the req parameter when you called the OTSndURequest function.

If you specify 0 for this parameter, Open Transport cancels all outstanding requests for the endpoint. If you specify an invalid sequence number, Open Transport does not do anything.

function result

If the function completes successfully, it returns the kOTNoErr result; it does not return any other kind of acknowledgment.

DISCUSSION

The OTCancelURequest function cancels the outgoing request whose transaction ID is specified by the seq parameter.

When you call the OTSndURequest function, the provider allocates memory for internal buffers for the transaction. Calling the OTCancelURequest function tells the endpoint provider that you are no longer interested in the transaction and that it can free up any memory or internal buffers associated with the transaction request identified by the seq parameter.

It is your responsibility to deallocate memory that you have reserved for the address, options, and data buffers associated with the cancelled OTSndURequest function.

Use the OTCancelURequest function to cancel an outgoing request; use OTCancelUReply to cancel an incoming request.

SEE ALSO

Table 4-4 .