Mac OS 9
Data Structures | Macros | Typedefs | Enumerations | Functions
PPCToolbox.h File Reference
CommunicationsToolbox

Program-Program Communications Toolbox Interfaces. More...

#include <MacTypes.h>
#include <AppleTalk.h>

Go to the source code of this file.

Data Structures

struct  PPCXTIAddress
 
struct  PPCAddrRec
 
struct  LocationNameRec
 
struct  PPCPortRec
 
struct  PortInfoRec
 
struct  PPCOpenPBRec
 
struct  PPCInformPBRec
 
struct  PPCStartPBRec
 
struct  PPCAcceptPBRec
 
struct  PPCRejectPBRec
 
struct  PPCWritePBRec
 
struct  PPCReadPBRec
 
struct  PPCEndPBRec
 
struct  PPCClosePBRec
 
struct  IPCListPortsPBRec
 
union  PPCParamBlockRec
 

Macros

#define PPCHeader
 
#define NewPPCCompUPP(userRoutine)
 
#define NewPPCFilterUPP(userRoutine)
 
#define DisposePPCCompUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposePPCFilterUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokePPCCompUPP(pb, userUPP)    CALL_ONE_PARAMETER_UPP((userUPP), uppPPCCompProcInfo, (pb))
 
#define InvokePPCFilterUPP(name, port, userUPP)
 
#define NewPPCCompProc(userRoutine)   NewPPCCompUPP(userRoutine)
 
#define NewPPCFilterProc(userRoutine)   NewPPCFilterUPP(userRoutine)
 
#define CallPPCCompProc(userRoutine, pb)   InvokePPCCompUPP(pb, userRoutine)
 
#define CallPPCFilterProc(userRoutine, name, port)    InvokePPCFilterUPP(name, port, userRoutine)
 
#define PPCOpen(pb, async)   ((async) ? PPCOpenAsync(pb) : PPCOpenSync(pb))
 
#define PPCInform(pb, async)   ((async) ? PPCInformAsync(pb) : PPCInformSync(pb))
 
#define PPCStart(pb, async)   ((async) ? PPCStartAsync(pb) : PPCStartSync(pb))
 
#define PPCAccept(pb, async)   ((async) ? PPCAcceptAsync(pb) : PPCAcceptSync(pb))
 
#define PPCReject(pb, async)   ((async) ? PPCRejectAsync(pb) : PPCRejectSync(pb))
 
#define PPCWrite(pb, async)   ((async) ? PPCWriteAsync(pb) : PPCWriteSync(pb))
 
#define PPCRead(pb, async)   ((async) ? PPCReadAsync(pb) : PPCReadSync(pb))
 
#define PPCEnd(pb, async)   ((async) ? PPCEndAsync(pb) : PPCEndSync(pb))
 
#define PPCClose(pb, async)   ((async) ? PPCCloseAsync(pb) : PPCCloseSync(pb))
 
#define IPCListPorts(pb, async)    ((async) ? IPCListPortsAsync(pb) : IPCListPortsSync(pb))
 

Typedefs

typedef UInt8 PPCServiceType
 
typedef SInt16 PPCLocationKind
 
typedef SInt16 PPCPortKinds
 
typedef UInt8 PPCSessionOrigin
 
typedef short PPCPortRefNum
 
typedef long PPCSessRefNum
 
typedef SInt16 PPCXTIAddressType
 
typedef struct PPCXTIAddress PPCXTIAddress
 
typedef PPCXTIAddress * PPCXTIAddressPtr
 
typedef struct PPCAddrRec PPCAddrRec
 
typedef PPCAddrRec * PPCAddrRecPtr
 
typedef struct LocationNameRec LocationNameRec
 
typedef LocationNameRec * LocationNamePtr
 
typedef struct PPCPortRec PPCPortRec
 
typedef PPCPortRec * PPCPortPtr
 
typedef struct PortInfoRec PortInfoRec
 
typedef PortInfoRec * PortInfoPtr
 
typedef PortInfoRec * PortInfoArrayPtr
 
