Open Transport client interface file. This contains all the client APIs. More...

#include <MacTypes.h>
#include <MixedMode.h>
#include <MacErrors.h>

Data Structures
struct	OTAddress

struct	OTScriptInfo

struct	TOptionHeader

struct	TOption

struct	t_kpalive

struct	t_linger

struct	TEndpointInfo

struct	OTPortRecord

struct	TNetbuf

struct	strbuf

struct	OTData

struct	OTBuffer

struct	OTBufferInfo

struct	TBind

struct	TDiscon

struct	TCall

struct	TUnitData

struct	TUDErr

struct	TOptMgmt

struct	TRequest

struct	TReply

struct	TUnitRequest

struct	TUnitReply

struct	TRegisterRequest

struct	TRegisterReply

struct	TLookupRequest

struct	TLookupReply

struct	TLookupBuffer

struct	OTLink

struct	OTLIFO

struct	OTList

Macros
#define	OTKERNEL 0

#define	OTUNIXERRORS 0

#define	OTDEBUG 0

#define	OTCARBONAPPLICATION 0

#define	_MDECL

#define	kOTLibraryVersion "1.1"

#define	kOTLibraryPrefix "OTLib$"

#define	kOTModulePrefix "OTModl$"

#define	kOTClientPrefix "OTClnt$"

#define	kOTKernelPrefix "OTKrnl$"

#define	OTOffsetOf(structure, field) ((ByteCount) & ((structure *)0)->field)

#define	kOTFatalErr "FB "

#define	kOTNonfatalErr "NB "

#define	kOTExtFatalErr "FX "

#define	kOTExtNonfatalErr "NX "

#define	kOTUserFatalErr "UF "

#define	kOTUserErr "UE "

#define	kOTUserNonfatalErr "UE "

#define	kOTInfoErr "IE "

#define	kOTInfoBreak "IN "

#define	OTDebugBreak(str)

#define	OTDebugTest(val, str)

#define	OTAssert(name, cond)

#define	OTDebugBreak2(str)

#define	OTDebugTest2(val, str)

#define	XTI2OSStatus(x) (-3149 - (x))

#define	E2OSStatus(x) (-3199 - (x))

#define	OSStatus2XTI(x) ((OTXTIErr)(-3149 - (x)))

#define	OSStatus2E(x) ((OTUnixErr)(-3199 - (x)))

#define	IsXTIError(x) ((x) < -3149 && (x) >= (-3149 - TLASTXTIERROR))

#define	IsEError(x) ((x) < -3199 && (x) >= (-3199 - ELASTERRNO))

#define	kOTInvalidRef 0L

#define	kOTInvalidProviderRef ((ProviderRef)0L)

#define	kOTInvalidEndpointRef ((EndpointRef)0L)

#define	kOTInvalidMapperRef ((MapperRef)0L)

#define	IsOTPrivateEvent(x) (((x) & 0x70000000L) == kPRIVATEEVENT)

#define	IsOTCompleteEvent(x) (((x) & 0x7f000000L) == kCOMPLETEEVENT)

#define	IsOTProtocolEvent(x) (((x) & 0x7f000000L) == kPROTOCOLEVENT)

#define	IsOTStreamEvent(x) (((x) & 0x7f000000L) == kSTREAMEVENT)

#define	IsOTSignalEvent(x) (((x) & 0x7f000000L) == kSIGNALEVENT)

#define	GetOTEventCode(x) (x)

#define	NewOTNotifyUPP(userRoutine) (userRoutine)

#define	DisposeOTNotifyUPP(userUPP)

#define	InvokeOTNotifyUPP(contextPtr, code, result, cookie, userUPP) (*userUPP)(contextPtr, code, result, cookie)

#define	MIOC_CMD(t, v) ((((t) & 0xFF) << 8) \| ((v) & 0xFF))

#define	kOTNoMemoryConfigurationPtr ((OTConfigurationRef)0L)

#define	kOTInvalidConfigurationPtr ((OTConfigurationRef)-1L)

#define	T_ALIGN(len) (((UInt32)(len) + (sizeof(SInt32) - 1)) & ~(sizeof(SInt32) - 1))

#define	OPT_NEXTHDR(theBuffer, theBufLen, prevOption)

#define	OTCreateNuBusPortRef(devType, slot, other) OTCreatePortRef(kOTNuBus, devType, slot, other)

#define	OTCreatePCIPortRef(devType, slot, other) OTCreatePortRef(kOTPCIBus, devType, slot, other)

#define	OTCreatePCCardPortRef(devType, slot, other) OTCreatePortRef(kOTPCCardBus, devType, slot, other)

#define	OTInitBufferInfo(infoPtr, theBuffer)

#define	OTNextLookupBuffer(buf)

#define	NewOTProcessUPP(userRoutine) (userRoutine)

#define	DisposeOTProcessUPP(userUPP)

#define	InvokeOTProcessUPP(arg, userUPP) (*userUPP)(arg)

#define	OTIsNonBlocking(ref) (!OTIsBlocking(ref))

#define	OTIsAsynchronous(ref) (!OTIsSynchronous(ref))

#define	OTGetLinkObject(link, struc, field) ((struc )((char )(link)-OTOffsetOf(struc, field)))

#define	NewOTListSearchUPP(userRoutine) (userRoutine)

#define	DisposeOTListSearchUPP(userUPP)

#define	InvokeOTListSearchUPP(ref, linkToCheck, userUPP) (*userUPP)(ref, linkToCheck)

#define	OTClearLock(lockPtr) *(lockPtr) = 0

#define	OTAcquireLock(lockPtr) (OTAtomicSetBit(lockPtr, 0) == 0)

Typedefs
typedef UInt8	OTUInt8Param

typedef UInt16	OTUInt16Param

typedef SInt16	OTSInt16Param

typedef SInt8	OTSInt8Param

typedef Boolean	OTBooleanParam

typedef unsigned int	OTByteCount

typedef unsigned int	OTItemCount

typedef int	OTInt32

typedef unsigned int	OTUInt32

typedef UInt32	OTTimeout

typedef SInt32	OTSequence

typedef SInt32	OTNameID

typedef SInt32	OTReason

typedef UInt32	OTQLen

typedef UInt8 *	OTClientName

typedef SInt32	OTCommand

typedef struct OpaqueOTClient *	OTClient

typedef UInt32	OTOpenFlags

typedef UInt16	OTUnixErr

typedef UInt16	OTXTIErr

typedef SInt32	OTResult

typedef UInt16	OTAddressType

typedef struct OTAddress	OTAddress

typedef UInt32	OTStructType

typedef UInt32	OTFieldsType

typedef UInt32	OTFlags

typedef UInt32	OTBand

typedef void *	ProviderRef

typedef void *	EndpointRef

typedef void *	MapperRef

typedef UInt32	OTEventCode

typedef OTEventCode	code

typedef OTEventCode OTResult	result

typedef OTEventCode OTResult void *	cookie

typedef UInt32	OTXTILevel

typedef UInt32	OTXTIName

typedef struct OTScriptInfo	OTScriptInfo

typedef UInt32	OTXTIStates

typedef struct OTConfiguration *	OTConfigurationRef

typedef struct TOptionHeader	TOptionHeader

typedef struct TOption	TOption

typedef struct t_kpalive	t_kpalive

typedef struct t_linger	t_linger

typedef UInt32	OTServiceType

typedef SInt32	OTDataSize

typedef struct TEndpointInfo	TEndpointInfo

typedef UInt32	OTPortRef

typedef OTPortRef *	OTPortRefPtr

typedef UInt8	OTBusType

typedef UInt16	OTDeviceType

typedef UInt16	OTSlotNumber

typedef struct OTPortRecord	OTPortRecord

typedef struct TNetbuf	TNetbuf

typedef struct strbuf	strbuf

typedef struct OTData	OTData

typedef struct OTBuffer	OTBuffer

typedef struct OTBufferInfo	OTBufferInfo

typedef struct TBind	TBind

typedef struct TDiscon	TDiscon

typedef struct TCall	TCall

typedef struct TUnitData	TUnitData

typedef struct TUDErr	TUDErr

typedef struct TOptMgmt	TOptMgmt

typedef struct TRequest	TRequest

typedef struct TReply	TReply

typedef struct TUnitRequest	TUnitRequest

typedef struct TUnitReply	TUnitReply

typedef struct TRegisterRequest	TRegisterRequest

typedef struct TRegisterReply	TRegisterReply

typedef struct TLookupRequest	TLookupRequest

typedef struct TLookupReply	TLookupReply

typedef struct TLookupBuffer	TLookupBuffer

typedef struct OpaqueOTClientContextPtr *	OTClientContextPtr

typedef UInt32	OTInitializationFlags

typedef long	OTDeferredTaskRef

typedef long	OTSystemTaskRef

typedef UnsignedWide	OTTimeStamp

typedef struct OTLink	OTLink

typedef struct OTLIFO	OTLIFO

typedef OTLink *	linkToCheck

typedef struct OTList	OTList

typedef UInt8	OTLock

Enumerations
enum	{ kOTCFMClass = FOUR_CHAR_CODE('otan') }

enum	{ kO_ASYNC = 0x01 , kO_NDELAY = 0x04 , kO_NONBLOCK = 0x04 }

enum	{ O_ASYNC = kO_ASYNC , O_NDELAY = kO_NDELAY , O_NONBLOCK = kO_NONBLOCK }

enum	{ TSUCCESS = 0 , TBADADDR = 1 , TBADOPT = 2 , TACCES = 3 , TBADF = 4 , TNOADDR = 5 , TOUTSTATE = 6 , TBADSEQ = 7 , TSYSERR = 8 , TLOOK = 9 , TBADDATA = 10 , TBUFOVFLW = 11 , TFLOW = 12 , TNODATA = 13 , TNODIS = 14 , TNOUDERR = 15 , TBADFLAG = 16 , TNOREL = 17 , TNOTSUPPORT = 18 , TSTATECHNG = 19 , TNOSTRUCTYPE = 20 , TBADNAME = 21 , TBADQLEN = 22 , TADDRBUSY = 23 , TINDOUT = 24 , TPROVMISMATCH = 25 , TRESQLEN = 26 , TRESADDR = 27 , TQFULL = 28 , TPROTO = 29 , TBADSYNC = 30 , TCANCELED = 31 , TLASTXTIERROR = 31 }

enum	{ kOTGenericName = 0 }

enum	{ T_BIND = 1 , T_OPTMGMT = 2 , T_CALL = 3 , T_DIS = 4 , T_UNITDATA = 5 , T_UDERROR = 6 , T_INFO = 7 , T_REPLYDATA = 8 , T_REQUESTDATA = 9 , T_UNITREQUEST = 10 , T_UNITREPLY = 11 }

enum	{ T_ADDR = 0x01 , T_OPT = 0x02 , T_UDATA = 0x04 , T_ALL = 0xFFFF }

