Manuals / Apple / Computer Equipment / Network Card

Apple manual Network Setup Protocol Structures and Data Types, TCP/IP Structures

Models: Network Setup

1 184

Download 184 pages 5.56 Kb

Page 111

Network Setup

C H A P T E R 4

Figure 4-0

Listing 4-0

Table 4-0

Network Setup

Protocol Structures and

Data Types

This chapter describes the structures and data types for protocols provided by Apple Computer.

Protocol Structures

This section describes the structures that organize the information in the Network Setup database.

■The section “TCP/IP Structures” (page 111) describes the structures used by TCP/IP preferences.

■The section “Apple Remote Access Structures” (page 122) describes the structures used by Apple Remote Access (ARA) preferences.

■The section “Modem Structures” (page 141) describes the structures used by modem preferences.

■The section “AppleTalk Structures” (page 144) describes the structures used by AppleTalk preferences.

■The section “Infrared Structures” (page 158) describes the structures used by Infrared preferences.

TCP/IP Structures

This section describes structures that store TCP/IP preferences. The structures are

■OTCfgTCPInterfacesUnpacked (page 112) stores information about the conﬁgured TCP/IP interfaces in unpacked format.

Protocol Structures

111

Image 111

Apple manual Network Setup Protocol Structures and Data Types, TCP/IP Structures

Contents