typedef union PPCParamBlockRec PPCParamBlockRec
 
typedef PPCParamBlockRec * PPCParamBlockPtr
 
typedef struct PPCOpenPBRec PPCOpenPBRec
 
typedef PPCOpenPBRec * PPCOpenPBPtr
 
typedef struct PPCInformPBRec PPCInformPBRec
 
typedef PPCInformPBRec * PPCInformPBPtr
 
typedef struct PPCStartPBRec PPCStartPBRec
 
typedef PPCStartPBRec * PPCStartPBPtr
 
typedef struct PPCAcceptPBRec PPCAcceptPBRec
 
typedef PPCAcceptPBRec * PPCAcceptPBPtr
 
typedef struct PPCRejectPBRec PPCRejectPBRec
 
typedef PPCRejectPBRec * PPCRejectPBPtr
 
typedef struct PPCWritePBRec PPCWritePBRec
 
typedef PPCWritePBRec * PPCWritePBPtr
 
typedef struct PPCReadPBRec PPCReadPBRec
 
typedef PPCReadPBRec * PPCReadPBPtr
 
typedef struct PPCEndPBRec PPCEndPBRec
 
typedef PPCEndPBRec * PPCEndPBPtr
 
typedef struct PPCClosePBRec PPCClosePBRec
 
typedef PPCClosePBRec * PPCClosePBPtr
 
typedef struct IPCListPortsPBRec IPCListPortsPBRec
 
typedef IPCListPortsPBRec * IPCListPortsPBPtr
 
typedef PortInfoPtr port
 

Enumerations

enum  { ppcServiceRealTime = 1 }
 
enum  { ppcNoLocation = 0 , ppcNBPLocation = 1 , ppcNBPTypeLocation , ppcXTIAddrLocation = 3 }
 
enum  { ppcByCreatorAndType , ppcByString = 2 }
 
enum  { ppcLocalOrigin = 1 , ppcRemoteOrigin = 2 }
 
enum  { kMaxPPCXTIAddress = 95 }
 
enum  { kINETAddrType = 2 , kDNSAddrType = 42 }
 
enum  { uppPPCCompProcInfo = 0x000000C0 }
 
enum  { uppPPCFilterProcInfo = 0x000003D0 }
 

Functions

typedef CALLBACK_API (void, PPCCompProcPtr)(PPCParamBlockPtr pb)
 
typedef STACK_UPP_TYPE (PPCCompProcPtr) PPCCompUPP
 
OSErr PPCInit (void)
 
OSErr PPCOpenSync (PPCOpenPBPtr pb)
 
OSErr PPCOpenAsync (PPCOpenPBPtr pb)
 
OSErr PPCInformSync (PPCInformPBPtr pb)
 
OSErr PPCInformAsync (PPCInformPBPtr pb)
 
OSErr PPCStartSync (PPCStartPBPtr pb)
 
OSErr PPCStartAsync (PPCStartPBPtr pb)
 
OSErr PPCAcceptSync (PPCAcceptPBPtr pb)
 
OSErr PPCAcceptAsync (PPCAcceptPBPtr pb)
 
OSErr PPCRejectSync (PPCRejectPBPtr pb)
 
OSErr PPCRejectAsync (PPCRejectPBPtr pb)
 
OSErr PPCWriteSync (PPCWritePBPtr pb)
 
OSErr PPCWriteAsync (PPCWritePBPtr pb)
 
OSErr PPCReadSync (PPCReadPBPtr pb)
 
OSErr PPCReadAsync (PPCReadPBPtr pb)
 
OSErr PPCEndSync (PPCEndPBPtr pb)
 
OSErr PPCEndAsync (PPCEndPBPtr pb)
 
OSErr PPCCloseSync (PPCClosePBPtr pb)
 
OSErr PPCCloseAsync (PPCClosePBPtr pb)
 
OSErr IPCListPortsSync (IPCListPortsPBPtr pb)
 
OSErr IPCListPortsAsync (IPCListPortsPBPtr pb)
 