enum	{ T_MORE = 0x0001 , T_EXPEDITED = 0x0002 , T_ACKNOWLEDGED = 0x0004 , T_PARTIALDATA = 0x0008 , T_NORECEIPT = 0x0010 , T_TIMEDOUT = 0x0020 }

enum	{ T_NEGOTIATE = 0x0004 , T_CHECK = 0x0008 , T_DEFAULT = 0x0010 , T_CURRENT = 0x0080 }

enum	{ T_SUCCESS = 0x0020 , T_FAILURE = 0x0040 , T_PARTSUCCESS = 0x0100 , T_READONLY = 0x0200 , T_NOTSUPPORT = 0x0400 }

enum	{ T_LISTEN = 0x0001 , T_CONNECT = 0x0002 , T_DATA = 0x0004 , T_EXDATA = 0x0008 , T_DISCONNECT = 0x0010 , T_ERROR = 0x0020 , T_UDERR = 0x0040 , T_ORDREL = 0x0080 , T_GODATA = 0x0100 , T_GOEXDATA = 0x0200 , T_REQUEST = 0x0400 , T_REPLY = 0x0800 , T_PASSCON = 0x1000 , T_RESET = 0x2000 , kPRIVATEEVENT = 0x10000000 , kCOMPLETEEVENT = 0x20000000 , T_BINDCOMPLETE = 0x20000001 , T_UNBINDCOMPLETE = 0x20000002 , T_ACCEPTCOMPLETE = 0x20000003 , T_REPLYCOMPLETE = 0x20000004 , T_DISCONNECTCOMPLETE = 0x20000005 , T_OPTMGMTCOMPLETE = 0x20000006 , T_OPENCOMPLETE = 0x20000007 , T_GETPROTADDRCOMPLETE = 0x20000008 , T_RESOLVEADDRCOMPLETE = 0x20000009 , T_GETINFOCOMPLETE = 0x2000000A , T_SYNCCOMPLETE = 0x2000000B , T_MEMORYRELEASED = 0x2000000C , T_REGNAMECOMPLETE = 0x2000000D , T_DELNAMECOMPLETE = 0x2000000E , T_LKUPNAMECOMPLETE = 0x2000000F , T_LKUPNAMERESULT = 0x20000010 , kOTSyncIdleEvent = 0x20000011 , kSTREAMEVENT = 0x21000000 , kOTReservedEvent1 = 0x21000001 , kGetmsgEvent = 0x21000002 , kStreamReadEvent = 0x21000003 , kStreamWriteEvent = 0x21000004 , kStreamIoctlEvent = 0x21000005 , kOTReservedEvent2 = 0x21000006 , kStreamOpenEvent = 0x21000007 , kPollEvent = 0x21000008 , kOTReservedEvent3 = 0x21000009 , kOTReservedEvent4 = 0x2100000A , kOTReservedEvent5 = 0x2100000B , kOTReservedEvent6 = 0x2100000C , kOTReservedEvent7 = 0x2100000D , kOTReservedEvent8 = 0x2100000E , kSIGNALEVENT = 0x22000000 , kPROTOCOLEVENT = 0x23000000 , kOTProviderIsDisconnected = 0x23000001 , kOTProviderIsReconnected = 0x23000002 , kOTProviderWillClose = 0x24000001 , kOTProviderIsClosed = 0x24000002 , kOTPortDisabled , kOTPortEnabled , kOTPortOffline , kOTPortOnline , kOTClosePortRequest = 0x25000005 , kOTYieldPortRequest = 0x25000005 , kOTNewPortRegistered , kOTPortNetworkChange = 0x25000007 , kOTConfigurationChanged = 0x26000001 , kOTSystemSleep = 0x26000002 , kOTSystemShutdown = 0x26000003 , kOTSystemAwaken = 0x26000004 , kOTSystemIdle = 0x26000005 , kOTSystemSleepPrep = 0x26000006 , kOTSystemShutdownPrep = 0x26000007 , kOTSystemAwakenPrep = 0x26000008 , kOTStackIsLoading = 0x27000001 , kOTStackWasLoaded , kOTStackIsUnloading }

enum	{ kSIGHUP = 1 , kSIGURG = 16 , kSIGPOLL = 30 }

enum	{ SIGHUP = kSIGHUP , SIGURG = kSIGURG , SIGPOLL = kSIGPOLL }

enum	{ uppOTNotifyProcInfo = 0x00003FC0 }

enum	{ XTI_GENERIC = 0xFFFF }

enum	{ XTI_DEBUG = 0x0001 , XTI_LINGER = 0x0080 , XTI_RCVBUF = 0x1002 , XTI_RCVLOWAT = 0x1004 , XTI_SNDBUF = 0x1001 , XTI_SNDLOWAT = 0x1003 , XTI_PROTOTYPE = 0x1005 , OPT_CHECKSUM = 0x0600 , OPT_RETRYCNT = 0x0601 , OPT_INTERVAL = 0x0602 , OPT_ENABLEEOM = 0x0603 , OPT_SELFSEND , OPT_SERVERSTATUS = 0x0605 , OPT_ALERTENABLE = 0x0606 , OPT_KEEPALIVE = 0x0008 }

enum	{ MIOC_STREAMIO = 'A' , MIOC_TMOD = 'a' , MIOC_STRLOG = 'b' , MIOC_ND = 'c' , MIOC_ECHO = 'd' , MIOC_TLI = 'e' , MIOC_RESERVEDf = 'f' , MIOC_SAD = 'g' , MIOC_ARP = 'h' , MIOC_HAVOC = 'H' , MIOC_RESERVEDi = 'i' , MIOC_SIOC = 'j' , MIOC_TCP = 'k' , MIOC_DLPI = 'l' , MIOC_SOCKETS = 'm' , MIOC_IPX = 'o' , MIOC_OT = 'O' , MIOC_ATALK = 'T' , MIOC_SRL = 'U' , MIOC_RESERVEDp = 'p' , MIOC_RESERVEDr = 'r' , MIOC_RESERVEDs = 's' , MIOC_CFIG = 'z' }

enum	{ I_OTGetMiscellaneousEvents , I_OTSetFramingType = ((MIOC_OT << 8) \| 2) , kOTGetFramingValue , I_OTSetRawMode = ((MIOC_OT << 8) \| 3) , kOTSetRecvMode = 0x01 , kOTSendErrorPacket = 0x02 , I_OTConnect = ((MIOC_OT << 8) \| 4) , I_OTDisconnect , I_OTScript = ((MIOC_OT << 8) \| 6) }

enum	{ T_UNINIT = 0 , T_UNBND = 1 , T_IDLE = 2 , T_OUTCON = 3 , T_INCON = 4 , T_DATAXFER = 5 , T_OUTREL = 6 , T_INREL = 7 }

enum	{ T_YES = 1 , T_NO = 0 , T_UNUSED = (unsigned long)(-1) , kT_NULL = 0 , T_ABSREQ = 0x8000 }

enum	{ kT_UNSPEC = (unsigned long)0xFFFFFFFD , T_ALLOPT = 0 }

enum	{ T_NULL = kT_NULL , T_UNSPEC = kT_UNSPEC }

enum	{ kOTOptionHeaderSize = sizeof(TOptionHeader) , kOTBooleanOptionDataSize = sizeof(UInt32) , kOTBooleanOptionSize = kOTOptionHeaderSize + kOTBooleanOptionDataSize , kOTOneByteOptionSize = kOTOptionHeaderSize + 1 , kOTTwoByteOptionSize = kOTOptionHeaderSize + 2 , kOTFourByteOptionSize = kOTOptionHeaderSize + sizeof(UInt32) }

enum	{ T_COTS = 1 , T_COTS_ORD = 2 , T_CLTS = 3 , T_TRANS = 5 , T_TRANS_ORD = 6 , T_TRANS_CLTS = 7 }

enum	{ T_SENDZERO = 0x0001 , T_XPG4_1 = 0x0002 , T_CAN_SUPPORT_MDATA = 0x10000000 , T_CAN_RESOLVE_ADDR = 0x40000000 , T_CAN_SUPPLY_MIB = 0x20000000 }

enum	{ T_INFINITE = -1 , T_INVALID = -2 }

enum	{ kOTInvalidPortRef = 0 }

enum	{ kOTUnknownBusPort = 0 , kOTMotherboardBus = 1 , kOTNuBus = 2 , kOTPCIBus = 3 , kOTGeoPort = 4 , kOTPCCardBus = 5 , kOTFireWireBus = 6 , kOTLastBusIndex = 15 }

enum	{ kOTNoDeviceType = 0 , kOTADEVDevice = 1 , kOTMDEVDevice = 2 , kOTLocalTalkDevice = 3 , kOTIRTalkDevice = 4 , kOTTokenRingDevice = 5 , kOTISDNDevice = 6 , kOTATMDevice = 7 , kOTSMDSDevice = 8 , kOTSerialDevice = 9 , kOTEthernetDevice = 10 , kOTSLIPDevice = 11 , kOTPPPDevice = 12 , kOTModemDevice = 13 , kOTFastEthernetDevice = 14 , kOTFDDIDevice = 15 , kOTIrDADevice = 16 , kOTATMSNAPDevice = 17 , kOTFibreChannelDevice = 18 , kOTFireWireDevice = 19 , kOTPseudoDevice = 1023 , kOTLastDeviceIndex = 1022 }

enum	{ kOTLastSlotNumber = 255 , kOTLastOtherNumber = 255 }

enum	{ kMaxModuleNameLength = 31 , kMaxModuleNameSize = kMaxModuleNameLength + 1 , kMaxProviderNameLength , kMaxProviderNameSize = kMaxProviderNameLength + 1 , kMaxSlotIDLength = 7 , kMaxSlotIDSize = kMaxSlotIDLength + 1 , kMaxResourceInfoLength = 31 , kMaxResourceInfoSize = 32 , kMaxPortNameLength , kMaxPortNameSize = kMaxPortNameLength + 1 }

enum	{ kOTPortIsActive = 0x00000001 , kOTPortIsDisabled = 0x00000002 , kOTPortIsUnavailable = 0x00000004 , kOTPortIsOffline = 0x00000008 }

enum	{ kOTPortIsDLPI = 0x00000001 , kOTPortIsTPI = 0x00000002 , kOTPortCanYield , kOTPortCanArbitrate , kOTPortIsTransitory = 0x00000010 , kOTPortAutoConnects = 0x00000020 , kOTPortIsSystemRegistered = 0x00004000 , kOTPortIsPrivate = 0x00008000 , kOTPortIsAlias = (unsigned long)0x80000000 }

enum	{ kNetbufDataIsOTData = (unsigned long)0xFFFFFFFE }

enum	{ kOTNetbufDataIsOTBufferStar = (unsigned long)0xFFFFFFFD }

enum	{ kOTNetbufIsRawMode = (unsigned long)0xFFFFFFFF }

