Mac OS 9
OpenTransportProviders.h File Reference

This file contains provider-specific definitions for various built-in providers. More...

#include <OpenTransport.h>

Go to the source code of this file.

Data Structures

struct  TIPAddMulticast
 
struct  InetAddress
 
struct  InetHostInfo
 
struct  InetSysInfo
 
struct  InetMailExchange
 
struct  DNSQueryInfo
 
struct  DNSAddress
 
struct  InetInterfaceInfo
 
struct  InetDHCPOption
 
struct  NBPEntity
 
struct  DDPAddress
 
struct  NBPAddress
 
struct  DDPNBPAddress
 
struct  AppleTalkInfo
 
struct  T8022Address
 
struct  EnetPacketHeader
 
struct  T8022Header
 
struct  T8022SNAPHeader
 
struct  T8022FullPacketHeader
 
struct  OTISDNAddress
 
struct  RAConfigModem
 
struct  PPPMRULimits
 
struct  CCMiscInfo
 
struct  LCPEcho
 

Macros

#define AF_INET   2
 
#define kDefaultInternetServicesPath   ((OTConfigurationRef)-3L)
 
#define kInetVersion   "3.1.1"
 
#define kInetPrefix   "ot:inet$"
 
#define kDNRName   "dnr"
 
#define kTCPName   "tcp"
 
#define kUDPName   "udp"
 
#define kRawIPName   "rawip"
 
#define SET_TOS(prec, tos)   (((0x7 & (prec)) << 5) | (0x1c & (tos)))
 
#define kATalkVersion   "1.1"
 
#define kATalkPrefix   "ot:atlk$"
 
#define kATBinderID   "ot:atbd$"
 
#define kDDPName   "ddp"
 
#define kATPName   "atp"
 
#define kADSPName   "adsp"
 
#define kASPName   "asp"
 
#define kPAPName   "pap"
 
#define kNBPName   "nbp"
 
#define kZIPName   "zip"
 
#define kLTalkName   "ltlk"
 
#define kLTalkAName   "ltlkA"
 
#define kLTalkBName   "ltlkB"
 
#define IsAppleTalkEvent(x)   ((x) & 0xffff0000) == kAppleTalkEvent)
 
#define OTCopyDDPAddress(addr, dest)
 
#define kDefaultAppleTalkServicesPath   ((OTConfigurationRef)-3L)
 
#define kEnet8022Name   "enet8022x"
 
#define kEnetName   "enet"
 
#define kFastEnetName   "fenet"
 
#define kTokenRingName   "tokn"
 
#define kFDDIName   "fddi"
 
#define kIRTalkName   "irtlk"
 
#define kSMDSName   "smds"
 
#define kATMName   "atm"
 
#define kT8022Name   "tpi8022x"
 
#define kATMSNAPName   "atmsnap"
 
#define kFireWireName   "firewire"
 
#define kFibreChannelName   "fibre"
 
#define OTCompare48BitAddresses(p1, p2)
 
#define OTCopy48BitAddress(p1, p2)
 
#define OTClear48BitAddress(p1)    (*(UInt32 *)((UInt8 *)(p1)) = 0, *(UInt16 *)(((UInt8 *)(p1)) + 4) = 0)
 
#define OTCompare8022SNAP(p1, p2)
 
#define OTCopy8022SNAP(p1, p2)
 
#define OTIs48BitBroadcastAddress(p1)
 
#define OTSet48BitBroadcastAddress(p1)
 
#define OTIs48BitZeroAddress(p1)    (*(UInt32 *)((UInt8 *)(p1)) == 0 && *(UInt16 *)(((UInt8 *)(p1)) + 4) == 0)
 
#define kSerialABVersion   "1.1.1"
 
#define kSerialABName   "serialAB"
 
#define kSerialName   "serial"
 
#define kSerialPortAName   "serialA"
 
#define kSerialPortBName   "serialB"
 
#define OTSerialHandshakeData(type, onChar, offChar)    ((((UInt32)type) << 16) | (((UInt32)onChar) << 8) | offChar)
 
#define OTSerialSetErrorCharacter(rep)   ((rep) & 0xff)
 
#define OTSerialSetErrorCharacterWithAlternate(rep, alternate)    ((((rep) & 0xff) | (((alternate) & 0xff) << 8)) | 0x80000000L)
 
#define kISDNName   "isdn"
 
#define kPPPControlName   "ppp"
 
#define kScriptName   "Script"
 
#define gestaltOpenTptModem   'otmo'
 
#define gestaltOpenTptModemPresent   0
 
#define gestaltOpenTptModemVersion   'otmv'
 
#define kGestaltOpenTptModemVersion   0x01000080
 
#define kModemNoError   0
 
#define kModemOutOfMemory   -14000
 
#define kModemPreferencesMissing   -14001
 
#define kModemScriptMissing   -14002
 
#define kModemConfigFileCreator   'modm'
 
#define kModemConfigFileType   'mdpf'
 
#define kModemConfigVersion   0x00010000
 
#define kModemConfigExportType   'mdex'
 
#define kModemScriptType   'mlts' /** Same as ARA 1.0/2.0 */
 
#define kModemScriptCreator   'slnk' /** Same as ARA 1.0/2.0 */
 
#define kModemConfigTypeModem   'ccl ' /** Type for Modem config resource */
 
#define kModemSelectedConfigID   1 /** ID of resource containing.. */
 
#define kModemSelectedConfigType   'ccfg' /** the ID of current selected CCL */
 
#define kModemConfigNameType   'cnam' /** type of config name rez */
 
#define kModemConfigTypeLocks   'lkmd' /** Types for lock rez */
 
#define kModemConfigFirstID   128 /** lowest id for configuration rez */
 
#define kMaxScriptNameSize   64
 
#define kDefaultModemPrefsFileName   "\pModem Preferences"
 

Typedefs

typedef UInt16 InetPort
 
typedef UInt32 InetHost
 
typedef void * InetSvcRef
 
typedef struct TIPAddMulticast TIPAddMulticast
 
typedef struct InetAddress InetAddress
 
typedef char InetDomainName[256]
 
typedef struct InetHostInfo InetHostInfo
 
typedef struct InetSysInfo InetSysInfo
 
typedef struct InetMailExchange InetMailExchange
 
typedef struct DNSQueryInfo DNSQueryInfo
 
typedef struct DNSAddress DNSAddress
 
typedef struct InetInterfaceInfo InetInterfaceInfo
 
typedef struct InetDHCPOption InetDHCPOption
 
typedef void * ATSvcRef
 
typedef struct NBPEntity NBPEntity
 
typedef struct DDPAddress DDPAddress
 
typedef struct NBPAddress NBPAddress
 
typedef struct DDPNBPAddress DDPNBPAddress
 
typedef struct AppleTalkInfo AppleTalkInfo
 
typedef UInt32 OTPacketType
 
typedef struct T8022Address T8022Address
 
typedef UInt32 EAddrType
 
typedef struct EnetPacketHeader EnetPacketHeader
 
typedef struct T8022Header T8022Header
 
typedef struct T8022SNAPHeader T8022SNAPHeader
 
typedef struct T8022FullPacketHeader T8022FullPacketHeader
 
typedef UInt32 ParityOptionValues
 
typedef struct OTISDNAddress OTISDNAddress
 
typedef struct PPPMRULimits PPPMRULimits
 
typedef struct CCMiscInfo CCMiscInfo
 
typedef struct LCPEcho LCPEcho
 

Enumerations

enum  { AF_DNS = 42 }
 
enum  { kOTAnyInetAddress = 0 }
 
enum  { INET_IP = 0x00 , INET_TCP = 0x06 , INET_UDP = 0x11 }
 
enum  {
  TCP_NODELAY = 0x01 , TCP_MAXSEG = 0x02 , TCP_NOTIFY_THRESHOLD = 0x10 , TCP_ABORT_THRESHOLD = 0x11 ,
  TCP_CONN_NOTIFY_THRESHOLD = 0x12 , TCP_CONN_ABORT_THRESHOLD = 0x13 , TCP_OOBINLINE = 0x14 , TCP_URGENT_PTR_TYPE = 0x15 ,
  TCP_KEEPALIVE = 0x0008
}
 