Network Setup I N S I D E M A C I N T O S H Apple Computer, Inc 2000 Apple Computer, Inc. All rights reserved About This Manual ContentsAbout Network Setup Using Network SetupChapter Network Setup ReferenceGlossary Index Chapter 4 Network Setup Protocol Structures and Data TypesPage Chapter About Network SetupUsing Network Setup Figures, Tables, and ListingsPage Conventions Used in This Manual About This ManualOpen Transport Advanced Client Programming, available at For More InformationInside AppleTalk, Second Edition Inside Macintosh Networking with Open TransportNetwork Setup Architecture About Network SetupThe architecture shown in Figure 1-1 had a number of drawbacks The following key points are to be taken from Figure Inside the Network Setup Library Mid-level database OTCfg About Network Setup Figure 1-4 Structure of the Network Setup LibraryInside the Network Setup Library High-level frameworkDatabase Structure Network Setup Database FundamentalsDatabase Structure Example LocalTalk for Printer AppleTalk networkork protocol entity About Network SetupFigure 1-5 Sample organization of the default area 18 Network Setup Database FundamentalsDatabase Operations Figure 1-6 shows this process diagrammatically Preference Coherency Legacy IssuesLegacy Synchronization Algorithm Network Setup Version History VersionMac OS version About Network Setup 24 Network Setup Version HistoryC H A P T E R Using Network Setup Opening and Closing the Network Setup DatabaseOpening the Database for Reading Opening the Database for Writing Using Network Setup Listing 2-1 Opening the database for reading26 Opening and Closing the Network Setup Database Using Network Setup Opening and Closing the Network Setup DatabaseListing 2-2 Opening the database for writing Closing the Database After Writing Closing the Database After Readingerr = OTCfgCommitAreaModificationsdbRef, readArea, writeArea Using Network SetupOpening and Closing the Network Setup Database Listing 2-4 Closing the database after writingListing All Entities Working with EntitiesCfgEntityInfo **entityInfos kCfgClassAnyEntity and kCfgTypeAnyEntity, respectivelystatic OSStatus MyGetEntitiesListCfgDatabaseRef dbRef, CfgAreaID area OSType entityClass OSType entityType CfgEntityRef **entityRefs32 Working with Entities Using Network SetupThe next routine, shown in Listing 2-6, opens the database for reading, gets the entity references for all of the TCP/IP network connection entities in the default area using the MyGetEntitiesList routine in Listing 2-5, and prints their user-visible names. This routine calls a routine, MyGetEntityUserVisibleName, which hasn’t been documented yet. It is shown in Listing 2-9 in the section “Reading and Writing Preferences” page Finding an Active Entity Reading and Writing PreferencesReading and Writing Preferences Reading Fixed-size PreferencesUsing Network Setup Listing 2-7 Reading a ﬁxed-size preferenceThe sample shown in Listing 2-7, which opens and closes the entity before reading each preference, is implemented in an inefﬁcient manner for the sake of clarity. If you are reading multiple preferences, it is more efﬁcient to open the entity once. Then read the preferences by calling OTCfgGetPrefs or OTCfgSetPrefs multiple times and close the entity when you’re done assertdbRef != nil assertentity != nil assertname != nil Reading Variable-size Preferences38 Reading and Writing Preferences Using Network SetupWriting Preferences Iterating the Preferences in an Entity Reading and Writing Preferences Using Network SetupWorking with Sets Finding the Active Set Entity The MyFindActiveSet routine in Listing 2-13 implements the ﬁrst two steps. It starts by getting a list of all of the set entities by calling the MyGetEntitiesList routine Listing 2-5. Then MyFindActiveSet iterates through all of the set entities, reading the kOTCfgSetsStructPref preference of each set entity. That preference maps to the CfgSetsStruct structure, which contains an fFlags member. One bit of the fFlags member, kOTCfgSetsFlagActiveMask, indicates whether this set entity is the active set entity. If it is, the routine breaks out of the loop and returns the set’s entity reference to the caller breaks out of the loop and returns the found entity Using Network Setup Listing 2-14 Finding the active entity of a given class and type46 Working with Sets Using Network Setup Listing 2-15 Finding the active TCP/IP entityWorking with Sets Areas and Sets TCP/IP Notes Protocol-speciﬁc Topicsaccess the preference in its packed format Using Network Setup Protocol-speciﬁc Topicscursor = UInt8 * packedPref Using Network Setup 52 Protocol-speciﬁc TopicsUInt8 *cursor Remote Access Notes OTCfgRemoteClientLocks page Modem NotesNetwork Setup and Third-party Protocol Stacks Notes for Third PartiesStoring Third-party Preferences in Apple Entities Using Network Setup 56 Notes for Third PartiesC H A P T E R Network Setup Reference Network Setup FunctionsOpening and Closing the Network Setup Database OTCfgCloseDatabase OTCfgOpenDatabaseManaging Areas OTCfgGetCurrentArea OTCfgOpenArea OTCfgSetCurrentAreaOTCfgCloseArea function result OTCfgBeginAreaModiﬁcationsfunction result OTCfgCommitAreaModiﬁcationsOTCfgAbortAreaModifications returns kCfgErrAreaNotFound OTCfgAbortAreaModiﬁcationsOTCfgIsSameAreaID function resultfunction result OTCfgGetAreaNamefunction result OTCfgSetAreaNameOTCfgGetAreasCount OTCfgGetAreasListfunction result function result that are available. On output, itemCount points to the number offunction result OTCfgCreateAreafunction result OTCfgDuplicateAreaOTCfgDeleteArea Managing EntitiesOTCfgGetEntitiesCount OTCfgGetEntitiesList entityType On input, a value of type CfgEntityType that speciﬁes the type that is to be matched. To specify all types, set entityType to kCfgTypeAnyEntity. For a list of possible types, see “Entity Classes and Types” page OTCfgCreateEntity OTCfgIsSameEntityReffunction result On input, a value of type CfgDatabaseRef page 98 thatconst CfgEntityRef* entityRef, const CfgEntityRef* newEntityRef OTCfgDeleteEntityOTCfgDuplicateEntity function resultOTCfgGetEntityLogicalName function result None OTCfgGetEntityNamefunction result OTCfgSetEntityNameOTCfgGetEntityArea OTCfgChangeEntityAreafunction result function result None Managing Preferencesfunction result OTCfgOpenPrefsOTCfgGetPrefsSize OTCfgClosePrefsOTCfgGetPrefs function resultvoid* data, ByteCount length OTCfgSetPrefs function resultconst void* data, ByteCount length OTCfgGetPrefsTOCCount OTCfgGetPrefsTOC OTCfgDeletePrefs OTCfgGetDefaultOTCfgGetTemplate function result Preference UtilitiesOTCfgDecrypt OTCfgEncryptOTCfgInstallNotiﬁer Installing and Removing a Notiﬁcation Callbackfunction result On input, a value of type CfgDatabaseRef page 98 thatApplication-Deﬁned Routines OTCfgRemoveNotiﬁerfunction result Notiﬁcation Callback Routine Network Setup Structures and Data TypesCfgAreaID CfgDatabaseRefCfgEntityRef CfgEntityInfoField descriptions CfgPrefsHeader CfgEntityAccessIDCfgSetsStruct CfgResourceLocatorFlags for this set. For possible values, see the enumeration CfgSetsVector CfgSetsElementEntity Classes and Types Network Setup ConstantsWildcard Classes and Types Per-connection Preference Types Common Preference TypesGlobal Preference Types Set Entity Preference Types Backward Compatibility Preference TypesGlobal Backward Compatibility Preference Types OTCfgUserMode Preference Invalid Area IDResult Codes Network Setup Protocol Structures and Data Types Protocol StructuresTCP/IP Structures OTCfgTCPInterfacesUnpacked modulekMaxModuleNameSize OTCfgTCPInterfacesPacked OTCfgTCPInterfacesPackedPartpartsizeofOTCfgTCPInterfacesPackedPart OTCfgTCPDHCPLeaseInfo OTCfgTCPLocks OTCfgTCPDNSServersListlockAdminDomainName lockLocalDomainNamelockDNSServersList Set to TRUE to lock the “Router address” text ﬁeld OTCfgTCPRoutersList OTCfgTCPRoutersListEntryOTCfgTCPRoutersListEntry page 119 structures OTCfgTCPSearchList OTCfgTCPSearchDomainsOTCfgTCPUnloadAttr Apple Remote Access Structures OTCfgRemoteApplication OTCfgRemoteAlternateAddressOTCfgRemoteARAP OTCfgRemoteClientLocks useVerboseLogLockregUserOrGuestLock The “Allow error correction and compression in modem” canInteract OTCfgRemoteClientMiscOTCfgRemoteConnect connectAutomaticallyissueConnectedReminders allowModemDataCompressionOTCfgRemotePPPConnectScript If Notification Manager reminders are enabled, the number isAssisted to 1 to use Dial Assist. When isAssisted is set to OTCfgRemoteDialAssistOTCfgRemoteDialing additionalPtrmade. Only valid if dialMode is not kOTCfgRemoteRedialNone OTCfgRemoteIPCP lowerLayerName36 OTCfgRemoteLCPkOTCfgRemoteAcceptedVersion. When reading the version OTCfgRemoteLogOptions OTCfgRemotePasswordOTCfgRemoteServer configCountconfigIDs1 serialLayerNamekMaxProviderNameSize OTCfgRemoteServerPortstruct OTCfgRemoteServerPort OTCfgRemoteNetworkProtocolMust be TRUE OTCfgRemoteTerminalAccess mode flags. For possible values, see the Network Setup Protocol Structures and Data TypesOTCfgRemoteUserMode OTCfgRemoteX25 OTCfgModemGeneral Modem StructuresOTCfgModemApplication OTCfgModemLocks AppleTalk Structures OTCfgATalkGeneral OTCfgATalkGeneralAARP fMaxConsecutiveDataPackets OTCfgATalkGeneralADSPPage OTCfgATalkGeneralASP OTCfgATalkGeneralATP fDefaultRetryIntervalfDefaultReleaseTimer fMyZonekZIPMaxZoneLength+1 OTCfgATalkGeneralDDPNetwork Setup Protocol Structures and Data Types Protocol StructuresThe maximum amount of data that packets of this protocol OTCfgATalkGeneralNBP fDefaultPAPEOMEnabled OTCfgATalkGeneralPAPfDefaultTickleInterval fDefaultTickleRetriesOTCfgATalkGeneralZIP OTCfgATalkLocks Constant descriptions kOTCfgATalkPortLockMask OTCfgATalkNetworkArchitectureOTCfgATalkPortDeviceType Infrared StructuresOTCfgIRGeneral Protocol Constants and Other Data Types“Infrared Constants and Other Data Types” page TCP/IP Constants and Other Data TypesNetwork Setup Protocol Structures and Data Types “AppleTalk Constants and Other Data Types” page0x0004 Masks for the kOTCfgProtocolOptionsPref PreferencekDontShutDownOnARPCollisionMask = 0x0002OTCfgTCPConﬁgMethod ARA Per-Connection Preferences Types Apple Remote Access Constants and Other Data TypesThe preference type for the OTCfgRemoteClientLocks page 125 structure Network Setup Protocol Structures and Data TypesThe preference type for the OTCfgRemoteARAP page 124 structure The preference type for the OTCfgRemoteDialing page 131 structureThe preference type for the OTCfgRemoteConnect page 127 structure OTCfgRemotePPPConnectScript ARA Global Preference TypesOTCfgRemoteProtocol OTCfgRemoteDialMode OTCfgRemoteLogLevelOTCfgRemoteNetworkProtocol OTCfgRemoteAnswerModeModem Constants and Other Data Types OTCfgRemoteNetAccessModeOTCfgModemDialingToneMode Modem Global Preference TypesPer-connection AppleTalk Preference Types AppleTalk Constants and Other Data TypesGlobal AppleTalk Preference Types Infrared Constants and Other Data TypesOTCfgIRPortSetting Glossary maximum transmission unit MTU The maximum number of bytes in a packet media access control address The six-byte Transmission Control Protocol/Internet Protocol A connection-oriented transport-layer Internet protocol that provides reliable full-duplex data transmission Index Page mid-level database 15 modem constants 170 multihoming 12 named areas network connection entities 16 Network Setupnotiﬁcation routine installing 94 removing legacy preference ﬁlesPage temporary area 20 third-party developers 55 type, entity set entities 16 active, number of 43 usingsetting entity names 81 structures TCP/IP constants 160 preferencesI N D E