Manual Pages for UNIX Darwin command on man clnt

Manual Pages for UNIX Darwin command on man clnt_perrno

RPC(3N) RPC(3N)

NAME

rpc - library routines for remote procedure calls

SYNOPSIS AND DESCRIPTION

These routines allow C programs to make procedure calls on other machines across the network. First, the client calls a procedure to send a data packet to the server. Upon receipt of the packet, the server calls a dispatch routine to perform the requested service, and then sends back a reply. Finally, the procedure call returns to the client. Routines that are used for Secure RPC (DES authentication) are described in rrppccsseeccuurree(3N). Secure RPC can be used only if DES encryption is available.

##iinncclluuddee <>

vvooiidd aauutthhddeessttrrooyy((aauutthh)) AAUUTTHH **aauutthh;; A macro that destroys the authentication information associated with auth. Destruction usually involves deallocation of private data structures. The use of auth is undefined after calling aauutthhddeessttrrooyy(()). AAUUTTHH ** aauutthhnnoonneeccrreeaattee(()) Create and returns an RPC authentication handle that passes nonusable authentication information with each remote procedure call. This is the default authentication used by RPC. AAUUTTHH ** aauutthhuunniixxccrreeaattee((hhoosstt,, uuiidd,, ggiidd,, lleenn,, aauuppggiiddss)) cchhaarr **hhoosstt;; iinntt uuiidd,, ggiidd,, lleenn,, **aauupp..ggiiddss;; Create and return an RPC authentication handle that contains authentication information. The parameter host is the name of the machine on which the information was created; uid is the user's user ID ; gid is the user's current group ID ; len and aupgids refer to a counted array of groups to which the user belongs. It is easy to impersonate a user. AAUUTTHH ** aauutthhuunniixxccrreeaatteeddeeffaauulltt(()) Calls aauutthhuunniixxccrreeaattee(()) with the appropriate parameters. ccaallllrrppcc((hhoosstt,, pprrooggnnuumm,, vveerrssnnuumm,, pprrooccnnuumm,, iinnpprroocc,, iinn,, oouuttpprroocc,, oouutt)) cchhaarr **hhoosstt;; uulloonngg pprrooggnnuumm,, vveerrssnnuumm,, pprrooccnnuumm;; cchhaarr **iinn,, **oouutt;; xxddrrpprroocctt iinnpprroocc,, oouuttpprroocc;; Call the remote procedure associated with prognum, versnum, and procnum on the machine, host. The parameter in is the address of the procedure's argument(s), and out is the address of where to place the result(s); inproc is used to encode the procedure's parameters, and outproc is used to decode the procedure's results. This routine returns zero if it succeeds, or the value of eennuumm ccllnnttssttaatt cast to an integer if it fails. The routine ccllnnttppeerrrrnnoo(()) is handy for translating failure statuses into messages. Warning: calling remote procedures with this routine uses UDP/IP as a transport; see ccllnnttuuddppccrreeaattee(()) for restrictions. You do

not have control of timeouts or authentication using this rou-

tine. eennuumm ccllnnttssttaatt ccllnnttbbrrooaaddccaasstt((pprrooggnnuumm,, vveerrssnnuumm,, pprrooccnnuumm,, iinnpprroocc,, iinn,, oouuttpprroocc,, oouutt,, eeaacchhrreessuulltt)) uulloonngg pprrooggnnuumm,, vveerrssnnuumm,, pprrooccnnuumm;; cchhaarr **iinn,, **oouutt;; xxddrrpprroocctt iinnpprroocc,, oouuttpprroocc;; rreessuullttpprroocctt eeaacchhrreessuulltt;; Like ccaallllrrppcc(()), except the call message is broadcast to all locally connected broadcast nets. Each time it receives a response, this routine calls eeaacchhrreessuulltt(()), whose form is: eeaacchhrreessuulltt((oouutt,, aaddddrr)) cchhaarr **oouutt;; ssttrruucctt ssoocckkaaddddrriinn **aaddddrr;; where out is the same as out passed to ccllnnttbbrrooaaddccaasstt(()), except that the remote procedure's output is decoded there; addr points