enum	{ kInitOTForApplicationMask = 1 , kInitOTForExtensionMask = 2 }

enum	{ uppOTProcessProcInfo = 0x000000C0 }

enum	{ uppOTListSearchProcInfo = 0x000003D1 }

Functions
void	OTDebugStr (const char *str)

typedef	CALLBACK_API (void, OTNotifyProcPtr)(void *contextPtr

typedef	TVECTOR_UPP_TYPE (OTNotifyProcPtr) OTNotifyUPP

OTNotifyUPP	NewOTNotifyUPP (OTNotifyProcPtr userRoutine)

void	DisposeOTNotifyUPP (OTNotifyUPP userUPP)

void	InvokeOTNotifyUPP (void contextPtr, OTEventCode code, OTResult result, void cookie, OTNotifyUPP userUPP)

OTPortRef	OTCreatePortRef (OTBusType busType, OTDeviceType devType, OTSlotNumber slot, UInt16 other)

OTDeviceType	OTGetDeviceTypeFromPortRef (OTPortRef ref)

UInt16	OTGetBusTypeFromPortRef (OTPortRef ref)

OTSlotNumber	OTGetSlotFromPortRef (OTPortRef ref, UInt16 *other)

OTPortRef	OTSetDeviceTypeInPortRef (OTPortRef ref, OTDeviceType devType)

OTPortRef	OTSetBusTypeInPortRef (OTPortRef ref, OTBusType busType)

Boolean	OTGetIndexedPort (OTPortRecord *portRecord, OTItemCount index)

Boolean	OTFindPort (OTPortRecord portRecord, const char portName)

Boolean	OTFindPortByRef (OTPortRecord *portRecord, OTPortRef ref)

OSStatus	OTRegisterPort (OTPortRecord portRecord, void ref)

OSStatus	OTUnregisterPort (const char portName, void *ref)

OSStatus	OTChangePortState (OTPortRef portRef, OTEventCode theChange, OTResult why)

OSStatus	InitOpenTransportInContext (OTInitializationFlags flags, OTClientContextPtr *outClientContext)

void	CloseOpenTransportInContext (OTClientContextPtr clientContext)

OSStatus	InitOpenTransport (void)

OSStatus	InitOpenTransportUtilities (void)

void	CloseOpenTransport (void)

OSStatus	OTRegisterAsClient (OTClientName name, OTNotifyUPP proc)

OSStatus	OTUnregisterAsClient (void)

OSStatus	OTRegisterAsClientInContext (OTClientName name, OTNotifyUPP proc, OTClientContextPtr clientContext)

OSStatus	OTUnregisterAsClientInContext (OTClientContextPtr clientContext)

void	OTEnterInterrupt (void)

void	OTLeaveInterrupt (void)

Boolean	OTIsAtInterruptLevel (void)

Boolean	OTCanLoadLibraries (void)

typedef	CALLBACK_API (void, OTProcessProcPtr)(void *arg)

typedef	TVECTOR_UPP_TYPE (OTProcessProcPtr) OTProcessUPP

OTProcessUPP	NewOTProcessUPP (OTProcessProcPtr userRoutine)

void	DisposeOTProcessUPP (OTProcessUPP userUPP)

void	InvokeOTProcessUPP (void *arg, OTProcessUPP userUPP)

long	OTCreateDeferredTaskInContext (OTProcessUPP upp, void *arg, OTClientContextPtr clientContext)

OTDeferredTaskRef	OTCreateDeferredTask (OTProcessUPP proc, void *arg)

Boolean	OTScheduleDeferredTask (OTDeferredTaskRef dtCookie)

Boolean	OTScheduleInterruptTask (OTDeferredTaskRef dtCookie)

OSStatus	OTDestroyDeferredTask (OTDeferredTaskRef dtCookie)

OTSystemTaskRef	OTCreateSystemTask (OTProcessUPP proc, void *arg)

OSStatus	OTDestroySystemTask (OTSystemTaskRef stCookie)

Boolean	OTScheduleSystemTask (OTSystemTaskRef stCookie)

Boolean	OTCancelSystemTask (OTSystemTaskRef stCookie)

Boolean	OTCanMakeSyncCall (void)

OSStatus	OTAsyncOpenProvider (OTConfigurationRef cfig, OTOpenFlags flags, OTNotifyUPP proc, void *contextPtr)

ProviderRef	OTOpenProvider (OTConfigurationRef cfig, OTOpenFlags flags, OSStatus *errPtr)

OSStatus	OTCloseProvider (ProviderRef ref)

ProviderRef	OTTransferProviderOwnership (ProviderRef ref, OTClient prevOwner, OSStatus *errPtr)

OTClient	OTWhoAmI (void)

OTPortRef	OTGetProviderPortRef (ProviderRef ref)

SInt32	OTIoctl (ProviderRef ref, UInt32 cmd, void *data)

OTResult	OTGetMessage (ProviderRef ref, strbuf ctlbuf, strbuf databuf, OTFlags *flagsPtr)

OTResult	OTGetPriorityMessage (ProviderRef ref, strbuf ctlbuf, strbuf databuf, OTBand bandPtr, OTFlags flagsPtr)

OSStatus	OTPutMessage (ProviderRef ref, const strbuf ctlbuf, const strbuf databuf, OTFlags flags)

OSStatus	OTPutPriorityMessage (ProviderRef ref, const strbuf ctlbuf, const strbuf databuf, OTBand band, OTFlags flags)

OSStatus	OTSetAsynchronous (ProviderRef ref)

OSStatus	OTSetSynchronous (ProviderRef ref)

Boolean	OTIsSynchronous (ProviderRef ref)

OSStatus	OTSetBlocking (ProviderRef ref)

OSStatus	OTSetNonBlocking (ProviderRef ref)

Boolean	OTIsBlocking (ProviderRef ref)

OSStatus	OTInstallNotifier (ProviderRef ref, OTNotifyUPP proc, void *contextPtr)

OSStatus	OTUseSyncIdleEvents (ProviderRef ref, Boolean useEvents)

void	OTRemoveNotifier (ProviderRef ref)

void	OTLeaveNotifier (ProviderRef ref)

Boolean	OTEnterNotifier (ProviderRef ref)

OSStatus	OTAckSends (ProviderRef ref)

OSStatus	OTDontAckSends (ProviderRef ref)

Boolean	OTIsAckingSends (ProviderRef ref)

OSStatus	OTCancelSynchronousCalls (ProviderRef ref, OSStatus err)

EndpointRef	OTOpenEndpointInContext (OTConfigurationRef config, OTOpenFlags oflag, TEndpointInfo info, OSStatus err, OTClientContextPtr clientContext)

OSStatus	OTAsyncOpenEndpointInContext (OTConfigurationRef config, OTOpenFlags oflag, TEndpointInfo info, OTNotifyUPP upp, void contextPtr, OTClientContextPtr clientContext)

EndpointRef	OTOpenEndpoint (OTConfigurationRef cfig, OTOpenFlags oflag, TEndpointInfo info, OSStatus err)

OSStatus	OTAsyncOpenEndpoint (OTConfigurationRef cfig, OTOpenFlags oflag, TEndpointInfo info, OTNotifyUPP proc, void contextPtr)

OSStatus	OTGetEndpointInfo (EndpointRef ref, TEndpointInfo *info)

OTResult	OTGetEndpointState (EndpointRef ref)

OTResult	OTLook (EndpointRef ref)

OTResult	OTSync (EndpointRef ref)

OTResult	OTCountDataBytes (EndpointRef ref, OTByteCount *countPtr)

OSStatus	OTGetProtAddress (EndpointRef ref, TBind boundAddr, TBind peerAddr)

OSStatus	OTResolveAddress (EndpointRef ref, TBind reqAddr, TBind retAddr, OTTimeout timeOut)

void *	OTAllocInContext (EndpointRef ref, OTStructType structType, UInt32 fields, OSStatus *err, OTClientContextPtr clientContext)

void *	OTAlloc (EndpointRef ref, OTStructType structType, OTFieldsType fields, OSStatus *err)

OTResult	OTFree (void *ptr, OTStructType structType)

OSStatus	OTOptionManagement (EndpointRef ref, TOptMgmt req, TOptMgmt ret)

OSStatus	OTCreateOptions (const char endPtName, char strPtr, TNetbuf buf)

OSStatus	OTCreateOptionString (const char endPtName, TOption opt, void bufEnd, char *str, OTByteCount stringSize)

OSStatus	OTNextOption (UInt8 buffer, UInt32 buflen, TOption *prevOptPtr)

TOption *	OTFindOption (UInt8 *buffer, UInt32 buflen, OTXTILevel level, OTXTIName name)

OSStatus	OTBind (EndpointRef ref, TBind reqAddr, TBind retAddr)

OSStatus	OTUnbind (EndpointRef ref)

OSStatus	OTConnect (EndpointRef ref, TCall sndCall, TCall rcvCall)

OSStatus	OTRcvConnect (EndpointRef ref, TCall *call)

OSStatus	OTListen (EndpointRef ref, TCall *call)

OSStatus	OTAccept (EndpointRef listener, EndpointRef worker, TCall *call)

OSStatus	OTSndDisconnect (EndpointRef ref, TCall *call)

OSStatus	OTSndOrderlyDisconnect (EndpointRef ref)

OSStatus	OTRcvDisconnect (EndpointRef ref, TDiscon *discon)

OSStatus	OTRcvOrderlyDisconnect (EndpointRef ref)

OTResult	OTRcv (EndpointRef ref, void buf, OTByteCount nbytes, OTFlags flags)

OTResult	OTSnd (EndpointRef ref, void *buf, OTByteCount nbytes, OTFlags flags)

OSStatus	OTSndUData (EndpointRef ref, TUnitData *udata)

OSStatus	OTRcvUData (EndpointRef ref, TUnitData udata, OTFlags flags)

OSStatus	OTRcvUDErr (EndpointRef ref, TUDErr *uderr)

OSStatus	OTSndRequest (EndpointRef ref, TRequest *req, OTFlags reqFlags)

OSStatus	OTRcvReply (EndpointRef ref, TReply reply, OTFlags replyFlags)

OSStatus	OTSndReply (EndpointRef ref, TReply *reply, OTFlags replyFlags)

OSStatus	OTRcvRequest (EndpointRef ref, TRequest req, OTFlags reqFlags)

OSStatus	OTCancelRequest (EndpointRef ref, OTSequence sequence)

OSStatus	OTCancelReply (EndpointRef ref, OTSequence sequence)

OSStatus	OTSndURequest (EndpointRef ref, TUnitRequest *req, OTFlags reqFlags)

OSStatus	OTRcvUReply (EndpointRef ref, TUnitReply reply, OTFlags replyFlags)

OSStatus	OTSndUReply (EndpointRef ref, TUnitReply *reply, OTFlags replyFlags)

OSStatus	OTRcvURequest (EndpointRef ref, TUnitRequest req, OTFlags reqFlags)

OSStatus	OTCancelURequest (EndpointRef ref, OTSequence seq)

OSStatus	OTCancelUReply (EndpointRef ref, OTSequence seq)

OSStatus	OTAsyncOpenMapperInContext (OTConfigurationRef config, OTOpenFlags oflag, OTNotifyUPP upp, void *contextPtr, OTClientContextPtr clientContext)

MapperRef	OTOpenMapperInContext (OTConfigurationRef config, OTOpenFlags oflag, OSStatus *err, OTClientContextPtr clientContext)

OSStatus	OTAsyncOpenMapper (OTConfigurationRef cfig, OTOpenFlags oflag, OTNotifyUPP proc, void *contextPtr)

MapperRef	OTOpenMapper (OTConfigurationRef cfig, OTOpenFlags oflag, OSStatus *err)

OSStatus	OTRegisterName (MapperRef ref, TRegisterRequest req, TRegisterReply reply)

OSStatus	OTDeleteName (MapperRef ref, TNetbuf *name)

OSStatus	OTDeleteNameByID (MapperRef ref, OTNameID nameID)

OSStatus	OTLookupName (MapperRef ref, TLookupRequest req, TLookupReply reply)

OTConfigurationRef	OTCreateConfiguration (const char *path)

OTConfigurationRef	OTCloneConfiguration (OTConfigurationRef cfig)

void	OTDestroyConfiguration (OTConfigurationRef cfig)

void *	OTAllocMemInContext (OTByteCount size, OTClientContextPtr clientContext)

void *	OTAllocMem (OTByteCount size)

void	OTFreeMem (void *mem)

void	OTDelay (UInt32 seconds)

void	OTIdle (void)

void	OTMemcpy (void dest, const void src, OTByteCount nBytes)

Boolean	OTMemcmp (const void mem1, const void mem2, OTByteCount nBytes)

void	OTMemmove (void dest, const void src, OTByteCount nBytes)

void	OTMemzero (void *dest, OTByteCount nBytes)

void	OTMemset (void *dest, OTUInt8Param toSet, OTByteCount nBytes)

OTByteCount	OTStrLength (const char *str)

void	OTStrCopy (char dest, const char src)

void	OTStrCat (char dest, const char src)

Boolean	OTStrEqual (const char src1, const char src2)

void	OTGetTimeStamp (OTTimeStamp *currentTime)

OTTimeStamp *	OTSubtractTimeStamps (OTTimeStamp result, OTTimeStamp startTime, OTTimeStamp *endEnd)

UInt32	OTTimeStampInMilliseconds (OTTimeStamp *delta)

UInt32	OTTimeStampInMicroseconds (OTTimeStamp *delta)

UInt32	OTElapsedMilliseconds (OTTimeStamp *startTime)

UInt32	OTElapsedMicroseconds (OTTimeStamp *startTime)

UInt32	OTGetClockTimeInSecs (void)

void	OTLIFOEnqueue (OTLIFO list, OTLink link)

OTLink *	OTLIFODequeue (OTLIFO *list)

OTLink *	OTLIFOStealList (OTLIFO *list)

OTLink *	OTReverseList (OTLink *list)

typedef	CALLBACK_API_C (Boolean, OTListSearchProcPtr)(const void *ref

typedef	TVECTOR_UPP_TYPE (OTListSearchProcPtr) OTListSearchUPP

OTListSearchUPP	NewOTListSearchUPP (OTListSearchProcPtr userRoutine)

void	DisposeOTListSearchUPP (OTListSearchUPP userUPP)

Boolean	InvokeOTListSearchUPP (const void ref, OTLink linkToCheck, OTListSearchUPP userUPP)

void	OTAddFirst (OTList list, OTLink link)

void	OTAddLast (OTList list, OTLink link)

OTLink *	OTRemoveFirst (OTList *list)

OTLink *	OTRemoveLast (OTList *list)

OTLink *	OTGetFirst (OTList *list)

OTLink *	OTGetLast (OTList *list)

Boolean	OTIsInList (OTList list, OTLink link)

OTLink *	OTFindLink (OTList list, OTListSearchUPP proc, const void ref)

Boolean	OTRemoveLink (OTList list, OTLink link)

OTLink *	OTFindAndRemoveLink (OTList list, OTListSearchUPP proc, const void ref)

OTLink *	OTGetIndexedLink (OTList *list, OTItemCount index)

void	OTEnqueue (void *listHead, void object, OTByteCount linkOffset)

void *	OTDequeue (void **listHead, OTByteCount linkOffset)

Boolean	OTAtomicSetBit (UInt8 *bytePtr, OTByteCount bitNumber)

Boolean	OTAtomicClearBit (UInt8 *bytePtr, OTByteCount bitNumber)

Boolean	OTAtomicTestBit (UInt8 *bytePtr, OTByteCount bitNumber)

Boolean	OTCompareAndSwapPtr (void oldValue, void newValue, void **dest)

Boolean	OTCompareAndSwap32 (UInt32 oldValue, UInt32 newValue, UInt32 *dest)

Boolean	OTCompareAndSwap16 (UInt32 oldValue, UInt32 newValue, UInt16 *dest)

Boolean	OTCompareAndSwap8 (UInt32 oldValue, UInt32 newValue, UInt8 *dest)

SInt32	OTAtomicAdd32 (SInt32 toAdd, SInt32 *dest)

SInt16	OTAtomicAdd16 (SInt32 toAdd, SInt16 *dest)

SInt8	OTAtomicAdd8 (SInt32 toAdd, SInt8 *dest)

Detailed Description

Open Transport client interface file. This contains all the client APIs.

Introduced In: Open Transport 2.5

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 1985-2001 by Apple Computer, Inc., all rights reserved

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ _MDECL

#define _MDECL

Setup _MDECL to be _cdecl when compiling C++ code with compilers that support it, or nothing otherwise.

◆ MIOC_CMD

#define MIOC_CMD	(	t,
		v
	)	((((t) & 0xFF) << 8) \| ((v) & 0xFF))

All OT ioctl numbers are formed using the MIOC_CMD macro, which divides the ioctl space by protocol space (the first parameter) and ioctl number within that protocol space (the second parameter). This macro is only available to C users but it's relatively easy to synthesise its results in other languages.

◆ OPT_NEXTHDR

#define OPT_NEXTHDR	(	theBuffer,
		theBufLen,
		prevOption
	)