enum  { T_GARBAGE = 2 }
 
enum  { UDP_CHECKSUM = 0x0600 , UDP_RX_ICMP = 0x02 }
 
enum  {
  kIP_OPTIONS = 0x01 , kIP_TOS = 0x02 , kIP_TTL = 0x03 , kIP_REUSEADDR = 0x04 ,
  kIP_DONTROUTE = 0x10 , kIP_BROADCAST = 0x20 , kIP_REUSEPORT = 0x0200 , kIP_HDRINCL = 0x1002 ,
  kIP_RCVOPTS = 0x1005 , kIP_RCVDSTADDR = 0x1007 , kIP_MULTICAST_IF = 0x1010 , kIP_MULTICAST_TTL = 0x1011 ,
  kIP_MULTICAST_LOOP = 0x1012 , kIP_ADD_MEMBERSHIP = 0x1013 , kIP_DROP_MEMBERSHIP = 0x1014 , kIP_BROADCAST_IFNAME = 0x1015 ,
  kIP_RCVIFADDR = 0x1016
}
 
enum  {
  IP_OPTIONS = kIP_OPTIONS , IP_TOS = kIP_TOS , IP_TTL = kIP_TTL , IP_REUSEADDR = kIP_REUSEADDR ,
  IP_DONTROUTE = kIP_DONTROUTE , IP_BROADCAST = kIP_BROADCAST , IP_REUSEPORT = kIP_REUSEPORT , IP_HDRINCL = kIP_HDRINCL ,
  IP_RCVOPTS = kIP_RCVOPTS , IP_RCVDSTADDR = kIP_RCVDSTADDR , IP_MULTICAST_IF = kIP_MULTICAST_IF , IP_MULTICAST_TTL = kIP_MULTICAST_TTL ,
  IP_MULTICAST_LOOP = kIP_MULTICAST_LOOP , IP_ADD_MEMBERSHIP = kIP_ADD_MEMBERSHIP , IP_DROP_MEMBERSHIP = kIP_DROP_MEMBERSHIP , IP_BROADCAST_IFNAME ,
  IP_RCVIFADDR = kIP_RCVIFADDR
}
 
enum  {
  DVMRP_INIT = 100 , DVMRP_DONE = 101 , DVMRP_ADD_VIF = 102 , DVMRP_DEL_VIF = 103 ,
  DVMRP_ADD_LGRP = 104 , DVMRP_DEL_LGRP = 105 , DVMRP_ADD_MRT = 106 , DVMRP_DEL_MRT = 107
}
 
enum  {
  T_ROUTINE = 0 , T_PRIORITY = 1 , T_IMMEDIATE = 2 , T_FLASH = 3 ,
  T_OVERRIDEFLASH = 4 , T_CRITIC_ECP = 5 , T_INETCONTROL = 6 , T_NETCONTROL = 7
}
 
enum  { T_NOTOS = 0x00 , T_LDELAY = (1 << 4) , T_HITHRPT = (1 << 3) , T_HIREL = (1 << 2) }
 
enum  {
  T_DNRSTRINGTOADDRCOMPLETE = kPRIVATEEVENT + 1 , T_DNRADDRTONAMECOMPLETE = kPRIVATEEVENT + 2 , T_DNRSYSINFOCOMPLETE = kPRIVATEEVENT + 3 , T_DNRMAILEXCHANGECOMPLETE = kPRIVATEEVENT + 4 ,
  T_DNRQUERYCOMPLETE = kPRIVATEEVENT + 5
}
 
enum  { kMaxHostAddrs = 10 , kMaxSysStringLen = 32 , kMaxHostNameLen = 255 }
 
enum  { kDefaultInetInterface = -1 }
 
enum  { kInetInterfaceInfoVersion = 3 }
 
enum  { kAllDHCPOptions = -1 , kDHCPLongOption = 126 , kDHCPLongOptionReq = 127 }
 
enum  {
  ATK_DDP = FOUR_CHAR_CODE('DDP ') , ATK_AARP = FOUR_CHAR_CODE('AARP') , ATK_ATP = FOUR_CHAR_CODE('ATP ') , ATK_ADSP = FOUR_CHAR_CODE('ADSP') ,
  ATK_ASP = FOUR_CHAR_CODE('ASP ') , ATK_PAP = FOUR_CHAR_CODE('PAP ') , ATK_NBP = FOUR_CHAR_CODE('NBP ') , ATK_ZIP = FOUR_CHAR_CODE('ZIP ')
}
 
enum  {
  DDP_OPT_CHECKSUM = 0x0600 , DDP_OPT_SRCADDR , ATP_OPT_REPLYCNT = 0x2110 , ATP_OPT_DATALEN = 0x2111 ,
  ATP_OPT_RELTIMER , ATP_OPT_TRANID , PAP_OPT_OPENRETRY = 0x2120
}
 
enum  {
  kAppleTalkEvent = kPROTOCOLEVENT | 0x00010000 , T_GETMYZONECOMPLETE = kAppleTalkEvent + 1 , T_GETLOCALZONESCOMPLETE = kAppleTalkEvent + 2 , T_GETZONELISTCOMPLETE = kAppleTalkEvent + 3 ,
  T_GETATALKINFOCOMPLETE = kAppleTalkEvent + 4 , T_ATALKROUTERDOWNEVENT , T_ATALKROUTERUPEVENT , T_ATALKZONENAMECHANGEDEVENT ,
  T_ATALKCONNECTIVITYCHANGEDEVENT , T_ATALKINTERNETAVAILABLEEVENT , T_ATALKCABLERANGECHANGEDEVENT
}
 
enum  { kAllATalkRoutersDown = 0 , kLocalATalkRoutersDown = -1L , kARARouterDisconnected }
 
enum  { kARARouterOnline , kATalkRouterOnline , kLocalATalkRouterOnline }
 
enum  { ATALK_IOC_FULLSELFSEND , ADSP_IOC_FORWARDRESET = ((MIOC_ATALK << 8) | 60) }
 
enum  { kECHO_TSDU = 585 }
 
enum  {
  kNBPMaxNameLength = 32 , kNBPMaxTypeLength = 32 , kNBPMaxZoneLength = 32 , kNBPSlushLength = 9 ,
  kNBPMaxEntityLength , kNBPEntityBufferSize , kNBPWildCard = 0x3D , kNBPImbeddedWildCard = 0xC5 ,
  kNBPDefaultZone = 0x2A
}
 
enum  { kZIPMaxZoneLength = kNBPMaxZoneLength }
 
enum  { kDDPAddressLength = 8 , kNBPAddressLength = kNBPEntityBufferSize , kAppleTalkAddressLength = kDDPAddressLength + kNBPEntityBufferSize }
 
enum  {
  AF_ATALK_FAMILY = 0x0100 , AF_ATALK_DDP = 0x0100 , AF_ATALK_DDPNBP = AF_ATALK_FAMILY + 1 , AF_ATALK_NBP = AF_ATALK_FAMILY + 2 ,
  AF_ATALK_MNODE = AF_ATALK_FAMILY + 3
}
 
enum  { kATalkInfoIsExtended = 0x0001 , kATalkInfoHasRouter = 0x0002 , kATalkInfoOneZone = 0x0004 }
 
enum  { kOTFramingEthernet = 0x01 , kOTFramingEthernetIPX = 0x02 , kOTFraming8023 = 0x04 , kOTFraming8022 = 0x08 }
 
enum  { kOTRawRcvOn = 0 , kOTRawRcvOff = 1 , kOTRawRcvOnWithTimeStamp = 2 }
 
enum  { DL_PROMISC_OFF = 0 }
 
enum  { kT8022ModuleID = 7100 , kEnetModuleID = 7101 , kTokenRingModuleID = 7102 , kFDDIModuleID = 7103 }
 
enum  { AF_8022 = 8200 }
 