to the address of the machine that sent the results. If eeaacchhrree-

ssuulltt(()) returns zero, ccllnnttbbrrooaaddccaasstt(()) waits for more replies; otherwise it returns with appropriate status. Warning: broadcast sockets are limited in size to the maximum transfer unit of the data link. For ethernet, this value is 1500 bytes. eennuumm ccllnnttssttaatt ccllnnttccaallll((ccllnntt,, pprrooccnnuumm,, iinnpprroocc,, iinn,, oouuttpprroocc,, oouutt,, ttoouutt)) CCLLIIEENNTT **ccllnntt;; uulloonngg pprrooccnnuumm;; xxddrrpprroocctt iinnpprroocc,, oouuttpprroocc;; cchhaarr **iinn,, **oouutt;; ssttrruucctt ttiimmeevvaall ttoouutt;; A macro that calls the remote procedure procnum associated with the client handle, clnt, which is obtained with an RPC client creation routine such as ccllnnttccrreeaattee(()). The parameter in is the address of the procedure's argument(s), and out is the address of where to place the result(s); inproc is used to encode the

procedure's parameters, and outproc is used to decode the proce-

dure's results; tout is the time allowed for results to come back. ccllnnttddeessttrrooyy((ccllnntt)) CCLLIIEENNTT **ccllnntt;;

A macro that destroys the client's RPC handle. Destruction usu-

ally involves deallocation of private data structures, including clnt itself. Use of clnt is undefined after calling ccllnnttddeessttrrooyy(()). If the RPC library opened the associated socket, it will close it also. Otherwise, the socket remains open. CCLLIIEENNTT ** ccllnnttccrreeaattee((hhoosstt,, pprroogg,, vveerrss,, pprroottoo)) cchhaarr **hhoosstt;; uulloonngg pprroogg,, vveerrss;; cchhaarr **pprroottoo;; Generic client creation routine. host identifies the name of the remote host where the server is located. proto indicates which kind of transport protocol to use. The currently supported values for this field are "udp" and "tcp". Default timeouts are set, but can be modified using ccllnnttccoonnttrrooll(()).

Warning: Using UDP has its shortcomings. Since UDP-based RPC

messages can only hold up to 8 Kbytes of encoded data, this

transport cannot be used for procedures that take large argu-

ments or return huge results. bboooolltt ccllnnttccoonnttrrooll((ccll,, rreeqq,, iinnffoo)) CCLLIIEENNTT **ccll;; cchhaarr **iinnffoo;; A macro used to change or retrieve various information about a client object. req indicates the type of operation, and info is

a pointer to the information. For both UDP and TCP, the sup-

ported values of req and their argument types and what they do are: CLSETTIMEOUT struct timeval set total timeout CLGETTIMEOUT struct timeval get total timeout Note: if you set the timeout using ccllnnttccoonnttrrooll(()), the timeout parameter passed to ccllnnttccaallll(()) will be ignored in all future calls. CLGETSERVERADDR struct sockaddrin get server's address The following operations are valid for UDP only: CLSETRETRYTIMEOUT struct timeval set the retry timeout CLGETRETRYTIMEOUT struct timeval get the retry timeout The retry timeout is the time that UDP RPC waits for the server to reply before retransmitting the request. ccllnnttffrreeeerreess((ccllnntt,, oouuttpprroocc,, oouutt)) CCLLIIEENNTT **ccllnntt;; xxddrrpprroocctt oouuttpprroocc;; cchhaarr **oouutt;; A macro that frees any data allocated by the RPC/XDR system when it decoded the results of an RPC call. The parameter out is the

address of the results, and outproc is the XDR routine describ-

ing the results. This routine returns one if the results were successfully freed, and zero otherwise. vvooiidd ccllnnttggeetteerrrr((ccllnntt,, eerrrrpp)) CCLLIIEENNTT **ccllnntt;; ssttrruucctt rrppcceerrrr **eerrrrpp;; A macro that copies the error structure out of the client handle to the structure at address errp. vvooiidd ccllnnttppccrreeaatteeeerrrroorr((ss)) cchhaarr **ss;; Print a message to standard error indicating why a client RPC handle could not be created. The message is prepended with