Value:

  (((char *)(prevOption) + T_ALIGN((prevOption)->len) <                 \
    (char *)(theBuffer) + (theBufLen))                                  \
       ? (TOption *)((char *)(prevOption) + T_ALIGN((prevOption)->len)) \
       : (TOption *)NULL)

This macro will return the next option in the buffer, given the previous option in the buffer, returning NULL if there are no more. You start off by setting prevOption = (TOption*)theBuffer (Use OTNextOption for a more thorough check - it ensures the end of the option is in the buffer as well.)

◆ OTCreateNuBusPortRef

#define OTCreateNuBusPortRef	(	devType,
		slot,
		other
	)	OTCreatePortRef(kOTNuBus, devType, slot, other)

Convenience macros for generating specific types of OTPortRefs.

◆ OTDEBUG

#define OTDEBUG 0

OTDEBUG is used to control the behaviour of the OT debugging macros. If you set it to non-zero, the macros will generate code that drops you into the debugger. If you set it to 0, or leave it undefined, the macros are compiled out. Setting up this compiler variable is a little tricky because previous versions of the OT interfaces used a different variable, qDebug. We replaced qDebug with OTDEBUG because qDebug does not fit into the OT namespace. But I didn't want to break a lot of currently building code. The following tricky compiler variable footwork avoids this. There are four outcomes when this code is compiled, depending on whether qDebug and OTDEBUG are defined beforehand. The following table shows the outcome in each case. qDebug OTDEBUG Outcome Explanation

defined defined OTDEBUG wins Mixed legacy and new code, we believe the new code. defined undefined qDebug wins Legacy code. undefined defined OTDEBUG wins New code. undefined undefined no debugging No debugging.

◆ OTGetLinkObject

#define OTGetLinkObject	(	link,
		struc,
		field
	)	((struc )((char )(link)-OTOffsetOf(struc, field)))

You can use this macro to map from an OTLink field to the structure in which it's embedded.

◆ OTInitBufferInfo

#define OTInitBufferInfo	(	infoPtr,
		theBuffer
	)

Value:

  (infoPtr)->fBuffer = theBuffer;            \
  (infoPtr)->fPad = (theBuffer)->fPad1;      \
  (infoPtr)->fOffset = 0

◆ OTKERNEL

#define OTKERNEL 0

The following table shows how to map from the old (pre-Universal Interfaces) header file name to the equivalent Universal Interfaces header file name. Old Header New Header

◆ OTNextLookupBuffer

#define OTNextLookupBuffer ( buf )

Value:

  ((TLookupBuffer *)((char *)buf +                                   \
                     ((OTOffsetOf(TLookupBuffer, fAddressBuffer) +   \
                       buf->fAddressLength + buf->fNameLength + 3) & \
                      ~3)))

OTNextLookupBuffer allows you to step through a packed array of TLookupBuffers.

◆ OTOffsetOf

#define OTOffsetOf	(	structure,
		field
	)	((ByteCount) & ((structure *)0)->field)

OT now defines its own version of the standard C "offsetof" macro so as to avoid including <stddef.h>.

◆ OTUNIXERRORS

#define OTUNIXERRORS 0

OTUNIXERRORS determines whether this file defines a bunch of common UNIX error codes, like EPERM. Typically, client code does not want to do this because of the possibility of a clash with other code modules, like the standard C libraries, that also defines these routines. However, client code can turn it on to get these definitions. This might be done by protocol stack infrastructure, or some other low-level code. "OpenTransportKernel.i" sets this flag before include "OpenTransport.h" because kernel modules typically need these error codes. Note that kernel modules shouldn't be including standard C libraries, so this is rarely a problem. In general, the clash between OT and standard C definitions of these error codes is rarely a problem becasue both OT and the C libraries define them to have the same value. But I'm sure this check is useful to some people.

◆ T_ALIGN

#define T_ALIGN ( len ) (((UInt32)(len) + (sizeof(SInt32) - 1)) & ~(sizeof(SInt32) - 1))

This macro will align return the value of "len", rounded up to the next 4-byte boundary.

◆ XTI2OSStatus

#define XTI2OSStatus ( x ) (-3149 - (x))

These map the Open Transport/XTI errors (the Txxxx error codes), and the StdCLib Exxxx error codes into unique spaces in the Mac OS OSStatus space.

Typedef Documentation

◆ OTBand

typedef UInt32 OTBand

  OTBand *****

A band is a STREAMS concepts which defines the priority of data on a stream. Although this type is defined as a 32 bit number for efficiency's sake, bands actually only range from 0 to 255. Typically band 0 is used for normal data and band 1 for expedited data.

