Manuals / Apple / Computer Equipment / Network Card

Apple Network Setup manual TCP/IP Constants and Other Data Types

Models: Network Setup

1 184

Download 184 pages 5.56 Kb

Page 160

C H A P T E R 4

Network Setup Protocol Structures and Data Types

■“AppleTalk Constants and Other Data Types” (page 172)

■“Infrared Constants and Other Data Types” (page 173)

TCP/IP Constants and Other Data Types

The following enumeration deﬁnes type codes for the TCP/IP preferences.

enum {
kOTCfgTCPInterfacesPref	= 'iitf',
kOTCfgTCPDeviceTypePref	= 'dtyp',
kOTCfgTCPRoutersListPref	= 'irte',
kOTCfgTCPSearchListPref	= 'ihst',
kOTCfgTCPDNSServersListPref = 'idns',
kOTCfgTCPSearchDomainsPref	= 'isdm',
kOTCfgTCPDHCPLeaseInfoPref	= 'dclt',
kOTCfgTCPDHCPClientIDPref	= 'dcid',
kOTCfgTCPUnloadAttrPref	= 'unld',
kOTCfgTCPLocksPref	= 'stng',
kOTCfgTCPPushBelowIPPref	= 'crpt',

kOTCfgTCPPushBelowIPListPref= 'blip',

};

Constant descriptions

kOTCfgTCPInterfacesPref

Preference type for the OTCfgTCPInterfacesUnpacked (page 112) structure.

kOTCfgTCPDeviceTypePref

Preference type for the TCP device type. Constants are deﬁned in Inside Macintosh: Networking with Open Transport available at http://developer.apple.com/techpubs/mac/ NetworkingOT/NetworkingWOT-2.html.

kOTCfgTCPRoutersListPref

Preference type for the OTCfgTCPRoutersList (page 119) structure.

kOTCfgTCPSearchListPref

Preference type for the OTCfgTCPSearchList (page 120) structure.

160Protocol Constants and Other Data Types

Image 160

Apple Network Setup manual TCP/IP Constants and Other Data Types, “AppleTalk Constants and Other Data Types” page

Contents