OSErr IPCKillListPorts (IPCListPortsPBPtr pb)
 
OSErr DeleteUserIdentity (unsigned long userRef)
 
OSErr GetDefaultUser (unsigned long *userRef, Str32 userName)
 
OSErr StartSecureSession (PPCStartPBPtr pb, Str32 userName, Boolean useDefault, Boolean allowGuest, Boolean *guestSelected, ConstStr255Param prompt)
 
typedef CALLBACK_API (Boolean, PPCFilterProcPtr)(LocationNamePtr name
 
typedef STACK_UPP_TYPE (PPCFilterProcPtr) PPCFilterUPP
 
PPCCompUPP NewPPCCompUPP (PPCCompProcPtr userRoutine)
 
PPCFilterUPP NewPPCFilterUPP (PPCFilterProcPtr userRoutine)
 
void DisposePPCCompUPP (PPCCompUPP userUPP)
 
void DisposePPCFilterUPP (PPCFilterUPP userUPP)
 
void InvokePPCCompUPP (PPCParamBlockPtr pb, PPCCompUPP userUPP)
 
Boolean InvokePPCFilterUPP (LocationNamePtr name, PortInfoPtr port, PPCFilterUPP userUPP)
 
OSErr PPCBrowser (ConstStr255Param prompt, ConstStr255Param applListLabel, Boolean defaultSpecified, LocationNameRec *theLocation, PortInfoRec *thePortInfo, PPCFilterUPP portFilter, ConstStr32Param theLocNBPType)
 

Detailed Description

Program-Program Communications Toolbox Interfaces.

Introduced In: Mac OS 9
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1989-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

◆ InvokePPCFilterUPP

#define InvokePPCFilterUPP (   name,
  port,
  userUPP 
)
Value:
(Boolean) \
CALL_TWO_PARAMETER_UPP((userUPP), uppPPCFilterProcInfo, (name), (port))
Boolean
unsigned char Boolean
Definition: MacTypes.h:318
PortInfoRec
Definition: PPCToolbox.h:168

◆ NewPPCCompUPP

#define NewPPCCompUPP (   userRoutine)
Value:
(PPCCompUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppPPCCompProcInfo, GetCurrentArchitecture())
NewRoutineDescriptor
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

◆ NewPPCFilterUPP

#define NewPPCFilterUPP (   userRoutine)
Value:
(PPCFilterUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppPPCFilterProcInfo, GetCurrentArchitecture())

◆ PPCHeader

#define PPCHeader
Value:
Ptr qLink; /* PPC's Internal Use */ \
unsigned short csCode; /* Requested PPC command */ \
unsigned short intUse; /* Internal Use */ \
Ptr intUsePtr; /* Internal Use */ \
PPCCompUPP ioCompletion; /* 12 --> Completion Routine */ \
volatile OSErr ioResult; /* 16 <-- Command Result Code */ \
unsigned long Reserved[5]; /* Reserved for PPC, Don't use */

◆ PPCOpen

#define PPCOpen (   pb,
  async 
)    ((async) ? PPCOpenAsync(pb) : PPCOpenSync(pb))

The ParamBlock calls without the "Sync" or "Async" suffix are being phased out.

Typedef Documentation

◆ PPCXTIAddressType

typedef SInt16 PPCXTIAddressType

The possible types of information found in the fAddressType field of a PPCXTIAddress record Note: These constants are the same as the AF_INET & AF_DNS constants, defined in OpenTptInternet.x

Function Documentation

◆ DeleteUserIdentity()

OSErr DeleteUserIdentity ( unsigned long  userRef)

DeleteUserIdentity()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ DisposePPCCompUPP()

void DisposePPCCompUPP ( PPCCompUPP  userUPP)

DisposePPCCompUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ DisposePPCFilterUPP()

void DisposePPCFilterUPP ( PPCFilterUPP  userUPP)

DisposePPCFilterUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ GetDefaultUser()

OSErr GetDefaultUser ( unsigned long *  userRef,
Str32  userName 
)