◆ OTConfigurationRef

typedef struct OTConfiguration* OTConfigurationRef

  OTConfiguration *****

This is a "black box" structure used to define the configuration of a provider or endpoint. This file defines a very limited set of operations on a configuration. "OpenTransportClient.h" extends this with extra operations used by protocol stacks but not typically needed by clients.

◆ OTDeferredTaskRef

typedef long OTDeferredTaskRef

OT deferred tasks are often more convenience that standard Mac OS although they have no significant advantages beyond convenience.

◆ OTDeviceType

typedef UInt16 OTDeviceType

A couple of special values for the device type element of an OTPortRef. See "OpenTransportDevices.h" for the standard values.

◆ OTEventCode

typedef UInt32 OTEventCode

OT event codes values for Open Transport. These are the event codes that are sent to notification routine (notifiers).

◆ OTFlags

typedef UInt32 OTFlags

This type is used to describe bitwise flags in OT data structures and parameters. Think of it as the OT analogue to the OptionBits type in "MacTypes.h".

◆ OTInitializationFlags

typedef UInt32 OTInitializationFlags

For Carbon the InitOpenTransport interface has changed so it takes a flags parameter and returns a client context pointer. The flag passed to indicates whether OT should be initialized for application use or for some other target (for example, plugins that run in an application context but not the application itself.) Applications that are not interested in the value of the client context pointer may pass NULL as outClientContext – they will pass NULL to other routines that take a OTClientContextPtr.

◆ OTOpenFlags

typedef UInt32 OTOpenFlags

  Flags Used When Opening Providers *****

Important OT does not currently support any of these flags. You should always pass 0 to a parameter of type OTOpenFlags. If you need to modify the mode of operation of a provider, use OTSetBlocking, OTSetSynchronous, etc.

◆ OTPortRef

typedef UInt32 OTPortRef

"OpenTransport.h" no longer defines "struct t_info". We recommend that you use TEndpointInfo instead. If this is impossible, use the definition of "struct t_info" in "OpenTransportXTI.h".

◆ OTReason

typedef SInt32 OTReason

A protocol-specific reason code for failure. Usually a Unix-style positive error code.

◆ OTResult

typedef SInt32 OTResult

  Mac OS Error Codes *****

Most OT client routines return an OSStatus error code, a 32 bit type defined in "MacTypes.h". The OT-unique error code values are defined below. Many of these are generated by remapping XTI error codes (Txxxx) and UNIX error codes (Exxxx) to a reserved range in the OSStatus space. Some routines return an OTResult type, indicating that the routine might fail with a negative error, succeed with noErr, or possible return a positive value indicating some status.

◆ OTServiceType

typedef UInt32 OTServiceType

  TEndpointInfo *****

This structure is returned from the GetEndpointInfo call and contains information about an endpoint. But first, some special flags and types.

◆ OTSystemTaskRef

typedef long OTSystemTaskRef

OT system tasks allow you to schedule a procedure to be called at system task time. Potentially useful, but it relies on someone calling SystemTask (or WaitNextEvent, which calls SystemTask). Not available to kernel code because relying on system task time to make progress is likely to result in deadlocks.

◆ OTTimeStamp

typedef UnsignedWide OTTimeStamp

OTGetTimeStamp returns time in "tick" numbers, stored in 64 bits. This timestamp can be used as a base number for calculating elapsed time. OTSubtractTimeStamps returns a pointer to the "result" parameter.

OTGetClockTimeInSecs returns time since Open Transport was initialized in seconds.

◆ OTUInt8Param

typedef UInt8 OTUInt8Param

  Normalise 68K Calling C Conventions *****

Define special types that handle the difference in parameter passing between different Mac OS C compilers when generating 68K code. OT exports C calling conventions routines, and various C compilers use various different conventions. Differences in the placement of the result are covered above, where we output pragma pointers_in_D0. The other big difference is how the compilers pass integer parameters less than 32 bits. The MPW compiler always extends these to 32 bits; other compilers simply push a value of the appropriate size. We overcome this difference by defining special OTFooParam types, which are only used when passing sub 32 bit values to routines. They are always defined to a 32 bit size, which makes all the compilers do the same thing. One weird consequence of this is that in more strict type checking languages (eg Pascal) OTBooleanParam is not compatible with Boolean. Sorry.

◆ OTXTIErr

typedef UInt16 OTXTIErr

These definitions are only compiled if you're building kernel code or you explicit request them by setting OTUNIXERRORS. See the description of these compiler variables, given above.

◆ OTXTIStates

typedef UInt32 OTXTIStates

  XTI States *****

These are the potential values returned by OTGetEndpointState and OTSync which represent the XTI state of an endpoint.

◆ ProviderRef

typedef void* ProviderRef

This deserves some explanation. If you're compiling for C++, the C++ definitions of TEndpoint and TMapper at the end of this file are invoked, which lets the compiler know that they are both subclasses of TProvider. This way the compiler will do the right subclass type checking, ie you will be able to pass an EndpointRef to a parameter of type ProviderRef, but not vice versa. On the other hand, if your compiling for straighth C, everything is defined as void. This is somewhat dangerous, but it prevents you have to cast an EndpointRef to a ProviderRef every time you call a function that works on all forms of providers.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

BSD defines O_ASYNC, O_NDELAY and O_NONBLOCK in fcntl.h Use kO_ASYNC, kO_NDELAY and kO_NONBLOCK in the unlikely event you need the OT value in Carbon

◆ anonymous enum

anonymous enum

OTAddress type defines the standard header for all OT address formats. It consists of one 16 bit integer, which defines the address format used, followed by an arbitrary number of bytes which are protocol-specific. Conceptually, all OT address formats are subtypes of this type, extended with fields that are specific to the protocol. For example, OTInetAddress starts with the OTAddressType field and then continues to include a host IP address and a port number.

◆ anonymous enum

anonymous enum

  OTAlloc Constants *****

Note: In general, Apple recommends that you avoid the OTAlloc call because using it extensively causes your program to allocate and deallocate many memory blocks, with each extra memory allocation costing time. OTStructType defines the structure type to be allocated using the OTAlloc call.

◆ anonymous enum

anonymous enum

These values are used in the "fields" parameter of the OTAlloc call to define which fields of the structure should be allocated.

◆ anonymous enum

anonymous enum

These flags are used when sending and receiving data. The constants defined are masks.

◆ anonymous enum

anonymous enum

These flags are used in the TOptMgmt and TOption structures to return results.

◆ anonymous enum

anonymous enum

Events are divided into numerous categories:

(0x0000xxxx) The core XTI events have identifiers of the form T_XXXX. These signal that an XTI event has occured on a stream.
(0x1000xxxx) Private events are reserved for protocol specific events. Each protocol stack defines them as appropriate for its own usage.
(0x2000xxxxx) Completion events have identifiers of the form T_XXXXCOMPLETE. These signal the completion of some asynchronous API routine, and are only delivered if the endpoint is in asynchronous mode.
(0x2100xxxx) Stream events are generally encountered when programming the raw streams API and indicate some event on a raw stream, or some other event of interest in the STREAMS kernel.
(0x2200xxxx) Signal events indicate that a signal has arrived on a raw stream. See "Signal Values" for details.
(0x2300xxxx) General provider events that might be generated by any provider.
(0x2400xxxx) System events sent to all providers.
(0x2500xxxx) System events sent to registered clients.
(0x2600xxxx) System events used by configurators.

(0x2700xxxx) Events sent to registered OT clients. All event codes not described here are reserved by Apple. If you receive an event code you do not understand, ignore it!

◆ anonymous enum

anonymous enum

  Signal Values *****

Signals that are generated by a raw stream. When writing a notifier for a raw stream, add these values to kSIGNALEVENT to determine what event you are receiving.

◆ anonymous enum

anonymous enum

  General XTI Definitions *****

These definitions are typically used during option management.

◆ anonymous enum

anonymous enum

Special-case values for in the tsdu, etsdu, connect, and discon fields of TEndpointInfo.

◆ anonymous enum

anonymous enum

Masks for the fPortFlags field of OTPortRecord If no bits are set, the port is currently inactive.

◆ anonymous enum

anonymous enum

If the endpoint supports "raw mode" (the T_CAN_SUPPORT_MDATA bit will be set in the TEndpointInfo::flags field), then you specify the raw mode packet by putting the kOTNetbufIsRawMode value in the udata.addr.len field when calling OTSndUData and also set the udata.opt.len, udata.opt.buf, and udata.addr.buf fields to 0.

Function Documentation

◆ CALLBACK_API() [1/2]

typedef CALLBACK_API	(	void	,
		OTNotifyProcPtr
	)

  Notifier Type Definition *****

Open Transport notifiers must conform to the OTNotifyProcPtr prototype. Even though a OTNotifyUPP is a OTNotifyProcPtr on pre-Carbon system, use NewOTNotifyUPP() and friends to make your source code portable to OS X and Carbon.

◆ CALLBACK_API() [2/2]

typedef CALLBACK_API	(	void	,
		OTProcessProcPtr
	)

All OT task callbacks use the same prototype, shown below. This is only a UPP for CFM-68K clients.

◆ CALLBACK_API_C()

typedef CALLBACK_API_C	(	Boolean	,
		OTListSearchProcPtr
	)		const

An OTList is a non-interrupt-safe list, but has more features than the OTLIFO list. It is a standard singly-linked list. The following is the prototype for a list element comparison function, which returns true if the element described by linkToCheck matches the client criteria (typically held in ref). This is only a UPP for CFM-68K clients.

◆ CloseOpenTransport()

void CloseOpenTransport ( void )

CloseOpenTransport()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ CloseOpenTransportInContext()

void CloseOpenTransportInContext ( OTClientContextPtr clientContext )

Under Carbon, CloseOpenTransport takes a client context pointer. Applications may pass NULL after calling InitOpenTransport(kInitOTForApplicationMask, ...). Non-applications must always pass a valid client context. CloseOpenTransportInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DisposeOTListSearchUPP()

void DisposeOTListSearchUPP ( OTListSearchUPP userUPP )

DisposeOTListSearchUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DisposeOTNotifyUPP()

void DisposeOTNotifyUPP ( OTNotifyUPP userUPP )

DisposeOTNotifyUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DisposeOTProcessUPP()

void DisposeOTProcessUPP ( OTProcessUPP userUPP )

DisposeOTProcessUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ InitOpenTransport()

OSStatus InitOpenTransport ( void )

InitOpenTransport()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ InitOpenTransportInContext()

OSStatus InitOpenTransportInContext	(	OTInitializationFlags	flags,
		OTClientContextPtr *	outClientContext
	)

InitOpenTransportInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ InitOpenTransportUtilities()

OSStatus InitOpenTransportUtilities ( void )

InitOpenTransportUtilities()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ InvokeOTListSearchUPP()