string s and a colon. Used when a ccllnnttccrreeaattee(()), ccllnnttrraawwccrree-

aattee(()), ccllnnttttccppccrreeaattee(()), or ccllnnttuuddppccrreeaattee(()) call fails. vvooiidd ccllnnttppeerrrrnnoo((ssttaatt)) eennuumm ccllnnttssttaatt ssttaatt;; Print a message to standard error corresponding to the condition indicated by stat. Used after ccaallllrrppcc(()). ccllnnttppeerrrroorr((ccllnntt,, ss)) CCLLIIEENNTT **ccllnntt;; cchhaarr **ss;; Print a message to standard error indicating why an RPC call failed; clnt is the handle used to do the call. The message is prepended with string s and a colon. Used after ccllnnttccaallll(()). cchhaarr ** ccllnnttssppccrreeaatteeeerrrroorr cchhaarr **ss;; Like ccllnnttppccrreeaatteeeerrrroorr(()), except that it returns a string instead of printing to the standard error. Bugs: returns pointer to static data that is overwritten on each call. cchhaarr ** ccllnnttssppeerrrrnnoo((ssttaatt)) eennuumm ccllnnttssttaatt ssttaatt;; Take the same arguments as ccllnnttppeerrrrnnoo(()), but instead of sending a message to the standard error indicating why an RPC call failed, return a pointer to a string which contains the message. The string ends with a NEWLINE. ccllnnttssppeerrrrnnoo(()) is used instead of ccllnnttppeerrrrnnoo(()) if the program does not have a standard error (as a program running as a server quite likely does not), or if the programmer does not want the

message to be output with pprriinnttff, or if a message format differ-

ent than that supported by ccllnnttppeerrrrnnoo(()) is to be used. Note: unlike ccllnnttssppeerrrroorr(()) and ccllnnttssppccrreeaatteerrrroorr(()), ccllnnttssppeerrrrnnoo(()) returns pointer to static data, but the result will not get overwritten on each call. cchhaarr ** ccllnnttssppeerrrroorr((rrppcchh,, ss)) CCLLIIEENNTT **rrppcchh;; cchhaarr **ss;; Like ccllnnttppeerrrroorr(()), except that (like ccllnnttssppeerrrrnnoo(())) it returns a string instead of printing to standard error. Bugs: returns pointer to static data that is overwritten on each call. CCLLIIEENNTT ** ccllnnttrraawwccrreeaattee((pprrooggnnuumm,, vveerrssnnuumm)) uulloonngg pprrooggnnuumm,, vveerrssnnuumm;; This routine creates a toy RPC client for the remote program prognum, version versnum. The transport used to pass messages to the service is actually a buffer within the process's address space, so the corresponding RPC server should live in the same address space; see ssvvccrraawwccrreeaattee(()). This allows simulation of RPC and acquisition of RPC overheads, such as round trip times, without any kernel interference. This routine returns NULL if it fails. CCLLIIEENNTT ** ccllnnttttccppccrreeaattee((aaddddrr,, pprrooggnnuumm,, vveerrssnnuumm,, ssoocckkpp,, sseennddsszz,, rreeccvvsszz)) ssttrruucctt ssoocckkaaddddrriinn **aaddddrr;; uulloonngg pprrooggnnuumm,, vveerrssnnuumm;; iinntt **ssoocckkpp;; uuiinntt sseennddsszz,, rreeccvvsszz;; This routine creates an RPC client for the remote program prognum, version versnum; the client uses TCP/IP as a transport. The remote program is located at Internet address *addr. If

aaddddrr->>ssiinnppoorrtt is zero, then it is set to the actual port that

and sets sockp. Since TCP-based RPC uses buffered I/O , the