GetDefaultUser()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ InvokePPCCompUPP()

void InvokePPCCompUPP ( PPCParamBlockPtr  pb,
PPCCompUPP  userUPP 
)

InvokePPCCompUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokePPCFilterUPP()

Boolean InvokePPCFilterUPP ( LocationNamePtr  name,
PortInfoPtr  port,
PPCFilterUPP  userUPP 
)

InvokePPCFilterUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ IPCKillListPorts()

OSErr IPCKillListPorts ( IPCListPortsPBPtr  pb)

IPCKillListPorts()

Non-Carbon CFM: in InterfaceLib 9.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ IPCListPortsAsync()

OSErr IPCListPortsAsync ( IPCListPortsPBPtr  pb)

IPCListPortsAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ IPCListPortsSync()

OSErr IPCListPortsSync ( IPCListPortsPBPtr  pb)

IPCListPortsSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ NewPPCCompUPP()

PPCCompUPP NewPPCCompUPP ( PPCCompProcPtr  userRoutine)

NewPPCCompUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewPPCFilterUPP()

PPCFilterUPP NewPPCFilterUPP ( PPCFilterProcPtr  userRoutine)

NewPPCFilterUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ PPCAcceptAsync()

OSErr PPCAcceptAsync ( PPCAcceptPBPtr  pb)

PPCAcceptAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCAcceptSync()

OSErr PPCAcceptSync ( PPCAcceptPBPtr  pb)

PPCAcceptSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCBrowser()

OSErr PPCBrowser ( ConstStr255Param  prompt,
ConstStr255Param  applListLabel,
Boolean  defaultSpecified,
LocationNameRec *  theLocation,
PortInfoRec *  thePortInfo,
PPCFilterUPP  portFilter,
ConstStr32Param  theLocNBPType 
)

PPCBrowser()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCCloseAsync()

OSErr PPCCloseAsync ( PPCClosePBPtr  pb)

PPCCloseAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCCloseSync()

OSErr PPCCloseSync ( PPCClosePBPtr  pb)

PPCCloseSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCEndAsync()

OSErr PPCEndAsync ( PPCEndPBPtr  pb)

PPCEndAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCEndSync()

OSErr PPCEndSync ( PPCEndPBPtr  pb)

PPCEndSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCInformAsync()

OSErr PPCInformAsync ( PPCInformPBPtr  pb)

PPCInformAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCInformSync()

OSErr PPCInformSync ( PPCInformPBPtr  pb)

PPCInformSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCInit()

OSErr PPCInit ( void  )

PPCInit()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCOpenAsync()

OSErr PPCOpenAsync ( PPCOpenPBPtr  pb)

PPCOpenAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCOpenSync()

OSErr PPCOpenSync ( PPCOpenPBPtr  pb)

PPCOpenSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCReadAsync()

OSErr PPCReadAsync ( PPCReadPBPtr  pb)

PPCReadAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCReadSync()

OSErr PPCReadSync ( PPCReadPBPtr  pb)

PPCReadSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCRejectAsync()

OSErr PPCRejectAsync ( PPCRejectPBPtr  pb)

PPCRejectAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCRejectSync()

OSErr PPCRejectSync ( PPCRejectPBPtr  pb)

PPCRejectSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCStartAsync()

OSErr PPCStartAsync ( PPCStartPBPtr  pb)

PPCStartAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCStartSync()

OSErr PPCStartSync ( PPCStartPBPtr  pb)

PPCStartSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCWriteAsync()

OSErr PPCWriteAsync ( PPCWritePBPtr  pb)

PPCWriteAsync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ PPCWriteSync()

OSErr PPCWriteSync ( PPCWritePBPtr  pb)

PPCWriteSync()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ StartSecureSession()

OSErr StartSecureSession ( PPCStartPBPtr  pb,
Str32  userName,
Boolean  useDefault,
Boolean  allowGuest,
Boolean *  guestSelected,
ConstStr255Param  prompt 
)

StartSecureSession()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available