Boolean InvokeOTListSearchUPP	(	const void *	ref,
		OTLink *	linkToCheck,
		OTListSearchUPP	userUPP
	)

InvokeOTListSearchUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ InvokeOTNotifyUPP()

void InvokeOTNotifyUPP	(	void *	contextPtr,
		OTEventCode	code,
		OTResult	result,
		void *	cookie,
		OTNotifyUPP	userUPP
	)

InvokeOTNotifyUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ InvokeOTProcessUPP()

void InvokeOTProcessUPP	(	void *	arg,
		OTProcessUPP	userUPP
	)

InvokeOTProcessUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ NewOTListSearchUPP()

OTListSearchUPP NewOTListSearchUPP ( OTListSearchProcPtr userRoutine )

NewOTListSearchUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ NewOTNotifyUPP()

OTNotifyUPP NewOTNotifyUPP ( OTNotifyProcPtr userRoutine )

NewOTNotifyUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ NewOTProcessUPP()

OTProcessUPP NewOTProcessUPP ( OTProcessProcPtr userRoutine )

NewOTProcessUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAccept()

OSStatus OTAccept	(	EndpointRef	listener,
		EndpointRef	worker,
		TCall *	call
	)

OTAccept()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAckSends()

OSStatus OTAckSends ( ProviderRef ref )

OTAckSends()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAddFirst()

void OTAddFirst	(	OTList *	list,
		OTLink *	link
	)

OTAddFirst()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAddLast()

void OTAddLast	(	OTList *	list,
		OTLink *	link
	)

OTAddLast()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAlloc()

void* OTAlloc	(	EndpointRef	ref,
		OTStructType	structType,
		OTFieldsType	fields,
		OSStatus *	err
	)

OTAlloc()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTAllocInContext()

void* OTAllocInContext	(	EndpointRef	ref,
		OTStructType	structType,
		UInt32	fields,
		OSStatus *	err,
		OTClientContextPtr	clientContext
	)

Note: In general, Apple recommends that you avoid the OTAlloc call because using it extensively causes your program to allocate and deallocate many memory blocks, with each extra memory allocation costing time. Under Carbon, OTAlloc takes a client context pointer. Applications may pass NULL after calling InitOpenTransport(kInitOTForApplicationMask, ...). Non-applications must always pass a valid client context. OTAllocInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAllocMem()

void* OTAllocMem ( OTByteCount size )

OTAllocMem()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTAllocMemInContext()

void* OTAllocMemInContext	(	OTByteCount	size,
		OTClientContextPtr	clientContext
	)

This file defines a very limited set of operations on a configuration. "OpenTransportClient.h" extends this with extra operations used by protocol stacks but not typically needed by clients. Under Carbon, OTAllocMem takes a client context pointer. Applications may pass NULL after calling InitOpenTransport(kInitOTForApplicationMask, ...). Non-applications must always pass a valid client context. OTAllocMemInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAsyncOpenEndpoint()

OSStatus OTAsyncOpenEndpoint	(	OTConfigurationRef	cfig,
		OTOpenFlags	oflag,
		TEndpointInfo *	info,
		OTNotifyUPP	proc,
		void *	contextPtr
	)

OTAsyncOpenEndpoint()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTAsyncOpenEndpointInContext()

OSStatus OTAsyncOpenEndpointInContext	(	OTConfigurationRef	config,
		OTOpenFlags	oflag,
		TEndpointInfo *	info,
		OTNotifyUPP	upp,
		void *	contextPtr,
		OTClientContextPtr	clientContext
	)

OTAsyncOpenEndpointInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAsyncOpenMapper()

OSStatus OTAsyncOpenMapper	(	OTConfigurationRef	cfig,
		OTOpenFlags	oflag,
		OTNotifyUPP	proc,
		void *	contextPtr
	)

OTAsyncOpenMapper()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTAsyncOpenMapperInContext()

OSStatus OTAsyncOpenMapperInContext	(	OTConfigurationRef	config,
		OTOpenFlags	oflag,
		OTNotifyUPP	upp,
		void *	contextPtr,
		OTClientContextPtr	clientContext
	)

Under Carbon, the OpenMapper routines take a client context pointer. Applications may pass NULL after calling InitOpenTransport(kInitOTForApplicationMask, ...). Non-applications must always pass a valid client context. OTAsyncOpenMapperInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAsyncOpenProvider()

OSStatus OTAsyncOpenProvider	(	OTConfigurationRef	cfig,
		OTOpenFlags	flags,
		OTNotifyUPP	proc,
		void *	contextPtr
	)

OTAsyncOpenProvider()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTAtomicAdd16()

SInt16 OTAtomicAdd16	(	SInt32	toAdd,
		SInt16 *	dest
	)

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAtomicAdd32()

SInt32 OTAtomicAdd32	(	SInt32	toAdd,
		SInt32 *	dest
	)

cas.b d0,d1,(a0) *| seq d0 *| moveq #1,d1; and.l d1,d0 *| OTAtomicAdd32()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAtomicAdd8()

SInt8 OTAtomicAdd8	(	SInt32	toAdd,
		SInt8 *	dest
	)

OTAtomicAdd8()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAtomicClearBit()

Boolean OTAtomicClearBit	(	UInt8 *	bytePtr,
		OTByteCount	bitNumber
	)

bset.b d0,(a0) sne d0 moveq #1,d1 and.l d1,d0 OTAtomicClearBit()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAtomicSetBit()

Boolean OTAtomicSetBit	(	UInt8 *	bytePtr,
		OTByteCount	bitNumber
	)

Note: The Bit operations return the previous value of the bit (0 or non-zero). The memory pointed to must be a single byte and only bits 0 through 7 are valid. Bit 0 corresponds to a mask of 0x01, and Bit 7 to a mask of 0x80. WARNING! void* and UInt32 locations MUST be on 4-byte boundaries. UInt16 locations must not cross a 4-byte boundary. OTAtomicSetBit()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTAtomicTestBit()

Boolean OTAtomicTestBit	(	UInt8 *	bytePtr,
		OTByteCount	bitNumber
	)

bclr.b d0,(a0) sne d0 moveq #1,d1 and.l d1,d0 OTAtomicTestBit()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTBind()

OSStatus OTBind	(	EndpointRef	ref,
		TBind *	reqAddr,
		TBind *	retAddr
	)

OTBind()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCancelReply()

OSStatus OTCancelReply	(	EndpointRef	ref,
		OTSequence	sequence
	)

OTCancelReply()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCancelRequest()

OSStatus OTCancelRequest	(	EndpointRef	ref,
		OTSequence	sequence
	)

OTCancelRequest()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCancelSynchronousCalls()

OSStatus OTCancelSynchronousCalls	(	ProviderRef	ref,
		OSStatus	err
	)

OTCancelSynchronousCalls()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCancelSystemTask()

Boolean OTCancelSystemTask ( OTSystemTaskRef stCookie )

OTCancelSystemTask()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCancelUReply()

OSStatus OTCancelUReply	(	EndpointRef	ref,
		OTSequence	seq
	)

OTCancelUReply()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCancelURequest()

OSStatus OTCancelURequest	(	EndpointRef	ref,
		OTSequence	seq
	)

OTCancelURequest()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCanLoadLibraries()

Boolean OTCanLoadLibraries ( void )

OTCanLoadLibraries()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCanMakeSyncCall()

Boolean OTCanMakeSyncCall ( void )

OTCanMakeSyncCall()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTChangePortState()

OSStatus OTChangePortState	(	OTPortRef	portRef,
		OTEventCode	theChange,
		OTResult	why
	)

Unregister the port with the given name (If you re-register the port, it may get a different name - use OTChangePortState if that is not desireable). Since a single OTPortRef can be registered with several names, the API needs to use the portName rather than the OTPortRef to disambiguate. OTChangePortState()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCloneConfiguration()

OTConfigurationRef OTCloneConfiguration ( OTConfigurationRef cfig )

OTCloneConfiguration()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCloseProvider()

OSStatus OTCloseProvider ( ProviderRef ref )

OTCloseProvider()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCompareAndSwap16()

Boolean OTCompareAndSwap16	(	UInt32	oldValue,
		UInt32	newValue,
		UInt16 *	dest
	)

cas.l d0,d1,(a0) *| seq d0 *| moveq #1,d1; and.l d1,d0 *| OTCompareAndSwap16()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCompareAndSwap32()

Boolean OTCompareAndSwap32	(	UInt32	oldValue,
		UInt32	newValue,
		UInt32 *	dest
	)

cas.l d0,d1,(a0) *| seq d0 *| moveq #1,d1; and.l d1,d0 *| OTCompareAndSwap32()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCompareAndSwap8()

Boolean OTCompareAndSwap8	(	UInt32	oldValue,
		UInt32	newValue,
		UInt8 *	dest
	)

cas.w d0,d1,(a0) *| seq d0 *| moveq #1,d1; and.l d1,d0 *| OTCompareAndSwap8()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCompareAndSwapPtr()

Boolean OTCompareAndSwapPtr	(	void *	oldValue,
		void *	newValue,
		void **	dest
	)

btst.b d0,(a0) sne d0 *| moveq #1,d1 and.l d1,d0 *| OTCompareAndSwapPtr()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTConnect()

OSStatus OTConnect	(	EndpointRef	ref,
		TCall *	sndCall,
		TCall *	rcvCall
	)

OTConnect()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCountDataBytes()

OTResult OTCountDataBytes	(	EndpointRef	ref,
		OTByteCount *	countPtr
	)

OTCountDataBytes()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCreateConfiguration()

OTConfigurationRef OTCreateConfiguration ( const char * path )

OTCreateConfiguration()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCreateDeferredTask()

OTDeferredTaskRef OTCreateDeferredTask	(	OTProcessUPP	proc,
		void *	arg
	)

OTCreateDeferredTask()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTCreateDeferredTaskInContext()

long OTCreateDeferredTaskInContext	(	OTProcessUPP	upp,
		void *	arg,
		OTClientContextPtr	clientContext
	)

Under Carbon, OTCreateDeferredTask takes a client context pointer. Applications may pass NULL after calling InitOpenTransport(kInitOTForApplicationMask, ...). Non-applications must always pass a valid client context. OTCreateDeferredTaskInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCreateOptions()

OSStatus OTCreateOptions	(	const char *	endPtName,
		char **	strPtr,
		TNetbuf *	buf
	)

OTCreateOptions()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCreateOptionString()

OSStatus OTCreateOptionString	(	const char *	endPtName,
		TOption **	opt,
		void *	bufEnd,
		char *	str,
		OTByteCount	stringSize
	)

OTCreateOptionString()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTCreatePortRef()

OTPortRef OTCreatePortRef	(	OTBusType	busType,
		OTDeviceType	devType,
		OTSlotNumber	slot,
		UInt16	other
	)

OTCreatePortRef()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTCreateSystemTask()