enum  { LNK_ENET = FOUR_CHAR_CODE('ENET') , LNK_TOKN = FOUR_CHAR_CODE('TOKN') , LNK_FDDI = FOUR_CHAR_CODE('FDDI') , LNK_TPI = FOUR_CHAR_CODE('LTPI') }
 
enum  {
  OPT_ADDMCAST = 0x1000 , OPT_DELMCAST = 0x1001 , OPT_RCVPACKETTYPE = 0x1002 , OPT_RCVDESTADDR = 0x1003 ,
  OPT_SETRAWMODE = 0x1004 , OPT_SETPROMISCUOUS = 0x1005
}
 
enum  {
  kETypeStandard = 0 , kETypeMulticast = 1 , kETypeBroadcast = 2 , kETRawPacketBit = (unsigned long)0x80000000 ,
  kETTimeStampBit = 0x40000000
}
 
enum  {
  kMulticastLength = 6 , k48BitAddrLength = 6 , k8022DLSAPLength = 2 , k8022SNAPLength = 5 ,
  kEnetAddressLength , kSNAPSAP = 0x00AA , kIPXSAP = 0x00FF , kMax8022SAP = 0x00FE ,
  k8022GlobalSAP = 0x00FF , kMinDIXSAP = 1501 , kMaxDIXSAP = 0xFFFF
}
 
enum  { k8022BasicAddressLength , k8022SNAPAddressLength }
 
enum  {
  kEnetPacketHeaderLength = (2 * k48BitAddrLength) + k8022DLSAPLength , kEnetTSDU = 1514 , kTokenRingTSDU = 4458 , kFDDITSDU = 4458 ,
  k8022SAPLength = 1 , k8022BasicHeaderLength , k8022SNAPHeaderLength = k8022SNAPLength + k8022BasicHeaderLength
}
 
enum  {
  keaStandardAddress = 0 , keaMulticast = 1 , keaBroadcast = 2 , keaBadAddress = 3 ,
  keaRawPacketBit = (unsigned long)0x80000000 , keaTimeStampBit = 0x40000000
}
 
enum  { kT8022HeaderLength = 3 , kT8022SNAPHeaderLength = 3 + k8022SNAPLength , kT8022FullPacketHeaderLength }
 
enum  { COM_SERIAL = FOUR_CHAR_CODE('SERL') }
 
enum  { kSerialABModuleID = 7200 }
 
enum  {
  kOTSerialFramingAsync = 0x01 , kOTSerialFramingHDLC = 0x02 , kOTSerialFramingSDLC = 0x04 , kOTSerialFramingAsyncPackets = 0x08 ,
  kOTSerialFramingPPP = 0x10
}
 
enum  {
  I_SetSerialDTR = ((MIOC_SRL << 8) | 0) , kOTSerialSetDTROff = 0 , kOTSerialSetDTROn = 1 , I_SetSerialBreak ,
  kOTSerialSetBreakOn = (unsigned long)0xFFFFFFFF , kOTSerialSetBreakOff = 0 , I_SetSerialXOffState , kOTSerialForceXOffTrue = 1 ,
  kOTSerialForceXOffFalse = 0 , I_SetSerialXOn , kOTSerialSendXOnAlways = 1 , kOTSerialSendXOnIfXOffTrue = 0 ,
  I_SetSerialXOff , kOTSerialSendXOffAlways = 1 , kOTSerialSendXOffIfXOnTrue = 0
}
 
enum  {
  SERIAL_OPT_BAUDRATE = 0x0100 , SERIAL_OPT_DATABITS = 0x0101 , SERIAL_OPT_STOPBITS = 0x0102 , SERIAL_OPT_PARITY = 0x0103 ,
  SERIAL_OPT_STATUS = 0x0104 , SERIAL_OPT_HANDSHAKE = 0x0105 , SERIAL_OPT_RCVTIMEOUT , SERIAL_OPT_ERRORCHARACTER = 0x0107 ,
  SERIAL_OPT_EXTCLOCK = 0x0108 , SERIAL_OPT_BURSTMODE = 0x0109 , SERIAL_OPT_DUMMY = 0x010A
}
 
enum  { kOTSerialNoParity = 0 , kOTSerialOddParity = 1 , kOTSerialEvenParity = 2 }
 
enum  {
  kOTSerialSwOverRunErr = 0x01 , kOTSerialBreakOn = 0x08 , kOTSerialParityErr = 0x10 , kOTSerialOverrunErr = 0x20 ,
  kOTSerialFramingErr = 0x40 , kOTSerialXOffSent = 0x00010000 , kOTSerialDTRNegated = 0x00020000 , kOTSerialCTLHold = 0x00040000 ,
  kOTSerialXOffHold = 0x00080000 , kOTSerialOutputBreakOn = 0x01000000
}
 
enum  { kOTSerialXOnOffInputHandshake , kOTSerialXOnOffOutputHandshake , kOTSerialCTSInputHandshake , kOTSerialDTROutputHandshake }
 
enum  {
  kOTSerialDefaultBaudRate = 19200 , kOTSerialDefaultDataBits = 8 , kOTSerialDefaultStopBits = 10 , kOTSerialDefaultParity = kOTSerialNoParity ,
  kOTSerialDefaultHandshake = 0 , kOTSerialDefaultOnChar = ('Q' & 0xFFFFFFBF) , kOTSerialDefaultOffChar = ('S' & 0xFFFFFFBF) , kOTSerialDefaultSndBufSize = 1024 ,
  kOTSerialDefaultRcvBufSize = 1024 , kOTSerialDefaultSndLoWat = 96 , kOTSerialDefaultRcvLoWat = 1 , kOTSerialDefaultRcvTimeout = 10
}
 
enum  { COM_ISDN = FOUR_CHAR_CODE('ISDN') }
 
enum  { kISDNModuleID = 7300 }
 
enum  { kOTISDNFramingTransparentSupported = 0x0010 , kOTISDNFramingHDLCSupported = 0x0020 , kOTISDNFramingV110Supported = 0x0040 , kOTISDNFramingV14ESupported = 0x0080 }
 
enum  {
  kOTISDNUnallocatedNumber = 1 , kOTISDNNoRouteToSpecifiedTransitNetwork = 2 , kOTISDNNoRouteToDestination = 3 , kOTISDNChannelUnacceptable = 6 ,
  kOTISDNNormal = 16 , kOTISDNUserBusy = 17 , kOTISDNNoUserResponding = 18 , kOTISDNNoAnswerFromUser = 19 ,
  kOTISDNCallRejected = 21 , kOTISDNNumberChanged = 22 , kOTISDNNonSelectedUserClearing = 26 , kOTISDNDestinationOutOfOrder = 27 ,
  kOTISDNInvalidNumberFormat = 28 , kOTISDNFacilityRejected = 29 , kOTISDNNormalUnspecified = 31 , kOTISDNNoCircuitChannelAvailable = 34 ,
  kOTISDNNetworkOutOfOrder = 41 , kOTISDNSwitchingEquipmentCongestion = 42 , kOTISDNAccessInformationDiscarded = 43 , kOTISDNRequestedCircuitChannelNotAvailable = 44 ,
  kOTISDNResourceUnavailableUnspecified = 45 , kOTISDNQualityOfServiceUnvailable = 49 , kOTISDNRequestedFacilityNotSubscribed = 50 , kOTISDNBearerCapabilityNotAuthorized = 57 ,
  kOTISDNBearerCapabilityNotPresentlyAvailable = 58 , kOTISDNCallRestricted = 59 , kOTISDNServiceOrOptionNotAvilableUnspecified = 63 , kOTISDNBearerCapabilityNotImplemented = 65 ,
  kOTISDNRequestedFacilityNotImplemented = 69 , kOTISDNOnlyRestrictedDigitalBearer = 70 , kOTISDNServiceOrOptionNotImplementedUnspecified = 79 , kOTISDNCallIdentityNotUsed = 83 ,
  kOTISDNCallIdentityInUse = 84 , kOTISDNNoCallSuspended = 85 , kOTISDNCallIdentityCleared = 86 , kOTISDNIncompatibleDestination = 88 ,
  kOTISDNInvalidTransitNetworkSelection = 91 , kOTISDNInvalidMessageUnspecified = 95 , kOTISDNMandatoryInformationElementIsMissing = 96 , kOTISDNMessageTypeNonExistentOrNotImplemented = 97 ,
  kOTISDNInterworkingUnspecified = 127
}
 