user may specify the size of the send and receive buffers with the parameters sendsz and recvsz; values of zero choose suitable defaults. This routine returns NULL if it fails. CCLLIIEENNTT ** ccllnnttuuddppccrreeaattee((aaddddrr,, pprrooggnnuumm,, vveerrssnnuumm,, wwaaiitt,, ssoocckkpp)) ssttrruucctt ssoocckkaaddddrriinn **aaddddrr;; uulloonngg pprrooggnnuumm,, vveerrssnnuumm;; ssttrruucctt ttiimmeevvaall wwaaiitt;; iinntt **ssoocckkpp;; This routine creates an RPC client for the remote program

prognum, version versnum; the client uses use UDP/IP as a trans-

port. The remote program is located at Internet address addr.

If aaddddrr->>ssiinnppoorrtt is zero, then it is set to actual port that

the remote program is listening on (the remote ppoorrttmmaapp service is consulted for this information). The parameter sockp is a socket; if it is RRPPCCAANNYYSSOOCCKK, then this routine opens a new one and sets sockp. The UDP transport resends the call message in intervals of wwaaiitt time until a response is received or until the call times out. The total time for the call to time out is specified by ccllnnttccaallll(()).

Warning: since UDP-based RPC messages can only hold up to 8

Kbytes of encoded data, this transport cannot be used for proce-

dures that take large arguments or return huge results. CCLLIIEENNTT ** ccllnnttuuddppbbuuffccrreeaattee((aaddddrr,, pprrooggnnuumm,, vveerrssnnuumm,, wwaaiitt,, ssoocckkpp,, sseennddssiizzee,, rreeccoossiizzee)) ssttrruucctt ssoocckkaaddddrriinn **aaddddrr;; uulloonngg pprrooggnnuumm,, vveerrssnnuumm;; ssttrruucctt ttiimmeevvaall wwaaiitt;; iinntt **ssoocckkpp;; uunnssiiggnneedd iinntt sseennddssiizzee;; uunnssiiggnneedd iinntt rreeccoossiizzee;; This routine creates an RPC client for the remote program prognum, on versnum; the client uses use UDP/IP as a transport. The remote program is located at Internet address addr. If

aaddddrr->>ssiinnppoorrtt is zero, then it is set to actual port that the

remote program is listening on (the remote ppoorrttmmaapp service is consulted for this information). The parameter sockp is a socket; if it is RRPPCCAANNYYSSOOCCKK, then this routine opens a new one and sets ssoocckkpp. The UDP transport resends the call message in intervals of wwaaiitt time until a response is received or until the call times out. The total time for the call to time out is specified by ccllnnttccaallll(()). This allows the user to specify the maximun packet size for

sending and receiving UDP-based RPC messages.

vvooiidd ggeettmmyyaaddddrreessss((aaddddrr)) ssttrruucctt ssoocckkaaddddrriinn **aaddddrr;; Stuff the machine's IP address into *addr, without consulting the library routines that deal with //eettcc//hhoossttss. The port number is always set to hhttoonnss((PPMMAAPPPPOORRTT)). ssttrruucctt ppmmaapplliisstt ** ppmmaappggeettmmaappss((aaddddrr)) ssttrruucctt ssoocckkaaddddrriinn **aaddddrr;; A user interface to the ppoorrttmmaapp service, which returns a list of

the current RPC program-to-port mappings on the host located at

IP address *addr. This routine can return NULL . The command

