Legacy Document

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

Chapter 22 - Endpoints Reference / Functions

Obtaining Information About an Endpoint /

OTSync

Ensures that the endpoint provider and the Open Transport client libraries have the same information about an endpoint's state.

C INTERFACE

OTResult OTSync(EndpointRef ref);

C++ INTERFACE

OTResult TEndpoint::Sync();

PARAMETERS

ref

The endpoint reference of the endpoint whose state information is being synchronized.

function result

See Discussion.

DISCUSSION

The provider's and the client's libraries knowledge about an endpoint's state might get out of sync if the provider and the client libraries occupy different memory spaces. The current run-time environment does not support separate memory spaces; therefore, this function does nothing and is provided so that existing XTI-based applications that make this call do not have to be modified.

If the OTSync function succeeds, it returns an integer value of 0 or greater that specifies the current state of the endpoint.

If the OTSync function fails, it returns a negative integer corresponding to a result code. See Appendix C.

If the endpoint is in synchronous mode, it returns as soon the operation is complete. If the endpoint is in asynchronous mode and you have installed a notification routine, the OTSync function returns the result kOTNoError and the provider sends the T_SYNCCOMPLETE event code to the notifier when the operation completes. The result parameter is either a negative error code or a state code. The cookie parameter has no meaning. If a notifier is not installed, it is not possible to determine when the OTSync function completes. For more information on notifier functions and event codes see MyNotifierCallback function and "Event Codes".

SEE ALSO

The OTGetEndpointState function.

"Endpoint States".

Table 4-4.