enum  { kAF_ISDN = 0x2000 }
 
enum  { AF_ISDN = kAF_ISDN }
 
enum  { kOTISDNMaxPhoneSize = 32 , kOTISDNMaxSubSize = 4 }
 
enum  { MIOC_ISDN = 'U' }
 
enum  {
  I_OTISDNAlerting , I_OTISDNSuspend = ((MIOC_ISDN << 8) | 101) , I_OTISDNSuspendAcknowledge , I_OTISDNSuspendReject ,
  I_OTISDNResume = ((MIOC_ISDN << 8) | 104) , I_OTISDNResumeAcknowledge , I_OTISDNResumeReject , I_OTISDNFaciltity
}
 
enum  { kOTISDNMaxUserDataSize = 32 }
 
enum  { ISDN_OPT_COMMTYPE = 0x0200 , ISDN_OPT_FRAMINGTYPE = 0x0201 , ISDN_OPT_56KADAPTATION = 0x0202 }
 
enum  {
  kOTISDNTelephoneALaw = 1 , kOTISDNTelephoneMuLaw = 26 , kOTISDNDigital64k = 13 , kOTISDNDigital56k = 37 ,
  kOTISDNVideo64k = 41 , kOTISDNVideo56k = 42
}
 
enum  { kOTISDNFramingTransparent = 0x0010 , kOTISDNFramingHDLC = 0x0020 , kOTISDNFramingV110 = 0x0040 , kOTISDNFramingV14E = 0x0080 }
 
enum  { kOTISDNNot56KAdaptation = false , kOTISDN56KAdaptation = true }
 
enum  { kOTISDNDefaultCommType = kOTISDNDigital64k , kOTISDNDefaultFramingType = kOTISDNFramingHDLC , kOTISDNDefault56KAdaptation = kOTISDNNot56KAdaptation }
 
enum  { COM_PPP = FOUR_CHAR_CODE('PPPC') }
 
enum  { kPPPMaxIDLength = 255 , kPPPMaxPasswordLength = 255 , kPPPMaxDTEAddressLength = 127 , kPPPMaxCallInfoLength = 255 }
 
enum  {
  kPPPStateInitial = 1 , kPPPStateClosed = 2 , kPPPStateClosing = 3 , kPPPStateOpening = 4 ,
  kPPPStateOpened = 5
}
 
enum  { kPPPConnectionStatusIdle = 1 , kPPPConnectionStatusConnecting = 2 , kPPPConnectionStatusConnected = 3 , kPPPConnectionStatusDisconnecting = 4 }
 
enum  { kPPPMinMRU = 0 , kPPPMaxMRU = 4500 }
 
enum  { kIPCPTCPHdrCompressionDisabled = 0 , kIPCPTCPHdrCompressionEnabled = 1 }
 
enum  { kPPPCompressionDisabled = 0x00000000 , kPPPProtoCompression = 0x00000001 , kPPPAddrCompression = 0x00000002 }
 
enum  { kPPPNoOutAuthentication = 0 , kPPPCHAPOrPAPOutAuthentication = 1 }
 
enum  { kCCReminderTimerDisabled = 0 , kCCIPIdleTimerDisabled = 0 }
 
enum  { kPPPScriptTypeModem = 1 , kPPPScriptTypeConnect = 2 , kPPPMaxScriptSize = 32000 }
 
enum  { kE164Address = 1 , kPhoneAddress = 1 , kCompoundPhoneAddress = 2 , kX121Address = 3 }
 
enum  {
  kPPPConnectionStatusDialogsFlag = 0x00000001 , kPPPConnectionRemindersFlag = 0x00000002 , kPPPConnectionFlashingIconFlag = 0x00000004 , kPPPOutPasswordDialogsFlag = 0x00000008 ,
  kPPPAllAlertsDisabledFlag = 0x00000000 , kPPPAllAlertsEnabledFlag = 0x0000000F
}
 
enum  { kPPPAsyncMapCharsNone = 0x00000000 , kPPPAsyncMapCharsXOnXOff = 0x000A0000 , kPPPAsyncMapCharsAll = (unsigned long)0xFFFFFFFF }
 
enum  {
  IPCP_OPT_GETREMOTEPROTOADDR = 0x00007000 , IPCP_OPT_GETLOCALPROTOADDR = 0x00007001 , IPCP_OPT_TCPHDRCOMPRESSION = 0x00007002 , LCP_OPT_PPPCOMPRESSION = 0x00007003 ,
  LCP_OPT_MRU = 0x00007004 , LCP_OPT_RCACCMAP = 0x00007005 , LCP_OPT_TXACCMAP = 0x00007006 , SEC_OPT_OUTAUTHENTICATION = 0x00007007 ,
  SEC_OPT_ID = 0x00007008 , SEC_OPT_PASSWORD = 0x00007009 , CC_OPT_REMINDERTIMER = 0x00007010 , CC_OPT_IPIDLETIMER = 0x00007011 ,
  CC_OPT_DTEADDRESSTYPE = 0x00007012 , CC_OPT_DTEADDRESS = 0x00007013 , CC_OPT_CALLINFO = 0x00007014 , CC_OPT_GETMISCINFO = 0x00007015 ,
  PPP_OPT_GETCURRENTSTATE = 0x00007016 , LCP_OPT_ECHO = 0x00007017 , CC_OPT_SERIALPORTNAME = 0x00007200
}
 
enum  {
  kPPPEvent = kPROTOCOLEVENT | 0x000F0000 , kPPPConnectCompleteEvent = kPPPEvent + 1 , kPPPSetScriptCompleteEvent = kPPPEvent + 2 , kPPPDisconnectCompleteEvent = kPPPEvent + 3 ,
  kPPPDisconnectEvent = kPPPEvent + 4 , kPPPIPCPUpEvent = kPPPEvent + 5 , kPPPIPCPDownEvent = kPPPEvent + 6 , kPPPLCPUpEvent = kPPPEvent + 7 ,
  kPPPLCPDownEvent = kPPPEvent + 8 , kPPPLowerLayerUpEvent = kPPPEvent + 9 , kPPPLowerLayerDownEvent = kPPPEvent + 10 , kPPPAuthenticationStartedEvent = kPPPEvent + 11 ,
  kPPPAuthenticationFinishedEvent = kPPPEvent + 12 , kPPPDCEInitStartedEvent = kPPPEvent + 13 , kPPPDCEInitFinishedEvent = kPPPEvent + 14 , kPPPDCECallStartedEvent = kPPPEvent + 15 ,
  kPPPDCECallFinishedEvent = kPPPEvent + 16
}
 
enum  { kDialToneNormal = 0 , kDialToneIgnore = 1 , kDialToneManual = 2 }
 
enum  { kRAProductClientOnly = 2 , kRAProductOnePortServer = 3 , kRAProductManyPortServer = 4 }
 

Functions

void OTInitInetAddress (InetAddress *addr, InetPort port, InetHost host)
 
OTByteCount OTInitDNSAddress (DNSAddress *addr, char *str)
 
OSStatus OTInetStringToHost (const char *str, InetHost *host)
 
void OTInetHostToString (InetHost host, char *str)
 
OSStatus OTInetGetInterfaceInfo (InetInterfaceInfo *info, SInt32 val)
 
OSStatus OTInetGetSecondaryAddresses (InetHost *addr, UInt32 *count, SInt32 val)
 
OSStatus OTInetGetDHCPConfigInfo (InetDHCPOption *buf, UInt32 bufSize, SInt32 index, SInt32 opt)
 
InetSvcRef OTOpenInternetServicesInContext (OTConfigurationRef cfig, OTOpenFlags oflag, OSStatus *err, OTClientContextPtr clientContext)
 