`rrppcciinnffoo -pp' uses this routine.

uusshhoorrtt ppmmaappggeettppoorrtt((aaddddrr,, pprrooggnnuumm,, vveerrssnnuumm,, pprroottooccooll)) ssttrruucctt ssoocckkaaddddrriinn **aaddddrr;; uulloonngg pprrooggnnuumm,, vveerrssnnuumm,, pprroottooccooll;; A user interface to the ppoorrttmmaapp service, which returns the port number on which waits a service that supports program number prognum, version versnum, and speaks the transport protocol associated with protocol. The value of protocol is most likely IIPPPPRROOTTOOUUDDPP or IIPPPPRROOTTOOTTCCPP. A return value of zero means that the mapping does not exist or that the RPC system failured to contact the remote ppoorrttmmaapp service. In the latter case, the global variable rrppccccrreeaatteeeerrrr(()) contains the RPC status. eennuumm ccllnnttssttaatt ppmmaapprrmmttccaallll((aaddddrr,, pprrooggnnuumm,, vveerrssnnuumm,, pprrooccnnuumm,, iinnpprroocc,, iinn,, oouuttpprroocc,, oouutt,, ttoouutt,, ppoorrttpp)) ssttrruucctt ssoocckkaaddddrriinn **aaddddrr;; uulloonngg pprrooggnnuumm,, vveerrssnnuumm,, pprrooccnnuumm;; cchhaarr **iinn,, **oouutt;; xxddrrpprroocctt iinnpprroocc,, oouuttpprroocc;; ssttrruucctt ttiimmeevvaall ttoouutt;; uulloonngg **ppoorrttpp;; A user interface to the ppoorrttmmaapp service, which instructs ppoorrttmmaapp on the host at IP address *addr to make an RPC call on your behalf to a procedure on that host. The parameter *portp will

be modified to the program's port number if the procedure suc-

ceeds. The definitions of other parameters are discussed in ccaallllrrppcc(()) and ccllnnttccaallll(()). This procedure should be used for a "ping" and nothing else. See also ccllnnttbbrrooaaddccaasstt(()). ppmmaappsseett((pprrooggnnuumm,, vveerrssnnuumm,, pprroottooccooll,, ppoorrtt)) uulloonngg pprrooggnnuumm,, vveerrssnnuumm,, pprroottooccooll;; uusshhoorrtt ppoorrtt;; A user interface to the ppoorrttmmaapp service, which establishes a mapping between the triple [prognum,versnum,protocol] and port on the machine's ppoorrttmmaapp service. The value of protocol is most likely IIPPPPRROOTTOOUUDDPP or IIPPPPRROOTTOOTTCCPP. This routine returns one if

it succeeds, zero otherwise. Automatically done by ssvvccrreeggiiss-

tteerr(()). ppmmaappuunnsseett((pprrooggnnuumm,, vveerrssnnuumm)) uulloonngg pprrooggnnuumm,, vveerrssnnuumm;;

A user interface to the ppoorrttmmaapp service, which destroys all map-

ping between the triple [prognum,versnum,*] and ppoorrttss on the

machine's ppoorrttmmaapp service. This routine returns one if it suc-

ceeds, zero otherwise. rreeggiisstteerrrrppcc((pprrooggnnuumm,, vveerrssnnuumm,, pprrooccnnuumm,, pprrooccnnaammee,, iinnpprroocc,, oouuttpprroocc)) uulloonngg pprrooggnnuumm,, vveerrssnnuumm,, pprrooccnnuumm;; cchhaarr **((**pprrooccnnaammee)) (()) ;; xxddrrpprroocctt iinnpprroocc,, oouuttpprroocc;; Register procedure procname with the RPC service package. If a

request arrives for program prognum, version versnum, and proce-

dure procnum, procname is called with a pointer to its parame-

ter(s); progname should return a pointer to its static result(s); inproc is used to decode the parameters while outproc is used to encode the results. This routine returns zero if the

registration succeeded, -1 otherwise.

Warning: remote procedures registered in this form are accessed

using the UDP/IP transport; see ssvvccuuddppccrreeaattee(()) for restric-

tions. ssttrruucctt rrppccccrreeaatteeeerrrr rrppccccrreeaatteeeerrrr;; A global variable whose value is set by any RPC client creation

routine that does not succeed. Use the routine ccllnnttppccrreeaatteeeerr-

rroorr(()) to print the reason why. ssvvccddeessttrrooyy((xxpprrtt)) SSVVCCXXPPRRTT ** xxpprrtt;; A macro that destroys the RPC service transport handle, xprt.

Destruction usually involves deallocation of private data struc-

tures, including xprt itself. Use of xprt is undefined after calling this routine. ffddsseett ssvvccffddsseett;; A global variable reflecting the RPC service side's read file descriptor bit mask; it is suitable as a parameter to the sseelleecctt system call. This is only of interest if a service implementor does not call ssvvccrruunn(()), but rather does his own asynchronous

event processing. This variable is read-only (do not pass its

address to sseelleecctt!), yet it may change after calls to ssvvccggeettrree-

qqsseett(()) or any creation routines. iinntt ssvvccffddss;; Similar to ssvvccffeeddsseett(()), but limited to 32 descriptors. This interface is obsoleted by ssvvccffddsseett(()). ssvvccffrreeeeaarrggss((xxpprrtt,, iinnpprroocc,, iinn)) SSVVCCXXPPRRTT **xxpprrtt;; xxddrrpprroocctt iinnpprroocc;; cchhaarr **iinn;; A macro that frees any data allocated by the RPC/XDR system when it decoded the arguments to a service procedure using

ssvvccggeettaarrggss(()). This routine returns 1 if the results were suc-

cessfully freed, and zero otherwise. ssvvccggeettaarrggss((xxpprrtt,, iinnpprroocc,, iinn)) SSVVCCXXPPRRTT **xxpprrtt;; xxddrrpprroocctt iinnpprroocc;; cchhaarr **iinn;; A macro that decodes the arguments of an RPC request associated with the RPC service transport handle, xprt. The parameter in is the address where the arguments will be placed; inproc is the XDR routine used to decode the arguments. This routine returns one if decoding succeeds, and zero otherwise. ssttrruucctt ssoocckkaaddddrriinn ** ssvvccggeettccaalllleerr((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; The approved way of getting the network address of the caller of a procedure associated with the RPC service transport handle, xprt. ssvvccggeettrreeqqsseett((rrddffddss)) ffddsseett **rrddffddss;; This routine is only of interest if a service implementor does not call ssvvccrruunn(()), but instead implements custom asynchronous event processing. It is called when the sseelleecctt system call has determined that an RPC request has arrived on some RPC ssoocckkeett((ss)) ;; rdfds is the resultant read file descriptor bit mask. The routine returns when all sockets associated with the value of rdfds have been serviced. ssvvccggeettrreeqq((rrddffddss)) iinntt rrddffddss;; Similar to ssvvccggeettrreeqqsseett(()), but limited to 32 descriptors. This interface is obsoleted by ssvvccggeettrreeqqsseett(()). ssvvccrreeggiisstteerr((xxpprrtt,, pprrooggnnuumm,, vveerrssnnuumm,, ddiissppaattcchh,, pprroottooccooll)) SSVVCCXXPPRRTT **xxpprrtt;; uulloonngg pprrooggnnuumm,, vveerrssnnuumm;; vvooiidd ((**ddiissppaattcchh)) (());; uulloonngg pprroottooccooll;;

Associates prognum and versnum with the service dispatch proce-

dure, dispatch. If protocol is zero, the service is not regis-

tered with the ppoorrttmmaapp service. If protocol is non-zero, then a

mapping of the triple [prognum,versnum,protocol] to

xxpprrtt->>xxppppoorrtt is established with the local ppoorrttmmaapp service

(generally protocol is zero, IIPPPPRROOTTOOUUDDPP or IIPPPPRROOTTOOTTCCPP ). The procedure dispatch has the following form: ddiissppaattcchh((rreeqquueesstt,, xxpprrtt)) ssttrruucctt ssvvccrreeqq **rreeqquueesstt;; SSVVCCXXPPRRTT **xxpprrtt;; The ssvvccrreeggiisstteerr(()) routine returns one if it succeeds, and zero otherwise. ssvvccrruunn(()) This routine never returns. It waits for RPC requests to arrive, and calls the appropriate service procedure using ssvvccggeettrreeqq(()) when one arrives. This procedure is usually waiting for a sseelleecctt(()) system call to return. ssvvccsseennddrreeppllyy((xxpprrtt,, oouuttpprroocc,, oouutt)) SSVVCCXXPPRRTT **xxpprrtt;; xxddrrpprroocctt oouuttpprroocc;; cchhaarr **oouutt;; Called by an RPC service's dispatch routine to send the results of a remote procedure call. The parameter xprt is the request's associated transport handle; outproc is the XDR routine which is used to encode the results; and out is the address of the

results. This routine returns one if it succeeds, zero other-

wise. vvooiidd ssvvccuunnrreeggiisstteerr((pprrooggnnuumm,, vveerrssnnuumm)) uulloonngg pprrooggnnuumm,, vveerrssnnuumm;; Remove all mapping of the double [prognum,versnum] to dispatch routines, and of the triple [prognum,versnum,*] to port number. vvooiidd ssvvcceerrrraauutthh((xxpprrtt,, wwhhyy)) SSVVCCXXPPRRTT **xxpprrtt;; eennuumm aauutthhssttaatt wwhhyy;; Called by a service dispatch routine that refuses to perform a remote procedure call due to an authentication error. vvooiidd ssvvcceerrrrddeeccooddee((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; Called by a service dispatch routine that cannot successfully decode its parameters. See also ssvvccggeettaarrggss(()). vvooiidd ssvvcceerrrrnnoopprroocc((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; Called by a service dispatch routine that does not implement the procedure number that the caller requests. vvooiidd ssvvcceerrrrnnoopprroogg((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; Called when the desired program is not registered with the RPC package. Service implementors usually do not need this routine. vvooiidd ssvvcceerrrrpprrooggvveerrss((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; Called when the desired version of a program is not registered with the RPC package. Service implementors usually do not need this routine. vvooiidd ssvvcceerrrrssyysstteemmeerrrr((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; Called by a service dispatch routine when it detects a system error not covered by any particular protocol. For example, if a

service can no longer allocate storage, it may call this rou-

tine. vvooiidd ssvvcceerrrrwweeaakkaauutthh((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; Called by a service dispatch routine that refuses to perform a

remote procedure call due to insufficient authentication parame-

ters. The routine calls ssvvcceerrrraauutthh((xxpprrtt,, AAUUTTHHTTOOOOWWEEAAKK)). SSVVCCXXPPRRTT ** ssvvccrraawwccrreeaattee(()) This routine creates a toy RPC service transport, to which it returns a pointer. The transport is really a buffer within the process's address space, so the corresponding RPC client should

live in the same address space; see ccllnnttrraawwccrreeaattee(()). This rou-

tine allows simulation of RPC and acquisition of RPC overheads (such as round trip times), without any kernel interference. This routine returns NULL if it fails. SSVVCCXXPPRRTT ** ssvvccttccppccrreeaattee((ssoocckk,, sseennddbbuuffssiizzee,, rreeccvvbbuuffssiizzee)) iinntt ssoocckk;; uuiinntt sseennddbbuuffssiizzee,, rreeccvvbbuuffssiizzee;;

This routine creates a TCP/IP-based RPC service transport, to

which it returns a pointer. The transport is associated with the socket sock, which may be RRPPCCAANNYYSSOOCCKK, in which case a new socket is created. If the socket is not bound to a local TCP port, then this routine binds it to an arbitrary port. Upon

completion, xxpprrtt->>xxppssoocckk is the transport's socket descriptor,

and xxpprrtt->>xxppppoorrtt is the transport's port number. This routine

returns NULL if it fails. Since TCP-based RPC uses buffered I/O

, users may specify the size of buffers; values of zero choose suitable defaults. SSVVCCXXPPRRTT ** ssvvccffddccrreeaattee((ffdd,, sseennddssiizzee,, rreeccvvssiizzee)) iinntt ffdd;; uuiinntt sseennddssiizzee;; uuiinntt rreeccvvssiizzee;; Create a service on top of any open descriptor. Typically, this descriptor is a connected socket for a stream protocol such as TCP. sendsize and recvsize indicate sizes for the send and

receive buffers. If they are zero, a reasonable default is cho-

sen. SSVVCCXXPPRRTT ** ssvvccuuddppbbuuffccrreeaattee((ssoocckk,, sseennddssiizzee,, rreeccoossiizzee)) iinntt ssoocckk;;

This routine creates a UDP/IP-based RPC service transport, to

which it returns a pointer. The transport is associated with the socket sock, which may be RRPPCCAANNYYSSOOCCKK ,, in which case a new socket is created. If the socket is not bound to a local UDP

port, then this routine binds it to an arbitrary port. Upon com-

pletion, xxpprrtt->>xxppssoocckk is the transport's socket descriptor, and

xxpprrtt->>xxppppoorrtt is the transport's port number. This routine

returns NULL if it fails. This allows the user to specify the maximun packet size for

sending and receiving UDP-based RPC messages.

xxddrraacccceepptteeddrreeppllyy((xxddrrss,, aarr)) XXDDRR **xxddrrss;; ssttrruucctt aacccceepptteeddrreeppllyy **aarr;; Used for encoding RPC reply messages. This routine is useful for

users who wish to generate RPC-style messages without using the

RPC package. xxddrraauutthhuunniixxppaarrmmss((xxddrrss,, aauupppp)) XXDDRR **xxddrrss;; ssttrruucctt aauutthhuunniixxppaarrmmss **aauupppp;; Used for describing UNIX credentials. This routine is useful for users who wish to generate these credentials without using the RPC authentication package. vvooiidd xxddrrccaallllhhddrr((xxddrrss,, cchhddrr)) XXDDRR **xxddrrss;; ssttrruucctt rrppccmmssgg **cchhddrr;; Used for describing RPC call header messages. This routine is

useful for users who wish to generate RPC-style messages without

using the RPC package. xxddrrccaallllmmssgg((xxddrrss,, ccmmssgg)) XXDDRR **xxddrrss;; ssttrruucctt rrppccmmssgg **ccmmssgg;; Used for describing RPC call messages. This routine is useful

for users who wish to generate RPC-style messages without using

the RPC package. xxddrrooppaaqquueeaauutthh((xxddrrss,, aapp)) XXDDRR **xxddrrss;; ssttrruucctt ooppaaqquueeaauutthh **aapp;; Used for describing RPC authentication information messages.

This routine is useful for users who wish to generate RPC-style

messages without using the RPC package. xxddrrppmmaapp((xxddrrss,, rreeggss)) XXDDRR **xxddrrss;; ssttrruucctt ppmmaapp **rreeggss;; Used for describing parameters to various ppoorrttmmaapp procedures,

externally. This routine is useful for users who wish to gener-

ate these parameters without using the ppmmaapp interface. xxddrrppmmaapplliisstt((xxddrrss,, rrpp)) XXDDRR **xxddrrss;; ssttrruucctt ppmmaapplliisstt ****rrpp;; Used for describing a list of port mappings, externally. This

routine is useful for users who wish to generate these parame-

ters without using the ppmmaapp interface. xxddrrrreejjeecctteeddrreeppllyy((xxddrrss,, rrrr)) XXDDRR **xxddrrss;; ssttrruucctt rreejjeecctteeddrreeppllyy **rrrr;; Used for describing RPC reply messages. This routine is useful

for users who wish to generate RPC-style messages without using

the RPC package. xxddrrrreeppllyymmssgg((xxddrrss,, rrmmssgg)) XXDDRR **xxddrrss;; ssttrruucctt rrppccmmssgg **rrmmssgg;; Used for describing RPC reply messages. This routine is useful for users who wish to generate RPC style messages without using the RPC package. vvooiidd xxpprrttrreeggiisstteerr((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; After RPC service transport handles are created, they should register themselves with the RPC service package. This routine modifies the global variable ssvvccffddss(()). Service implementors usually do not need this routine. vvooiidd xxpprrttuunnrreeggiisstteerr((xxpprrtt)) SSVVCCXXPPRRTT **xxpprrtt;; Before an RPC service transport handle is destroyed, it should unregister itself with the RPC service package. This routine modifies the global variable ssvvccffddss(()). Service implementors usually do not need this routine.