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

Chapter 22 - Endpoints Reference / Functions

Obtaining Information About an Endpoint /

OTGetEndpointInfo

Obtains information about an endpoint that has been opened.

C INTERFACE

OSStatus OTGetEndpointInfo(EndpointRef ref,
                     TEndpointInfo* info);

C++ INTERFACE

OSStatus TEndpoint::GetEndpointInfo(TEndpointInfo* info);

PARAMETERS

ref

The endpoint reference of the endpoint whose characteristics you want to determine.

info

A pointer to a TEndpointInfo structure that describes the endpoint's mode of service and the size of the buffers you can use to specify address and option information and to hold data.

function result

An error code. See Appendix B.

DISCUSSION

The OTGetEndpointInfo function returns information about

• the maximum size of buffers used to specify an endpoint's address and option values

• the maximum size of normal and expedited data you can transfer using this endpoint or, for transaction-based endpoints, the maximum size of requests and replies

• the size of data you can transfer when initiating or tearing down a connection

• the services supported by the endpoint

• any additional characteristics of this endpoint

If the endpoint is in synchronous mode, the function fills out the fields in the TEndpointInfo structure and returns. If the endpoint is in asynchronous mode and you have installed a notifier function, the OTGetEndpointInfo function returns the result kOTNoError and sends the T_GETINFOCOMPLETE event to your notifier when the operation completes. The result parameter is kOTNOError if the function succeeded. Otherwise, it contains a result code describing the reason why it failed. The cookie parameter passed to the notification routine contains the value of the info parameter that you originally passed to the OTGetEndpointInfo function. If you have not installed a notification routine, it is not possible to determine when this command completed. For more information on notification functions and event codes, see MyNotifierCallback function and "Event Codes".

SEE ALSO

The OTGetEndpointState function.

"The TEndpointInfo Structure"

Table 4-4.