OSStatus OTAsyncOpenInternetServicesInContext (OTConfigurationRef cfig, OTOpenFlags oflag, OTNotifyUPP upp, void *contextPtr, OTClientContextPtr clientContext)
 
InetSvcRef OTOpenInternetServices (OTConfigurationRef cfig, OTOpenFlags oflag, OSStatus *err)
 
OSStatus OTAsyncOpenInternetServices (OTConfigurationRef cfig, OTOpenFlags oflag, OTNotifyUPP proc, void *contextPtr)
 
OSStatus OTInetStringToAddress (InetSvcRef ref, char *name, InetHostInfo *hinfo)
 
OSStatus OTInetAddressToName (InetSvcRef ref, InetHost addr, InetDomainName name)
 
OSStatus OTInetSysInfo (InetSvcRef ref, char *name, InetSysInfo *sysinfo)
 
OSStatus OTInetMailExchange (InetSvcRef ref, char *name, UInt16 *num, InetMailExchange *mx)
 
OSStatus OTInetQuery (InetSvcRef ref, char *name, UInt16 qClass, UInt16 qType, char *buf, OTByteCount buflen, void **argv, OTByteCount argvlen, OTFlags flags)
 
OSStatus OTAsyncOpenAppleTalkServicesInContext (OTConfigurationRef cfig, OTOpenFlags flags, OTNotifyUPP proc, void *contextPtr, OTClientContextPtr clientContext)
 
ATSvcRef OTOpenAppleTalkServicesInContext (OTConfigurationRef cfig, OTOpenFlags flags, OSStatus *err, OTClientContextPtr clientContext)
 
OSStatus OTAsyncOpenAppleTalkServices (OTConfigurationRef cfig, OTOpenFlags flags, OTNotifyUPP proc, void *contextPtr)
 
ATSvcRef OTOpenAppleTalkServices (OTConfigurationRef cfig, OTOpenFlags flags, OSStatus *err)
 
OSStatus OTATalkGetMyZone (ATSvcRef ref, TNetbuf *zone)
 
OSStatus OTATalkGetLocalZones (ATSvcRef ref, TNetbuf *zones)
 
OSStatus OTATalkGetZoneList (ATSvcRef ref, TNetbuf *zones)
 
OSStatus OTATalkGetInfo (ATSvcRef ref, TNetbuf *info)
 
void OTInitDDPAddress (DDPAddress *addr, UInt16 net, UInt8 node, UInt8 socket, UInt8 ddpType)
 
OTByteCount OTInitNBPAddress (NBPAddress *addr, const char *name)
 
OTByteCount OTInitDDPNBPAddress (DDPNBPAddress *addr, const char *name, UInt16 net, UInt8 node, UInt8 socket, UInt8 ddpType)
 
Boolean OTCompareDDPAddresses (const DDPAddress *addr1, const DDPAddress *addr2)
 
void OTInitNBPEntity (NBPEntity *entity)
 
OTByteCount OTGetNBPEntityLengthAsAddress (const NBPEntity *entity)
 
OTByteCount OTSetAddressFromNBPEntity (UInt8 *nameBuf, const NBPEntity *entity)
 
OTByteCount OTSetAddressFromNBPString (UInt8 *addrBuf, const char *name, SInt32 len)
 
Boolean OTSetNBPEntityFromAddress (NBPEntity *entity, const UInt8 *addrBuf, OTByteCount len)
 
Boolean OTSetNBPName (NBPEntity *entity, const char *name)
 
Boolean OTSetNBPType (NBPEntity *entity, const char *typeVal)
 
Boolean OTSetNBPZone (NBPEntity *entity, const char *zone)
 
void OTExtractNBPName (const NBPEntity *entity, char *name)
 
void OTExtractNBPType (const NBPEntity *entity, char *typeVal)
 
void OTExtractNBPZone (const NBPEntity *entity, char *zone)
 

Detailed Description

This file contains provider-specific definitions for various built-in providers.

Introduced In: 2.5
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1993-2001 by Apple Computer, Inc. and Mentat Inc., all rights
reserved.

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

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

Macro Definition Documentation

◆ AF_INET

#define AF_INET   2

Enums used as address type designations.

◆ gestaltOpenTptModem

#define gestaltOpenTptModem   'otmo'

To check if the Modem/Script engine is installed you should interrogate the proper Gestalt Selectors for Open Transport-based Modem libraries.

◆ kATalkVersion

#define kATalkVersion   "1.1"

!OTKERNEL ***** AppleTalk Shared library prefixes

◆ kDDPName

#define kDDPName   "ddp"

Module Names

◆ kDefaultModemPrefsFileName

#define kDefaultModemPrefsFileName   "\pModem Preferences"

File name to use only if the internationalized one can't be read from the resource fork.

◆ kDNRName

#define kDNRName   "dnr"

Module Names

◆ kEnet8022Name

#define kEnet8022Name   "enet8022x"

Module Names

◆ kInetVersion

#define kInetVersion   "3.1.1"

Shared library prefixes

◆ kISDNName

#define kISDNName   "isdn"

Module Names

◆ kMaxScriptNameSize

#define kMaxScriptNameSize   64

Maximum script file name size. Same as "name" field of FSSpec.

◆ kModemConfigFileCreator

#define kModemConfigFileCreator   'modm'

The Modem Configuration pref resource file constants.

◆ kModemConfigTypeModem

#define kModemConfigTypeModem   'ccl ' /** Type for Modem config resource */

Configuration resource constants.

◆ kModemNoError

#define kModemNoError   0

These are the Modem/Script Configurator error codes. Other codes may be returned from Open Transport and operating system routines.

◆ kPPPControlName

#define kPPPControlName   "ppp"

OTCreateConfiguration name for PPP control endpoint

◆ kScriptName

#define kScriptName   "Script"

Support for modem script endpoints: The Configuration name for the Opentransport Modem/Script engine.

◆ kSerialABName

#define kSerialABName   "serialAB"

Module Names

◆ kSerialABVersion

#define kSerialABVersion   "1.1.1"

Version Number

◆ OTCompare48BitAddresses

#define OTCompare48BitAddresses (   p1,
  p2 
)
Value:
(*(const UInt32 *)((const UInt8 *)(p1)) == \
*(const UInt32 *)((const UInt8 *)(p2)) && \
*(const UInt16 *)(((const UInt8 *)(p1)) + 4) == \
*(const UInt16 *)(((const UInt8 *)(p2)) + 4))

Some helpful stuff for dealing with 48 bit addresses

◆ OTCompare8022SNAP

#define OTCompare8022SNAP (   p1,
  p2 
)
Value:
(*(const UInt32 *)((const UInt8 *)(p1)) == \
*(const UInt32 *)((const UInt8 *)(p2)) && \
*(((const UInt8 *)(p1)) + 4) == *(((const UInt8 *)(p2)) + 4))

◆ OTCopy48BitAddress

#define OTCopy48BitAddress (   p1,
  p2 
)
Value:
(*(UInt32 *)((UInt8 *)(p2)) = *(const UInt32 *)((const UInt8 *)(p1)), \
*(UInt16 *)(((UInt8 *)(p2)) + 4) = \
*(const UInt16 *)(((const UInt8 *)(p1)) + 4))

◆ OTCopy8022SNAP

#define OTCopy8022SNAP (   p1,
  p2 
)
Value:
(*(UInt32 *)((UInt8 *)(p2)) = *(const UInt32 *)((const UInt8 *)(p1)), \
*(((UInt8 *)(p2)) + 4) = *(((const UInt8 *)(p1)) + 4))

◆ OTCopyDDPAddress

#define OTCopyDDPAddress (   addr,
  dest 
)
Value:
{ \
((UInt32 *)(dest))[0] = ((UInt32 *)(addr))[0]; \
((UInt32 *)(dest))[1] = ((UInt32 *)(addr))[1]; \
}

◆ OTIs48BitBroadcastAddress

#define OTIs48BitBroadcastAddress (   p1)
Value:
(*(UInt32 *)((UInt8 *)(p1)) == 0xffffffff && \
*(UInt16 *)(((UInt8 *)(p1)) + 4) == 0xffff)