OTSystemTaskRef OTCreateSystemTask	(	OTProcessUPP	proc,
		void *	arg
	)

OTCreateSystemTask()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTDebugStr()

void OTDebugStr ( const char * str )

OTDebugStr()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTDelay()

void OTDelay ( UInt32 seconds )

Neither of these routines should be necessary to the correct operation of an OT program. If you're calling them, think again. OTDelay()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTDeleteName()

OSStatus OTDeleteName	(	MapperRef	ref,
		TNetbuf *	name
	)

OTDeleteName()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTDeleteNameByID()

OSStatus OTDeleteNameByID	(	MapperRef	ref,
		OTNameID	nameID
	)

OTDeleteNameByID()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTDequeue()

void* OTDequeue	(	void **	listHead,
		OTByteCount	linkOffset
	)

This function returns the head object of the list, and places the pointer at "object" + linkOffset into the listHead OTDequeue()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTDestroyConfiguration()

void OTDestroyConfiguration ( OTConfigurationRef cfig )

OTDestroyConfiguration()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTDestroyDeferredTask()

OSStatus OTDestroyDeferredTask ( OTDeferredTaskRef dtCookie )

OTDestroyDeferredTask()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTDestroySystemTask()

OSStatus OTDestroySystemTask ( OTSystemTaskRef stCookie )

OTDestroySystemTask()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTDontAckSends()

OSStatus OTDontAckSends ( ProviderRef ref )

OTDontAckSends()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTElapsedMicroseconds()

UInt32 OTElapsedMicroseconds ( OTTimeStamp * startTime )

OTElapsedMicroseconds()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTElapsedMilliseconds()

UInt32 OTElapsedMilliseconds ( OTTimeStamp * startTime )

OTElapsedMilliseconds()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTEnqueue()

void OTEnqueue	(	void **	listHead,
		void *	object,
		OTByteCount	linkOffset
	)

These routines are atomic, mighty weird, and generally not worth the complexity. If you need atomic list operations, use OTLIFO instead. This function puts "object" on the listHead, and places the previous value at listHead into the pointer at "object" plus linkOffset. OTEnqueue()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTEnterInterrupt()

void OTEnterInterrupt ( void )

OTEnterInterrupt/OTLeaveInterrupt are normally used within the kernel to tell Open Transport we're at hardware interrupt time. Clients can also them to do the same. OTEnterInterrupt()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTEnterNotifier()

Boolean OTEnterNotifier ( ProviderRef ref )

OTEnterNotifier()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTFindAndRemoveLink()

OTLink* OTFindAndRemoveLink	(	OTList *	list,
		OTListSearchUPP	proc,
		const void *	ref
	)

OTFindAndRemoveLink()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTFindLink()

OTLink* OTFindLink	(	OTList *	list,
		OTListSearchUPP	proc,
		const void *	ref
	)

Find a link in the list which matches the search criteria established by the search proc and the refPtr. This is done by calling the search proc, passing it the refPtr and each link in the list, until the search proc returns true. NULL is returned if the search proc never returned true. OTFindLink()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTFindOption()

TOption* OTFindOption	(	UInt8 *	buffer,
		UInt32	buflen,
		OTXTILevel	level,
		OTXTIName	name
	)

OTFindOption()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTFindPort()

Boolean OTFindPort	(	OTPortRecord *	portRecord,
		const char *	portName
	)

OTFindPort()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTFindPortByRef()

Boolean OTFindPortByRef	(	OTPortRecord *	portRecord,
		OTPortRef	ref
	)

OTFindPortByRef()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTFree()

OTResult OTFree	(	void *	ptr,
		OTStructType	structType
	)

OTFree()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTFreeMem()

void OTFreeMem ( void * mem )

OTFreeMem()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetBusTypeFromPortRef()

UInt16 OTGetBusTypeFromPortRef ( OTPortRef ref )

OTGetBusTypeFromPortRef()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetClockTimeInSecs()

UInt32 OTGetClockTimeInSecs ( void )

OTGetClockTimeInSecs()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetDeviceTypeFromPortRef()

OTDeviceType OTGetDeviceTypeFromPortRef ( OTPortRef ref )

OTGetDeviceTypeFromPortRef()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetEndpointInfo()

OSStatus OTGetEndpointInfo	(	EndpointRef	ref,
		TEndpointInfo *	info
	)

OTGetEndpointInfo()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetEndpointState()

OTResult OTGetEndpointState ( EndpointRef ref )

OTGetEndpointState()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetFirst()

OTLink* OTGetFirst ( OTList * list )

OTGetFirst()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetIndexedLink()

OTLink* OTGetIndexedLink	(	OTList *	list,
		OTItemCount	index
	)

OTGetIndexedLink()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetIndexedPort()

Boolean OTGetIndexedPort	(	OTPortRecord *	portRecord,
		OTItemCount	index
	)

Routines for finding, registering and unregistering ports. IMPORTANT: These routines have two versions, one for the client and one for the kernel. Make sure you use and link with the right ones. OTGetIndexedPort()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetLast()

OTLink* OTGetLast ( OTList * list )

OTGetLast()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetMessage()

OTResult OTGetMessage	(	ProviderRef	ref,
		strbuf *	ctlbuf,
		strbuf *	databuf,
		OTFlags *	flagsPtr
	)

OTGetMessage()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTGetPriorityMessage()

OTResult OTGetPriorityMessage	(	ProviderRef	ref,
		strbuf *	ctlbuf,
		strbuf *	databuf,
		OTBand *	bandPtr,
		OTFlags *	flagsPtr
	)

OTGetPriorityMessage()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTGetProtAddress()

OSStatus OTGetProtAddress	(	EndpointRef	ref,
		TBind *	boundAddr,
		TBind *	peerAddr
	)

OTGetProtAddress()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetProviderPortRef()

OTPortRef OTGetProviderPortRef ( ProviderRef ref )

OTGetProviderPortRef()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTGetSlotFromPortRef()

OTSlotNumber OTGetSlotFromPortRef	(	OTPortRef	ref,
		UInt16 *	other
	)

OTGetSlotFromPortRef()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTGetTimeStamp()

void OTGetTimeStamp ( OTTimeStamp * currentTime )

OTGetTimeStamp()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTIdle()

void OTIdle ( void )

OTIdle()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTInstallNotifier()

OSStatus OTInstallNotifier	(	ProviderRef	ref,
		OTNotifyUPP	proc,
		void *	contextPtr
	)

OTInstallNotifier()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTIoctl()

SInt32 OTIoctl	(	ProviderRef	ref,
		UInt32	cmd,
		void *	data
	)

OTIoctl()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTIsAckingSends()

Boolean OTIsAckingSends ( ProviderRef ref )

OTIsAckingSends()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTIsAtInterruptLevel()

Boolean OTIsAtInterruptLevel ( void )

OTIsAtInterruptLevel()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTIsBlocking()

Boolean OTIsBlocking ( ProviderRef ref )

OTIsBlocking()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTIsInList()

Boolean OTIsInList	(	OTList *	list,
		OTLink *	link
	)

OTIsInList()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTIsSynchronous()

Boolean OTIsSynchronous ( ProviderRef ref )

OTIsSynchronous()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTLeaveInterrupt()

void OTLeaveInterrupt ( void )

OTLeaveInterrupt()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTLeaveNotifier()

void OTLeaveNotifier ( ProviderRef ref )

OTLeaveNotifier()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTLIFODequeue()

OTLink* OTLIFODequeue ( OTLIFO * list )

This function atomically dequeues the first element on the list. OTLIFODequeue()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTLIFOEnqueue()

void OTLIFOEnqueue	(	OTLIFO *	list,
		OTLink *	link
	)

This function atomically enqueues the link onto the front of the list. OTLIFOEnqueue()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTLIFOStealList()

OTLink* OTLIFOStealList ( OTLIFO * list )

This function atomically empties the list and returns a pointer to the first element on the list. OTLIFOStealList()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTListen()

OSStatus OTListen	(	EndpointRef	ref,
		TCall *	call
	)

OTListen()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTLook()

OTResult OTLook ( EndpointRef ref )

OTLook()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTLookupName()

OSStatus OTLookupName	(	MapperRef	ref,
		TLookupRequest *	req,
		TLookupReply *	reply
	)

OTLookupName()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTMemcmp()

Boolean OTMemcmp	(	const void *	mem1,
		const void *	mem2,
		OTByteCount	nBytes
	)

OTMemcmp()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTMemcpy()

void OTMemcpy	(	void *	dest,
		const void *	src,
		OTByteCount	nBytes
	)

  Open Transport Utility Routines *****

All of these routines are available to both client and kernel. These are preferable, especially in the kernel case, to the standard C equivalents because they don't require you to link with StdCLib. OTMemcpy()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTMemmove()

void OTMemmove	(	void *	dest,
		const void *	src,
		OTByteCount	nBytes
	)

OTMemmove()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTMemset()

void OTMemset	(	void *	dest,
		OTUInt8Param	toSet,
		OTByteCount	nBytes
	)

OTMemset()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTMemzero()

void OTMemzero	(	void *	dest,
		OTByteCount	nBytes
	)

OTMemzero()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTNextOption()

OSStatus OTNextOption	(	UInt8 *	buffer,
		UInt32	buflen,
		TOption **	prevOptPtr
	)

OTNextOption()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTOpenEndpoint()

EndpointRef OTOpenEndpoint	(	OTConfigurationRef	cfig,
		OTOpenFlags	oflag,
		TEndpointInfo *	info,
		OSStatus *	err
	)

OTOpenEndpoint()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTOpenEndpointInContext()

EndpointRef OTOpenEndpointInContext	(	OTConfigurationRef	config,
		OTOpenFlags	oflag,
		TEndpointInfo *	info,
		OSStatus *	err,
		OTClientContextPtr	clientContext
	)

Under Carbon, the OpenEndpoint routines take a client context pointer. Applications may pass NULL after calling InitOpenTransport(kInitOTForApplicationMask, ...). Non-applications must always pass a valid client context. OTOpenEndpointInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTOpenMapper()

MapperRef OTOpenMapper	(	OTConfigurationRef	cfig,
		OTOpenFlags	oflag,
		OSStatus *	err
	)

OTOpenMapper()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTOpenMapperInContext()

MapperRef OTOpenMapperInContext	(	OTConfigurationRef	config,
		OTOpenFlags	oflag,
		OSStatus *	err,
		OTClientContextPtr	clientContext
	)

OTOpenMapperInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTOpenProvider()

ProviderRef OTOpenProvider	(	OTConfigurationRef	cfig,
		OTOpenFlags	flags,
		OSStatus *	errPtr
	)

OTOpenProvider()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTOptionManagement()

OSStatus OTOptionManagement	(	EndpointRef	ref,
		TOptMgmt *	req,
		TOptMgmt *	ret
	)

OTOptionManagement()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTPutMessage()