I N S I D E M A C I N T O S H Network Setup Apple Computer, Inc 2000 Apple Computer, Inc. All rights reserved Contents About Network SetupUsing Network Setup About This ManualNetwork Setup Reference ChapterChapter 4 Network Setup Protocol Structures and Data Types Glossary IndexPage About Network Setup Using Network SetupFigures, Tables, and Listings ChapterPage About This Manual Conventions Used in This ManualFor More Information Inside AppleTalk, Second EditionInside Macintosh Networking with Open Transport Open Transport Advanced Client Programming, available atAbout Network Setup Network Setup ArchitectureThe 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 About Network Setup Figure 1-4 Structure of the Network Setup Library Inside the Network Setup LibraryHigh-level framework Mid-level database OTCfgNetwork Setup Database Fundamentals Database StructureDatabase Structure Example About Network Setup Figure 1-5 Sample organization of the default area18 Network Setup Database Fundamentals LocalTalk for Printer AppleTalk networkork protocol entityDatabase Operations Figure 1-6 shows this process diagrammatically Legacy Issues Preference CoherencyLegacy Synchronization Algorithm Version Network Setup Version HistoryMac OS version 24 Network Setup Version History About Network SetupC H A P T E R Opening and Closing the Network Setup Database Using Network SetupOpening the Database for Reading Using Network Setup Listing 2-1 Opening the database for reading Opening the Database for Writing26 Opening and Closing the Network Setup Database Opening and Closing the Network Setup Database Using Network SetupListing 2-2 Opening the database for writing Closing the Database After Reading Closing the Database After WritingUsing Network Setup Opening and Closing the Network Setup DatabaseListing 2-4 Closing the database after writing err = OTCfgCommitAreaModificationsdbRef, readArea, writeAreaWorking with Entities Listing All EntitieskCfgClassAnyEntity and kCfgTypeAnyEntity, respectively static OSStatus MyGetEntitiesListCfgDatabaseRef dbRef, CfgAreaID areaOSType entityClass OSType entityType CfgEntityRef **entityRefs CfgEntityInfo **entityInfosUsing Network Setup 32 Working with EntitiesThe 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 Reading and Writing Preferences Finding an Active EntityReading Fixed-size Preferences Using Network SetupListing 2-7 Reading a ﬁxed-size preference Reading and Writing PreferencesThe 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 Reading Variable-size Preferences assertdbRef != nil assertentity != nil assertname != nilUsing Network Setup 38 Reading and Writing PreferencesWriting Preferences Iterating the Preferences in an Entity Using Network Setup Reading and Writing PreferencesWorking 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 Listing 2-14 Finding the active entity of a given class and type Using Network Setup46 Working with Sets Listing 2-15 Finding the active TCP/IP entity Using Network SetupWorking with Sets Areas and Sets Protocol-speciﬁc Topics TCP/IP Notesaccess the preference in its packed format Protocol-speciﬁc Topics Using Network Setupcursor = UInt8 * packedPref 52 Protocol-speciﬁc Topics Using Network SetupUInt8 *cursor Remote Access Notes Modem Notes OTCfgRemoteClientLocks pageNotes for Third Parties Network Setup and Third-party Protocol StacksStoring Third-party Preferences in Apple Entities 56 Notes for Third Parties Using Network SetupC H A P T E R Network Setup Functions Network Setup ReferenceOpening and Closing the Network Setup Database OTCfgOpenDatabase OTCfgCloseDatabaseManaging Areas OTCfgGetCurrentArea OTCfgSetCurrentArea OTCfgOpenAreaOTCfgCloseArea OTCfgBeginAreaModiﬁcations function resultOTCfgCommitAreaModiﬁcations function resultOTCfgAbortAreaModiﬁcations OTCfgIsSameAreaIDfunction result OTCfgAbortAreaModifications returns kCfgErrAreaNotFoundOTCfgGetAreaName function resultOTCfgSetAreaName function resultOTCfgGetAreasList OTCfgGetAreasCountfunction result that are available. On output, itemCount points to the number of function resultOTCfgCreateArea function resultOTCfgDuplicateArea function resultManaging Entities OTCfgDeleteAreaOTCfgGetEntitiesCount 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 OTCfgIsSameEntityRef OTCfgCreateEntityOn input, a value of type CfgDatabaseRef page 98 that function resultOTCfgDeleteEntity OTCfgDuplicateEntityfunction result const CfgEntityRef* entityRef, const CfgEntityRef* newEntityRefOTCfgGetEntityLogicalName OTCfgGetEntityName function result NoneOTCfgSetEntityName function resultOTCfgChangeEntityArea OTCfgGetEntityAreafunction result Managing Preferences function result NoneOTCfgOpenPrefs function resultOTCfgClosePrefs OTCfgGetPrefsSizefunction result OTCfgGetPrefsvoid* data, ByteCount length function result OTCfgSetPrefsconst void* data, ByteCount length OTCfgGetPrefsTOCCount OTCfgGetPrefsTOC OTCfgGetDefault OTCfgDeletePrefsOTCfgGetTemplate Preference Utilities function resultOTCfgEncrypt OTCfgDecryptInstalling and Removing a Notiﬁcation Callback OTCfgInstallNotiﬁerOn input, a value of type CfgDatabaseRef page 98 that function resultOTCfgRemoveNotiﬁer Application-Deﬁned Routinesfunction result Network Setup Structures and Data Types Notiﬁcation Callback RoutineCfgDatabaseRef CfgAreaIDCfgEntityInfo CfgEntityRefField descriptions CfgEntityAccessID CfgPrefsHeaderCfgResourceLocator CfgSetsStructFlags for this set. For possible values, see the enumeration CfgSetsElement CfgSetsVectorNetwork Setup Constants Entity Classes and TypesWildcard Classes and Types Common Preference Types Per-connection Preference TypesGlobal Preference Types Backward Compatibility Preference Types Set Entity Preference TypesGlobal Backward Compatibility Preference Types Invalid Area ID OTCfgUserMode PreferenceResult Codes Protocol Structures Network Setup Protocol Structures and Data TypesTCP/IP Structures OTCfgTCPInterfacesUnpacked modulekMaxModuleNameSize OTCfgTCPInterfacesPackedPart OTCfgTCPInterfacesPackedpartsizeofOTCfgTCPInterfacesPackedPart OTCfgTCPDHCPLeaseInfo OTCfgTCPDNSServersList OTCfgTCPLockslockLocalDomainName lockAdminDomainNamelockDNSServersList Set to TRUE to lock the “Router address” text ﬁeld OTCfgTCPRoutersListEntry OTCfgTCPRoutersListOTCfgTCPRoutersListEntry page 119 structures OTCfgTCPSearchDomains OTCfgTCPSearchListOTCfgTCPUnloadAttr Apple Remote Access Structures OTCfgRemoteAlternateAddress OTCfgRemoteApplicationOTCfgRemoteARAP useVerboseLogLock OTCfgRemoteClientLocksregUserOrGuestLock The “Allow error correction and compression in modem” OTCfgRemoteClientMisc OTCfgRemoteConnectconnectAutomatically canInteractallowModemDataCompression issueConnectedRemindersOTCfgRemotePPPConnectScript If Notification Manager reminders are enabled, the number OTCfgRemoteDialAssist isAssisted to 1 to use Dial Assist. When isAssisted is set toadditionalPtr OTCfgRemoteDialingmade. Only valid if dialMode is not kOTCfgRemoteRedialNone OTCfgRemoteIPCP OTCfgRemoteLCP lowerLayerName36kOTCfgRemoteAcceptedVersion. When reading the version OTCfgRemotePassword OTCfgRemoteLogOptionsconfigCount OTCfgRemoteServerconfigIDs1 OTCfgRemoteServerPort struct OTCfgRemoteServerPortOTCfgRemoteNetworkProtocol serialLayerNamekMaxProviderNameSizeOTCfgRemoteTerminal Access mode flags. For possible values, see theNetwork Setup Protocol Structures and Data Types Must be TRUEOTCfgRemoteUserMode OTCfgRemoteX25 Modem Structures OTCfgModemGeneralOTCfgModemApplication OTCfgModemLocks AppleTalk Structures OTCfgATalkGeneral OTCfgATalkGeneralAARP OTCfgATalkGeneralADSP fMaxConsecutiveDataPacketsPage OTCfgATalkGeneralASP fDefaultRetryInterval OTCfgATalkGeneralATPfDefaultReleaseTimer OTCfgATalkGeneralDDP Network Setup Protocol Structures and Data TypesProtocol Structures fMyZonekZIPMaxZoneLength+1The maximum amount of data that packets of this protocol OTCfgATalkGeneralNBP OTCfgATalkGeneralPAP fDefaultTickleIntervalfDefaultTickleRetries fDefaultPAPEOMEnabledOTCfgATalkGeneralZIP OTCfgATalkLocks OTCfgATalkNetworkArchitecture Constant descriptions kOTCfgATalkPortLockMaskInfrared Structures OTCfgATalkPortDeviceTypeProtocol Constants and Other Data Types OTCfgIRGeneralTCP/IP Constants and Other Data Types Network Setup Protocol Structures and Data Types“AppleTalk Constants and Other Data Types” page “Infrared Constants and Other Data Types” pageMasks for the kOTCfgProtocolOptionsPref Preference kDontShutDownOnARPCollisionMask =0x0002 0x0004OTCfgTCPConﬁgMethod Apple Remote Access Constants and Other Data Types ARA Per-Connection Preferences TypesNetwork Setup Protocol Structures and Data Types The preference type for the OTCfgRemoteARAP page 124 structureThe preference type for the OTCfgRemoteDialing page 131 structure The preference type for the OTCfgRemoteClientLocks page 125 structureThe preference type for the OTCfgRemoteConnect page 127 structure ARA Global Preference Types OTCfgRemotePPPConnectScriptOTCfgRemoteProtocol OTCfgRemoteLogLevel OTCfgRemoteDialModeOTCfgRemoteAnswerMode OTCfgRemoteNetworkProtocolOTCfgRemoteNetAccessMode Modem Constants and Other Data TypesModem Global Preference Types OTCfgModemDialingToneModeAppleTalk Constants and Other Data Types Per-connection AppleTalk Preference TypesInfrared Constants and Other Data Types Global AppleTalk Preference 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 named areas network connection entities 16 Network Setup notiﬁcation routine installing 94 removinglegacy preference ﬁles mid-level database 15 modem constants 170 multihoming 12Page set entities 16 active, number of 43 using setting entity names 81 structuresTCP/IP constants 160 preferences temporary area 20 third-party developers 55 type, entityI N D E