◆ OTSet48BitBroadcastAddress

#define OTSet48BitBroadcastAddress (   p1)
Value:
(*(UInt32 *)((UInt8 *)(p1)) = 0xffffffff, \
*(UInt16 *)(((UInt8 *)(p1)) + 4) = 0xffff)

Typedef Documentation

◆ ATSvcRef

typedef void* ATSvcRef

Define the ATSvcRef type. This type needs special processing because in C++ it's a subclass of TProvider. See the definition of TEndpointRef in "OpenTransport.h" for the logic behind this definition.

◆ InetPort

typedef UInt16 InetPort

***** TCP/IP Basic types

◆ InetSvcRef

typedef void* InetSvcRef

Define the InetSvcRef type. This type needs special processing because in C++ it's a subclass of TProvider. See the definition of TEndpointRef in "OpenTransport.h" for the logic behind this definition.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enum which can be used to bind to all IP interfaces rather than a specific one.

◆ anonymous enum

anonymous enum

XTI Options Protocol levels

◆ anonymous enum

anonymous enum

TCP Level Options

◆ anonymous enum

anonymous enum

UDP Level Options

◆ anonymous enum

anonymous enum

IP Level Options

Enumerator
kIP_MULTICAST_TTL 

set/get IP multicast interface

kIP_MULTICAST_LOOP 

set/get IP multicast timetolive

kIP_ADD_MEMBERSHIP 

set/get IP multicast loopback

kIP_DROP_MEMBERSHIP 

add an IP group membership

kIP_BROADCAST_IFNAME 

drop an IP group membership

kIP_RCVIFADDR 

Set interface for broadcasts

◆ anonymous enum

anonymous enum
Enumerator
IP_MULTICAST_TTL 

set/get IP multicast interface

IP_MULTICAST_LOOP 

set/get IP multicast timetolive

IP_ADD_MEMBERSHIP 

set/get IP multicast loopback

IP_DROP_MEMBERSHIP 

add an IP group membership

IP_BROADCAST_IFNAME 

drop an IP group membership

IP_RCVIFADDR 

Set interface for broadcasts

◆ anonymous enum

anonymous enum
Enumerator
DVMRP_DONE 

DVMRP-specific setsockopt commands, from ip_mroute.h

◆ anonymous enum

anonymous enum

IP_TOS precdence levels

◆ anonymous enum

anonymous enum

IP_TOS type of service

◆ anonymous enum

anonymous enum

Protocol-specific events

◆ anonymous enum

anonymous enum

Domain Name Resolver (DNR)

◆ anonymous enum

anonymous enum

◆ anonymous enum

anonymous enum

◆ anonymous enum

anonymous enum

XTI Levels

◆ anonymous enum

anonymous enum