OSStatus OTPutMessage	(	ProviderRef	ref,
		const strbuf *	ctlbuf,
		const strbuf *	databuf,
		OTFlags	flags
	)

OTPutMessage()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTPutPriorityMessage()

OSStatus OTPutPriorityMessage	(	ProviderRef	ref,
		const strbuf *	ctlbuf,
		const strbuf *	databuf,
		OTBand	band,
		OTFlags	flags
	)

OTPutPriorityMessage()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTRcv()

OTResult OTRcv	(	EndpointRef	ref,
		void *	buf,
		OTByteCount	nbytes,
		OTFlags *	flags
	)

OTRcv()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRcvConnect()

OSStatus OTRcvConnect	(	EndpointRef	ref,
		TCall *	call
	)

OTRcvConnect()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRcvDisconnect()

OSStatus OTRcvDisconnect	(	EndpointRef	ref,
		TDiscon *	discon
	)

OTRcvDisconnect()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRcvOrderlyDisconnect()

OSStatus OTRcvOrderlyDisconnect ( EndpointRef ref )

OTRcvOrderlyDisconnect()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRcvReply()

OSStatus OTRcvReply	(	EndpointRef	ref,
		TReply *	reply,
		OTFlags *	replyFlags
	)

OTRcvReply()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTRcvRequest()

OSStatus OTRcvRequest	(	EndpointRef	ref,
		TRequest *	req,
		OTFlags *	reqFlags
	)

OTRcvRequest()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTRcvUData()

OSStatus OTRcvUData	(	EndpointRef	ref,
		TUnitData *	udata,
		OTFlags *	flags
	)

OTRcvUData()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRcvUDErr()

OSStatus OTRcvUDErr	(	EndpointRef	ref,
		TUDErr *	uderr
	)

OTRcvUDErr()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRcvUReply()

OSStatus OTRcvUReply	(	EndpointRef	ref,
		TUnitReply *	reply,
		OTFlags *	replyFlags
	)

OTRcvUReply()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTRcvURequest()

OSStatus OTRcvURequest	(	EndpointRef	ref,
		TUnitRequest *	req,
		OTFlags *	reqFlags
	)

OTRcvURequest()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTRegisterAsClient()

OSStatus OTRegisterAsClient	(	OTClientName	name,
		OTNotifyUPP	proc
	)

OTRegisterAsClient()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTRegisterAsClientInContext()

OSStatus OTRegisterAsClientInContext	(	OTClientName	name,
		OTNotifyUPP	proc,
		OTClientContextPtr	clientContext
	)

OTRegisterAsClientInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.3 and later

Mac OS X: in version 10.0 and later

◆ OTRegisterName()

OSStatus OTRegisterName	(	MapperRef	ref,
		TRegisterRequest *	req,
		TRegisterReply *	reply
	)

OTRegisterName()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRegisterPort()

OSStatus OTRegisterPort	(	OTPortRecord *	portRecord,
		void *	ref
	)

OTRegisterPort()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTRemoveFirst()

OTLink* OTRemoveFirst ( OTList * list )

OTRemoveFirst()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRemoveLast()

OTLink* OTRemoveLast ( OTList * list )

OTRemoveLast()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRemoveLink()

Boolean OTRemoveLink	(	OTList *	list,
		OTLink *	link
	)

OTRemoveLink()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTRemoveNotifier()

void OTRemoveNotifier ( ProviderRef ref )

OTRemoveNotifier()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTResolveAddress()

OSStatus OTResolveAddress	(	EndpointRef	ref,
		TBind *	reqAddr,
		TBind *	retAddr,
		OTTimeout	timeOut
	)

OTResolveAddress()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTReverseList()

OTLink* OTReverseList ( OTLink * list )

This function reverses a list that was stolen by OTLIFOStealList. It is NOT atomic. It returns the new starting list. OTReverseList()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTScheduleDeferredTask()

Boolean OTScheduleDeferredTask ( OTDeferredTaskRef dtCookie )

OTScheduleDeferredTask()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTScheduleInterruptTask()

Boolean OTScheduleInterruptTask ( OTDeferredTaskRef dtCookie )

OTScheduleInterruptTask()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTScheduleSystemTask()

Boolean OTScheduleSystemTask ( OTSystemTaskRef stCookie )

OTScheduleSystemTask()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTSetAsynchronous()

OSStatus OTSetAsynchronous ( ProviderRef ref )

OTSetAsynchronous()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSetBlocking()

OSStatus OTSetBlocking ( ProviderRef ref )

OTSetBlocking()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSetBusTypeInPortRef()

OTPortRef OTSetBusTypeInPortRef	(	OTPortRef	ref,
		OTBusType	busType
	)

OTSetBusTypeInPortRef()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSetDeviceTypeInPortRef()

OTPortRef OTSetDeviceTypeInPortRef	(	OTPortRef	ref,
		OTDeviceType	devType
	)

OTSetDeviceTypeInPortRef()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSetNonBlocking()

OSStatus OTSetNonBlocking ( ProviderRef ref )

OTSetNonBlocking()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSetSynchronous()

OSStatus OTSetSynchronous ( ProviderRef ref )

OTSetSynchronous()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSnd()

OTResult OTSnd	(	EndpointRef	ref,
		void *	buf,
		OTByteCount	nbytes,
		OTFlags	flags
	)

OTSnd()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSndDisconnect()

OSStatus OTSndDisconnect	(	EndpointRef	ref,
		TCall *	call
	)

OTSndDisconnect()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSndOrderlyDisconnect()

OSStatus OTSndOrderlyDisconnect ( EndpointRef ref )

OTSndOrderlyDisconnect()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSndReply()

OSStatus OTSndReply	(	EndpointRef	ref,
		TReply *	reply,
		OTFlags	replyFlags
	)

OTSndReply()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTSndRequest()

OSStatus OTSndRequest	(	EndpointRef	ref,
		TRequest *	req,
		OTFlags	reqFlags
	)

OTSndRequest()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTSndUData()

OSStatus OTSndUData	(	EndpointRef	ref,
		TUnitData *	udata
	)

OTSndUData()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSndUReply()

OSStatus OTSndUReply	(	EndpointRef	ref,
		TUnitReply *	reply,
		OTFlags	replyFlags
	)

OTSndUReply()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTSndURequest()

OSStatus OTSndURequest	(	EndpointRef	ref,
		TUnitRequest *	req,
		OTFlags	reqFlags
	)

OTSndURequest()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTStrCat()

void OTStrCat	(	char *	dest,
		const char *	src
	)

OTStrCat()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTStrCopy()

void OTStrCopy	(	char *	dest,
		const char *	src
	)

OTStrCopy()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTStrEqual()

Boolean OTStrEqual	(	const char *	src1,
		const char *	src2
	)

OTStrEqual()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTStrLength()

OTByteCount OTStrLength ( const char * str )

OTStrLength()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSubtractTimeStamps()

OTTimeStamp* OTSubtractTimeStamps	(	OTTimeStamp *	result,
		OTTimeStamp *	startTime,
		OTTimeStamp *	endEnd
	)

OTSubtractTimeStamps()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTSync()

OTResult OTSync ( EndpointRef ref )

OTSync()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTTimeStampInMicroseconds()

UInt32 OTTimeStampInMicroseconds ( OTTimeStamp * delta )

OTTimeStampInMicroseconds()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTTimeStampInMilliseconds()

UInt32 OTTimeStampInMilliseconds ( OTTimeStamp * delta )

OTTimeStampInMilliseconds()

Non-Carbon CFM: in OTUtilityLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTTransferProviderOwnership()

ProviderRef OTTransferProviderOwnership	(	ProviderRef	ref,
		OTClient	prevOwner,
		OSStatus *	errPtr
	)

OTTransferProviderOwnership()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTUnbind()

OSStatus OTUnbind ( EndpointRef ref )

OTUnbind()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTUnregisterAsClient()

OSStatus OTUnregisterAsClient ( void )

This registers yourself as a client for any miscellaneous Open Transport notifications that come along. CloseOpenTransport will automatically do an OTUnregisterAsClient, if you have not already done so. OTUnregisterAsClient()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

◆ OTUnregisterAsClientInContext()

OSStatus OTUnregisterAsClientInContext ( OTClientContextPtr clientContext )

OTUnregisterAsClientInContext()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.3 and later

Mac OS X: in version 10.0 and later

◆ OTUnregisterPort()

OSStatus OTUnregisterPort	(	const char *	portName,
		void **	ref
	)

Register a port. The name the port was registered under is returned in the fPortName field. OTUnregisterPort()

Non-Carbon CFM: in OTClientUtilLib 1.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ OTUseSyncIdleEvents()

OSStatus OTUseSyncIdleEvents	(	ProviderRef	ref,
		Boolean	useEvents
	)

OTUseSyncIdleEvents()

Non-Carbon CFM: in OTClientLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ OTWhoAmI()

OTClient OTWhoAmI ( void )

OTWhoAmI()

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: not available

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ _MDECL

◆ MIOC_CMD

◆ OPT_NEXTHDR

◆ OTCreateNuBusPortRef

◆ OTDEBUG

◆ OTGetLinkObject

◆ OTInitBufferInfo

◆ OTKERNEL

◆ OTNextLookupBuffer

◆ OTOffsetOf

◆ OTUNIXERRORS

◆ T_ALIGN

◆ XTI2OSStatus

Typedef Documentation

◆ OTBand

◆ OTConfigurationRef

◆ OTDeferredTaskRef

◆ OTDeviceType

◆ OTEventCode

◆ OTFlags

◆ OTInitializationFlags

◆ OTOpenFlags

◆ OTPortRef

◆ OTReason

◆ OTResult

◆ OTServiceType

◆ OTSystemTaskRef

◆ OTTimeStamp

◆ OTUInt8Param

◆ OTXTIErr

◆ OTXTIStates

◆ ProviderRef

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Function Documentation

◆ CALLBACK_API() [1/2]

◆ CALLBACK_API() [2/2]

◆ CALLBACK_API_C()

◆ CloseOpenTransport()

◆ CloseOpenTransportInContext()

◆ DisposeOTListSearchUPP()

◆ DisposeOTNotifyUPP()

◆ DisposeOTProcessUPP()

◆ InitOpenTransport()

◆ InitOpenTransportInContext()

◆ InitOpenTransportUtilities()

◆ InvokeOTListSearchUPP()

◆ InvokeOTNotifyUPP()

◆ InvokeOTProcessUPP()

◆ NewOTListSearchUPP()

◆ NewOTNotifyUPP()

◆ NewOTProcessUPP()

◆ OTAccept()

◆ OTAckSends()

◆ OTAddFirst()

◆ OTAddLast()

◆ OTAlloc()

◆ OTAllocInContext()

◆ OTAllocMem()

◆ OTAllocMemInContext()

◆ OTAsyncOpenEndpoint()

◆ OTAsyncOpenEndpointInContext()