Protocol-specific Options NOTE: All Protocols support OPT_CHECKSUM (Value is (unsigned long)T_YES/T_NO) ATP supports OPT_RETRYCNT (# Retries, 0 = try once) and OPT_INTERVAL (# Milliseconds to wait)

Enumerator
ATP_OPT_REPLYCNT 

DDP UnitDataReq Only - set src address, Value is DDPAddress

ATP_OPT_DATALEN 

AppleTalk - ATP Resp Pkt Ct Type, Value is (unsigned long) pkt count

ATP_OPT_RELTIMER 

AppleTalk - ATP Pkt Data Len Type, Value is (unsigned long) length

ATP_OPT_TRANID 

AppleTalk - ATP Release Timer Type, Value is (unsigned long) timer, (See Inside AppleTalk, second edition

PAP_OPT_OPENRETRY 

Value is (unsigned long) Boolean, Used to request Transaction ID, Returned with Transaction ID on requests

◆ anonymous enum

anonymous enum

Protocol-Specific Events If you send the IOCTL: OTIoctl(I_OTGetMiscellaneousEvents, 1), you will receive the T_ATALKxxx events on your endpoint. NOTE: The endpoint does not need to be bound.

Enumerator
T_ATALKROUTERUPEVENT 

No routers have been seen for a while. If the cookie is NULL, all routers are gone. Otherwise, there is still an ARA router hanging around being used, and only the local cable has been timed out.

T_ATALKZONENAMECHANGEDEVENT 

We didn't have a router, but now one has come up. Cookie is NULL for a normal router coming up, non-NULL for an ARA router coming on-line

T_ATALKCONNECTIVITYCHANGEDEVENT 

A Zone name change was issued from the router, so our AppleTalk Zone has changed.

T_ATALKINTERNETAVAILABLEEVENT 

An ARA connection was established (cookie != NULL), or was disconnected (cookie == NULL)

T_ATALKCABLERANGECHANGEDEVENT 

A router has appeared, and our address is in the startup range. Cookie is hi/lo of new cable range.

◆ anonymous enum

anonymous enum
Enumerator
kLocalATalkRoutersDown 

This indicates that all routers are offline

kARARouterDisconnected 

This indicates that all local routers went offline, but an ARA router is still active

◆ anonymous enum

anonymous enum
Enumerator
kATalkRouterOnline 

We had no local routers, but an ARA router is now online.

kLocalATalkRouterOnline 

We had no routers, but a local router is now online

◆ anonymous enum

anonymous enum

Protocol-specific IOCTLs

Enumerator
ADSP_IOC_FORWARDRESET 

Turn on/off full self-send (it's automatic for non-backward-compatible links)

◆ anonymous enum

anonymous enum

Protocol-specific constants ECHO

◆ anonymous enum

anonymous enum

NBP

Enumerator
kNBPMaxEntityLength 

Extra space for @, : and a few escape chars

kNBPImbeddedWildCard 

NBP name and type match anything '='

kNBPDefaultZone 

NBP name and type match some '©'

◆ anonymous enum

anonymous enum

ZIP

◆ anonymous enum

anonymous enum
Enumerator
kNBPAddressLength 

value to use in netbuf.len field, Maximum length of AppleTalk address

◆ anonymous enum

anonymous enum

_cplus !OTKERNEL AppleTalk Addressing The NBPEntity structure is used to manipulate NBP names without regard to issues of what kind of "special" characters are in the name.

When stored as an address in an NBPAddress or DDPNBPAddress, they are stored as a character string, which is currently just ASCII, but in the future may be UniChar, or some other internationalizable scripting set. The string following an NBPAddress or DDPNBPAddress is intended to be suitable for showing to users, whereas NBPEntity is not. WARNING: NBPAddress and DDPNBPAddress structures do not "know" the length of the address. That must have been obtained as part of a Lookup or ResolveAddress call.

◆ anonymous enum

anonymous enum

For the fFlags field in AppleTalkInfo

Enumerator
kATalkInfoHasRouter 

This is an extended (phase 2) network

kATalkInfoOneZone 

This cable has a router

◆ anonymous enum

anonymous enum

***** Ethernet Interface option flags Ethernet framing options

◆ anonymous enum

anonymous enum

These are obsolete and will be going away in OT 1.5. Hmmm, OT 1.5 got cancelled. The status of these options is uncertain. RawMode options

◆ anonymous enum

anonymous enum

Module definitions Module IDs

◆ anonymous enum

anonymous enum

Address Family

◆ anonymous enum

anonymous enum

XTI Levels

◆ anonymous enum

anonymous enum

Options

◆ anonymous enum

anonymous enum

Link related constants

Enumerator
k48BitAddrLength 

length of an ENET hardware addressaddress

k8022SNAPLength 

The protocol type is our DLSAP

kSNAPSAP 

length of an address field used by the ENET enpoint = k48BitAddrLength + sizeof(protocol type)

kIPXSAP 

Special DLSAPS for ENET

◆ anonymous enum

anonymous enum

Link related constants

Enumerator
kTokenRingTSDU 

The TSDU for ethernet.

kFDDITSDU 

The TSDU for TokenRing.

k8022SAPLength 

The TSDU for FDDI.

k8022SNAPHeaderLength 

define the length of the header portion of an 802.2 packet. = SSAP+DSAP+ControlByte

◆ anonymous enum

anonymous enum

Define the lengths of the structures above

◆ anonymous enum

anonymous enum

***** Serial Module Definitions XTI Level

◆ anonymous enum

anonymous enum
Enumerator
kOTSerialFramingHDLC 

Support Async serial mode

kOTSerialFramingSDLC 

Support HDLC synchronous serial mode

kOTSerialFramingAsyncPackets 

Support SDLC synchronous serial mode

kOTSerialFramingPPP 

Support Async "packet" serial mode

◆ anonymous enum

anonymous enum

IOCTL Calls for Serial Drivers

Enumerator
kOTSerialSetDTROff 

Set DTR (0 = off, 1 = on)

kOTSerialSetBreakOn 

Send a break on the line - kOTSerialSetBreakOff = off, kOTSerialSetBreakOn = on, Any other number is the number of milliseconds to leave break on, then auto shutoff

kOTSerialForceXOffTrue 

Force XOFF state - 0 = Unconditionally clear XOFF state, 1 = unconditionally set it

kOTSerialSendXOnAlways 

Send an XON character, 0 = send only if in XOFF state, 1 = send always

kOTSerialSendXOffAlways 

Send an XOFF character, 0 = send only if in XON state, 1 = send always

◆ anonymous enum

anonymous enum

Option Management for Serial Drivers These options are all 4-byte values. BaudRate is the baud rate. DataBits is the number of data bits. StopBits is the number of stop bits times 10. Parity is an enum

Enumerator
SERIAL_OPT_DATABITS 

UInt32

SERIAL_OPT_STOPBITS 

UInt32

SERIAL_OPT_PARITY 

UInt32 10, 15 or 20 for 1, 1.5 or 2

SERIAL_OPT_STATUS 

UInt32

SERIAL_OPT_HANDSHAKE 

UInt32 The "Status" option is a 4-byte value option that is ReadOnly It returns a bitmap of the current serial status

SERIAL_OPT_RCVTIMEOUT 

UInt32 The "Handshake" option defines what kind of handshaking the serial port will do for line flow control. The value is a 32-bit value defined by the function or macro SerialHandshakeData below. For no handshake, or CTS handshake, the onChar and offChar parameters are ignored.

SERIAL_OPT_ERRORCHARACTER 

The "RcvTimeout" option defines how long the receiver should wait before delivering less than the RcvLoWat number of characters. If RcvLoWat is 0, then the RcvTimeout is how long a gap to wait for before delivering characters. This parameter is advisory, and serial drivers are free to deliver data whenever they deem it convenient. For instance, many serial drivers will deliver data whenever 64 bytes have been received, since 64 bytes is the smallest STREAMS buffer size. Keep in mind that timeouts are quantized, so be sure to look at the return value of the option to determine what it was negotiated to.

SERIAL_OPT_EXTCLOCK 

This option defines how characters with parity errors are handled. A 0 value will disable all replacement. A single character value in the low byte designates the replacement character. When characters are received with a parity error, they are replaced by this specified character. If a valid incoming character matches the replacement character, then the received character's msb is cleared. For this situation, the alternate character is used, if specified in bits 8 through 15 of the option long, with 0xff being place in bits 16 through 23. Whenever a valid character is received that matches the first replacement character, it is replaced with this alternate character.

SERIAL_OPT_BURSTMODE 

The "ExtClock" requests an external clock. A 0-value turns off external clocking. Any other value is a requested divisor for the external clock. Be aware that not all serial implementations support an external clock, and that not all requested divisors will be supported if it does support an external clock.

SERIAL_OPT_DUMMY 

The "BurstMode" option informs the serial driver that it should continue looping, reading incoming characters, rather than waiting for an interrupt for each character. This option may not be supported by all Serial driver

◆ anonymous enum

anonymous enum
Enumerator
kOTSerialXOnOffOutputHandshake 

Want XOn/XOff handshake for incoming characters

kOTSerialCTSInputHandshake 

Want XOn/XOff handshake for outgoing characters

kOTSerialDTROutputHandshake 

Want CTS handshake for incoming characters

◆ anonymous enum

anonymous enum

Default attributes for the serial ports

◆ anonymous enum

anonymous enum

***** ISDN Module Definitions XTI Level

◆ anonymous enum

anonymous enum

ISDN framing methods, set using the I_OTSetFramingType IOCTL

Enumerator
kOTISDNFramingHDLCSupported 

Support Transparent mode

kOTISDNFramingV110Supported 

Support HDLC Synchronous mode

kOTISDNFramingV14ESupported 

Support V.110 Asynchronous mode

◆ anonymous enum

anonymous enum

Miscellaneous equates Disconnect reason codes (from Q.931)

◆ anonymous enum

anonymous enum

OTISDNAddress The OTISDNAddress has the following format: "xxxxxx*yy" where 'x' is the phone number and 'y' is the sub address (if available in the network. The characters are coded in ASCII (IA5), and valid characters are: '0'-'9','#','*'. The max length of the each phone number is 21 characters (?) and the max subaddress length is network dependent. When using bonded channels the phone numbers are separated by '&'. The X.25 user data is preceded by '@'.

◆ anonymous enum

anonymous enum

IOCTL Calls for ISDN ISDN shares the same ioctl space as serial.

◆ anonymous enum

anonymous enum
Enumerator
I_OTISDNSuspend 

Send or receive an ALERTING message

I_OTISDNSuspendAcknowledge 

Send a SUSPEND message The parameter is the Call Identity (Maximum 8 octets)

I_OTISDNSuspendReject 

Receive a SUSPEND ACKNOWLEDGE message

I_OTISDNResume 

Receive a SUSPEND REJECT message

I_OTISDNResumeAcknowledge 

Send a RESUME message The parameter is the Call Identity (Maximum 8 octets)

I_OTISDNResumeReject 

Receive a RESUME ACKNOWLEDGE message

I_OTISDNFaciltity 

Receive a RESUME REJECT message

◆ anonymous enum

anonymous enum

Connect user data size

◆ anonymous enum

anonymous enum

Option management calls for ISDN

◆ anonymous enum

anonymous enum

For ISDN_OPT_COMMTYPE...

Enumerator
kOTISDNTelephoneMuLaw 

G.711 A-law

kOTISDNDigital64k 

G.711 ©-law

kOTISDNDigital56k 

unrestricted digital (default)

kOTISDNVideo64k 

user rate 56Kb/s

kOTISDNVideo56k 

video terminal at 64Kb/s

◆ anonymous enum

anonymous enum

For ISDN_OPT_FRAMINGTYPE...

Enumerator
kOTISDNFramingHDLC 

Transparent mode

kOTISDNFramingV110 

HDLC synchronous mode (default)

kOTISDNFramingV14E 

V.110 asynchronous mode

◆ anonymous enum

anonymous enum

For ISDN_OPT_56KADAPTATION...

Enumerator
kOTISDN56KAdaptation 

not 56K Adaptation (default)

◆ anonymous enum

anonymous enum

Default options, you do not need to set these

◆ anonymous enum

anonymous enum

XTI Level

◆ anonymous enum

anonymous enum

Options limits

◆ anonymous enum

anonymous enum

Various XTI option value constants

◆ anonymous enum

anonymous enum

Option names

Enumerator
CC_OPT_SERIALPORTNAME 

Available on Mac OS X only

◆ anonymous enum

anonymous enum

Endpoint events

◆ anonymous enum

anonymous enum

Dial tone modes

Function Documentation

◆ OTAsyncOpenAppleTalkServices()

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

OTAsyncOpenAppleTalkServices()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ OTAsyncOpenAppleTalkServicesInContext()

OSStatus OTAsyncOpenAppleTalkServicesInContext ( OTConfigurationRef  cfig,
OTOpenFlags  flags,
OTNotifyUPP  proc,
void *  contextPtr,
OTClientContextPtr  clientContext 
)

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

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTAsyncOpenInternetServices()

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

OTAsyncOpenInternetServices()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ OTAsyncOpenInternetServicesInContext()

OSStatus OTAsyncOpenInternetServicesInContext ( OTConfigurationRef  cfig,
OTOpenFlags  oflag,
OTNotifyUPP  upp,
void *  contextPtr,
OTClientContextPtr  clientContext 
)

OTAsyncOpenInternetServicesInContext()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTATalkGetInfo()

OSStatus OTATalkGetInfo ( ATSvcRef  ref,
TNetbuf info 
)

Stores an AppleTalkInfo structure into the TNetbuf (see later in this file) OTATalkGetInfo()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0.2 and later
Mac OS X: in version 10.0 and later

◆ OTATalkGetLocalZones()

OSStatus OTATalkGetLocalZones ( ATSvcRef  ref,
TNetbuf zones 
)

Get the list of available zones associated with the local cable of the ATSvcRef OTATalkGetLocalZones()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0.2 and later
Mac OS X: in version 10.0 and later

◆ OTATalkGetMyZone()

OSStatus OTATalkGetMyZone ( ATSvcRef  ref,
TNetbuf zone 
)

CALL_NOT_IN_CARBON OTCARBONAPPLICATION Get the zone associated with the ATSvcRef OTATalkGetMyZone()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0.2 and later
Mac OS X: in version 10.0 and later

◆ OTATalkGetZoneList()

OSStatus OTATalkGetZoneList ( ATSvcRef  ref,
TNetbuf zones 
)

Get the list of all zones on the internet specified by the ATSvcRef OTATalkGetZoneList()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0.2 and later
Mac OS X: in version 10.0 and later

◆ OTCompareDDPAddresses()

Boolean OTCompareDDPAddresses ( const DDPAddress addr1,
const DDPAddress addr2 
)

Compare 2 DDP addresses for equality OTCompareDDPAddresses()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTExtractNBPName()

void OTExtractNBPName ( const NBPEntity entity,
char *  name 
)

Routines to extract pieces of an NBP entity OTExtractNBPName()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTExtractNBPType()

void OTExtractNBPType ( const NBPEntity entity,
char *  typeVal 
)

OTExtractNBPType()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTExtractNBPZone()

void OTExtractNBPZone ( const NBPEntity entity,
char *  zone 
)

OTExtractNBPZone()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTGetNBPEntityLengthAsAddress()

OTByteCount OTGetNBPEntityLengthAsAddress ( const NBPEntity entity)

Get the length an NBPEntity would have when stored as an address OTGetNBPEntityLengthAsAddress()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetAddressToName()

OSStatus OTInetAddressToName ( InetSvcRef  ref,
InetHost  addr,
InetDomainName  name 
)

OTInetAddressToName()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetGetDHCPConfigInfo()

OSStatus OTInetGetDHCPConfigInfo ( InetDHCPOption buf,
UInt32  bufSize,
SInt32  index,
SInt32  opt 
)

OTInetGetDHCPConfigInfo()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ OTInetGetInterfaceInfo()

OSStatus OTInetGetInterfaceInfo ( InetInterfaceInfo info,
SInt32  val 
)

OTInetGetInterfaceInfo()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetGetSecondaryAddresses()

OSStatus OTInetGetSecondaryAddresses ( InetHost *  addr,
UInt32 *  count,
SInt32  val 
)

OTInetGetSecondaryAddresses()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetHostToString()

void OTInetHostToString ( InetHost  host,
char *  str 
)

OTInetHostToString()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetMailExchange()

OSStatus OTInetMailExchange ( InetSvcRef  ref,
char *  name,
UInt16 *  num,
InetMailExchange mx 
)

OTInetMailExchange()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetQuery()

OSStatus OTInetQuery ( InetSvcRef  ref,
char *  name,
UInt16  qClass,
UInt16  qType,
char *  buf,
OTByteCount  buflen,
void **  argv,
OTByteCount  argvlen,
OTFlags  flags 
)

OTInetQuery()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetStringToAddress()

OSStatus OTInetStringToAddress ( InetSvcRef  ref,
char *  name,
InetHostInfo hinfo 
)

CALL_NOT_IN_CARBON OTCARBONAPPLICATION OTInetStringToAddress()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetStringToHost()

OSStatus OTInetStringToHost ( const char *  str,
InetHost *  host 
)

OTInetStringToHost()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInetSysInfo()

OSStatus OTInetSysInfo ( InetSvcRef  ref,
char *  name,
InetSysInfo sysinfo 
)

OTInetSysInfo()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInitDDPAddress()

void OTInitDDPAddress ( DDPAddress addr,
UInt16  net,
UInt8  node,
UInt8  socket,
UInt8  ddpType 
)

These are some utility routines for dealing with NBP and DDP addresses. Functions to initialize the various AppleTalk Address types OTInitDDPAddress()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInitDDPNBPAddress()

OTByteCount OTInitDDPNBPAddress ( DDPNBPAddress addr,
const char *  name,
UInt16  net,
UInt8  node,
UInt8  socket,
UInt8  ddpType 
)

OTInitDDPNBPAddress()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInitDNSAddress()

OTByteCount OTInitDNSAddress ( DNSAddress addr,
char *  str 
)

OTInitDNSAddress()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInitInetAddress()

void OTInitInetAddress ( InetAddress addr,
InetPort  port,
InetHost  host 
)

TCP/IP Utility Routines OTInitInetAddress()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInitNBPAddress()

OTByteCount OTInitNBPAddress ( NBPAddress addr,
const char *  name 
)

OTInitNBPAddress()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTInitNBPEntity()

void OTInitNBPEntity ( NBPEntity entity)

Init an NBPEntity to a NULL name OTInitNBPEntity()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTOpenAppleTalkServices()

ATSvcRef OTOpenAppleTalkServices ( OTConfigurationRef  cfig,
OTOpenFlags  flags,
OSStatus *  err 
)

OTOpenAppleTalkServices()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ OTOpenAppleTalkServicesInContext()

ATSvcRef OTOpenAppleTalkServicesInContext ( OTConfigurationRef  cfig,
OTOpenFlags  flags,
OSStatus *  err,
OTClientContextPtr  clientContext 
)

OTOpenAppleTalkServicesInContext()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTOpenInternetServices()

InetSvcRef OTOpenInternetServices ( OTConfigurationRef  cfig,
OTOpenFlags  oflag,
OSStatus *  err 
)

OTOpenInternetServices()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ OTOpenInternetServicesInContext()

InetSvcRef OTOpenInternetServicesInContext ( OTConfigurationRef  cfig,
OTOpenFlags  oflag,
OSStatus *  err,
OTClientContextPtr  clientContext 
)

InetServices & DNR Calls CALL_NOT_IN_CARBON Under Carbon, OTOpenInternetServices routines take a client context pointer. Applications may pass NULL after calling InitOpenTransport(kInitOTForApplicationMask, ...). Non-applications must always pass a valid client context. OTOpenInternetServicesInContext()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTSetAddressFromNBPEntity()

OTByteCount OTSetAddressFromNBPEntity ( UInt8 *  nameBuf,
const NBPEntity entity 
)

Store an NBPEntity into an address buffer OTSetAddressFromNBPEntity()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTSetAddressFromNBPString()

OTByteCount OTSetAddressFromNBPString ( UInt8 *  addrBuf,
const char *  name,
SInt32  len 
)

Create an address buffer from a string (use -1 for len to use strlen) OTSetAddressFromNBPString()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTSetNBPEntityFromAddress()

Boolean OTSetNBPEntityFromAddress ( NBPEntity entity,
const UInt8 *  addrBuf,
OTByteCount  len 
)

Create an NBPEntity from an address buffer. False is returned if the address was truncated. OTSetNBPEntityFromAddress()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTSetNBPName()

Boolean OTSetNBPName ( NBPEntity entity,
const char *  name 
)

Routines to set a piece of an NBP entity from a character string OTSetNBPName()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTSetNBPType()

Boolean OTSetNBPType ( NBPEntity entity,
const char *  typeVal 
)

OTSetNBPType()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ OTSetNBPZone()

Boolean OTSetNBPZone ( NBPEntity entity,
const char *  zone 
)

OTSetNBPZone()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later