Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ registerrpc(3N) — DG/UX 4.30

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

xdr(3N)

keyserv(8)



     rpc(3N)                    DG/UX 4.30                     rpc(3N)



     NAME
          auth_destroy, authnone_create, authdes_create,
          authdes_getucred, authunix_create, authunix_create_default,
          callrpc, clnt_broadcast, clnt_call, clnt_destroy,
          clnt_create, clnt_control, clnt_freeres, clnt_geterr,
          clnt_pcreateerror, clnt_perrno, clnt_perror,
          clnt_spcreateerror, clnt_sperrno, clnt_sperror,
          clntraw_create, clnttcp_create, clntudp_create,
          host2netname, key_decryptsession, key_encryptsession,
          key_gendes, key_setsecret, get_myaddress, getnetname,
          netname2host, netname2user, pmap_getmaps, pmap_getp ort,
          pmap_rmtcall, pmap_set, pmap_unset, registerrpc,
          svc_destroy, svc_freeargs, svc_getargs, svc_getcaller,
          svc_getreqset, svc_getreq, svc_register, svc_run,
          svc_sendreply, svc_unregister, svcerr_auth, svcerr_decode,
          svcerr_noproc, svcerr_noprog, svcerr_progvers,
          svcerr_systemerr, svcerr_weakauth, svcraw_create,
          svctcp_create, svcfd_create, svcudp_create, user2netname,
          xdr_accepted_reply, xdr_authunix_parms, xdr_callhdr,
          xdr_callmsg, xdr_opaque_auth, xdr_pmap, xdr_pmaplist,
          xdr_rejected_reply, xdr_replyms g, xprt_register,
          xprt_unregister - library routines for remote procedure
          calls

     SYNTAX AND DESCRIPTION
          These routines let C programs 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.

          #include <rpc/rpc.h>

          void
          authdestroy(auth)
          AUTH *auth;

               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 authdestroy().

          AUTH *
          authnonecreate()

               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.

          AUTH *



     Licensed material--property of copyright holder(s)         Page 1





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          authdescreate(name, window, syncaddr, ckey)
          char *name;
          unsigned window;
          struct sockaddr *syncaddr;
          desblock *ckey;

          NOTE:  Secure RPC using DES Authentication is an additional
          feature that must be purchased separately from the DG/UXTM
          ONCTM/NFS product.

               authdescreate() is the first of two routines which
               interface to the RPC secure authentication system,
               known as DES authentication.  The second is
               authdesgetucred(), below. Note: the keyserver daemon
               keyserv(8) must be running for the DES authentication
               system to work.

               authdescreate(), used on the client side, returns an
               authentication handle that will enable the use of the
               secure authentication system.  The first parameter name
               is the network name, or netname, of the owner of the
               server process. This field usually represents a
               hostname derived from the utility routine host2netname,
               but could also represent a user name using
               user2netname.  The second field is window on the
               validity of the client credential, given in seconds.  A
               small window is more secure than a large one, but
               choosing too small of a window will increase the
               frequency of resynchronizations because of clock drift.
               The third parameter syncaddr is optional.  If it is
               NULL, then the authentication system will assume that
               the local clock is always in sync with the server's
               clock, and will not attempt resynchronizations. If an
               address is supplied, however, then the system will use
               the address for consulting the remote time service
               whenever resynchronization is required. This parameter
               is usually the address of the RPC server itself. The
               final parameter ckey is also optional.  If it is NULL,
               then the authentication system will generate a random
               DES key to be used for the encryption of credentials.
               If it is supplied, however, then it will be used
               instead.

          authdesgetucred(adc, uid, gid, grouplen, groups)
          struct authdescred *adc;
          short *uid;
          short *gid;
          short *grouplen;
          int *groups;

               authdesgetucred(), the second of the two DES
               authentication routines, is used on the server side for



     Licensed material--property of copyright holder(s)         Page 2





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               converting a DES credential, which is operating system
               independent, into a UNIX credential. This routine
               differs from utility routine netname2user in that
               authdesgetucred() pulls its information from a cache,
               and does not have to do a Yellow Pages lookup everytime
               it is called to get its information.

          AUTH *
          authunixcreate(host, uid, gid, len, aupgids)
          char *host;
          int uid, gid, len, *aup.gids;

               Create and return an RPC authentication handle that
               contains UNIX 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 aup_gids
               refer to a counted array of groups to which the user
               belongs.  It is easy to impersonate a user.

          AUTH *
          authunixcreatedefault()

               Calls authunixcreate() with the appropriate
               parameters.

          callrpc(host, prognum, versnum, procnum, inproc, in, outproc, out)
          char *host;
          ulong prognum, versnum, procnum;
          char *in, *out;
          xdrproct inproc, outproc;

               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 enum clntstat cast to an
               integer if it fails.  The routine clntperrno() is
               handy for translating failure statuses into messages.

               Warning: calling remote procedures with this routine
               uses UDP/IP as a transport; see clntudpcreate() for
               restrictions.  You do not have control of timeouts or
               authentication using this routine.

          enum clntstat
          clntbroadcast(prognum, versnum, procnum, inproc, in, outproc,
               out, eachresult)
          ulong prognum, versnum, procnum;



     Licensed material--property of copyright holder(s)         Page 3





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          char *in, *out;
          xdrproct inproc, outproc;
          resultproct eachresult;

               Like callrpc(), except the call message is broadcast to
               all locally connected broadcast nets. Each time it
               receives a response, this routine calls eachresult(),
               whose form is:


                    eachresult(out, addr)
                    char *out;
                    struct sockaddrin *addr;

               where out is the same as out passed to
               clntbroadcast(), except that the remote procedure's
               output is decoded there; addr points to the address of
               the machine that sent the results.  If eachresult()
               returns zero, clntbroadcast() 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.

          enum clntstat
          clntcall(clnt, procnum, inproc, in, outproc, out, tout)
          CLIENT *clnt;
          ulong
          procnum;
          xdrproct inproc, outproc;
          char *in, *out;
          struct timeval tout;

               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
               clntcreate().  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; tout is the time
               allowed for results to come back.

          clntdestroy(clnt)
          CLIENT *clnt;

               A macro that destroys the client's RPC handle.
               Destruction usually involves deallocation of private
               data structures, including clnt itself.  Use of clnt is
               undefined after calling clntdestroy().  If the RPC
               library opened the associated socket, it will close it



     Licensed material--property of copyright holder(s)         Page 4





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               also.  Otherwise, the socket remains open.

          CLIENT *
          clntcreate(host, prog, vers, proto)
          char *host;
          ulong prog, vers;
          char *proto;

               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 clntcontrol().

               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 arguments or return huge
               results.

          boolt
          clntcontrol(cl, req, info)
          CLIENT *cl;
          char *info;

               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 supported values of req and
               their argument types and what they do are:


               CLSET_TIMEOUT       struct
               timeval             set
               total
               timeout
               CLGET_TIMEOUT       struct
               timeval             get
               total
               timeout

               Note: if you set the timeout using clntcontrol(), the
               timeout parameter passed to clntcall() will be ignored
               in all future calls.


               CLGET_SERVER_ADDR   struct
               sockaddr            get
               server's
               address




     Licensed material--property of copyright holder(s)         Page 5





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               The following operations are valid for UDP only:


               CLSET_RETRY_TIMEOUT struct
               timeval             set
               the
               retry
               timeout
               CLGET_RETRY_TIMEOUT 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.

          clntfreeres(clnt, outproc, out)
          CLIENT *clnt;
          xdrproct outproc;
          char *out;

               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 describing the results.
               This routine returns one if the results were
               successfully freed, and zero otherwise.

          void
          clntgeterr(clnt, errp)
          CLIENT *clnt;
          struct rpcerr *errp;

               A macro that copies the error structure out of the
               client handle to the structure at address errp.

          void
          clntpcreateerror(s)
          char *s;

               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
               clntcreate(), clntrawcreate(), clnttcpcreate(), or
               clntudpcreate() call fails.

          void
          clntperrno(stat)
          enum clntstat stat;

               Print a message to standard error corresponding to the



     Licensed material--property of copyright holder(s)         Page 6





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               condition indicated by stat.  Used after callrpc().

          clntperror(clnt, s)
          CLIENT *clnt;
          char *s;

               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 clntcall().

          char *
          clntspcreateerror
          char *s;

               Like clntpcreateerror(), 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.

          char *
          clntsperrno(stat)
          enum clntstat stat;

               Take the same arguments as clntperrno(), 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.

               clntsperrno() is used instead of clntperrno() 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
               printf, or if a message format different than that
               supported by clntperrno() is to be used.  Note: unlike
               clntsperror() and clntspcreaterror(), clntsperrno()
               does not return pointer to static data so the result
               will not get overwritten on each call.

          char *
          clntsperror(rpch, s)
          CLIENT *rpch;
          char *s;

               Like clntperror(), except that (like clntsperrno())
               it returns a string instead of printing to standard
               error.

               Bugs: returns pointer to static data that is
               overwritten on each call.



     Licensed material--property of copyright holder(s)         Page 7





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          CLIENT *
          clntrawcreate(prognum, versnum)
          ulong prognum, versnum;

               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 svcrawcreate().  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.

          CLIENT *
          clnttcpcreate(addr, prognum, versnum, sockp, sendsz, recvsz)
          struct sockaddrin *addr;
          ulong prognum, versnum;
          int *sockp;
          uint sendsz, recvsz;

               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 addr->sinport is zero,
               then it is set to the actual port that the remote
               program is listening on (the remote portmap service is
               consulted for this information). The parameter sockp is
               a socket; if it is RPCANYSOCK, then this routine opens
               a new one 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.

          CLIENT *
          clntudpcreate(addr, pronum, versnum, wait, sockp)
          struct sockaddrin *addr;
          ulong prognum, versnum;
          struct timeval wait;
          int *sockp;

               This routine creates an RPC client for the remote
               program prognum, version versnum; the client uses use
               UDP/IP as a transport. The remote program is located at
               Internet address addr.  If addr->sinport is zero, then
               it is set to actual port that the remote program is
               listening on (the remote portmap service is consulted
               for this information). The parameter sockp is a socket;
               if it is RPCANYSOCK, then this routine opens a new one
               and sets sockp.  The UDP transport resends the call
               message in intervals of wait time until a response is



     Licensed material--property of copyright holder(s)         Page 8





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               received or until the call times out.  The total time
               for the call to time out is specified by clntcall().

               Warning: 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 arguments or return
               huge results.

          host2netname(name, host, domain)
          char *name;
          char *host;
          char *domain;

               Convert from a domain-specific hostname to an
               operating-system independent netname. Return TRUE if it
               succeeds and FALSE if it fails. Inverse of
               netname2host().

          keydecryptsession(remotename, deskey)
          char *remotename;
          desblock *deskey;

               keydecryptsession() is an interface to the keyserver
               daemon, which is associated with RPC's secure
               authentication system (DES authentication).  User
               programs rarely need to call it, or its associated
               routines keyencryptsession(), keygendes() and
               keysetsecret().  System commands such as login and the
               RPC library are the main clients of these four
               routines.

               keydecryptsession() takes a server netname and a des
               key, and decrypts the key by using the the public key
               of the the server and the secret key associated with
               the effective uid of the calling process.  It is the
               inverse of keyencryptsession().

          keyencryptsession(remotename, deskey)
          char *remotename;
          desblock *deskey;

               keyencryptsession() is a keyserver interface routine.
               It takes a server netname and a des key, and encrypts
               it using the public key of the the server and the
               secret key associated with the effective uid of the
               calling process.  It is the inverse of
               keydecryptsession().

          keygendes(deskey)
          desblock *deskey;

               keygendes() is a keyserver interface routine. It is



     Licensed material--property of copyright holder(s)         Page 9





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               used to ask the keyserver for a secure conversation
               key.  Choosing one at random is usually not good
               enough, because the common ways of choosing random
               numbers, such as using the current time, are very easy
               to guess.

          keysetsecret(key)
          char *key;

               keysetsecret() is a keyserver interface routine. It is
               used to set the key for the effective uid of the
               calling process.

          void
          getmyaddress(addr)
          struct sockaddrin *addr;

               Stuff the machine's IP address into *addr, without
               consulting the library routines that deal with
               /etc/hosts.  The port number is always set to
               htons(PMAPPORT).

          getnetname(name)
          char name[MAXNETNAMELEN];

               getnetname() installs the unique, operating-system
               independent netname of the caller in the fixed-length
               array name.  Returns TRUE if it succeeds and FALSE if
               it fails.

          netname2host(name, host, hostlen)
          char *name;
          char *host;
          int hostlen;

               Convert from an operating-system independent netname to
               a domain-specific hostname. Returns TRUE if it succeeds
               and FALSE if it fails.  Inverse of host2netname().

          netname2user(name, uidp, gidp, gidlenp, gidlist)
          char *name;
          int *uidp;
          int *gidp;
          int *gidlenp;
          int *gidlist;

               Convert from an operating-system independent netname to
               a domain-specific user ID.  Returns TRUE if it succeeds
               and FALSE if it fails. Inverse of user2netname().

          struct pmaplist *
          pmapgetmaps(addr)



     Licensed material--property of copyright holder(s)        Page 10





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          struct sockaddrin *addr;

               A user interface to the portmap 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 `rpcinfo -p' uses this
               routine.

          ushort
          pmapgetport(addr, prognum, versnum, protocol)
          struct sockaddrin *addr;
          ulong prognum, versnum, protocol;

               A user interface to the portmap 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 IPPROTOUDP or IPPROTOTCP.
               A return value of zero means that the mapping does not
               exist or that the RPC system failured to contact the
               remote portmap service.  In the latter case, the global
               variable rpccreateerr() contains the RPC status.

          enum clntstat
          pmaprmtcall(addr, prognum, versnum, procnum, inproc, in, outproc,
               out, tout, portp)
          struct sockaddrin *addr;
          ulong prognum, versnum, procnum;
          char *in, *out;
          xdrproct inproc, outproc;
          struct timeval tout;
          ulong *portp;

               A user interface to the portmap service, which
               instructs portmap 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 succeeds. The
               definitions of other parameters are discussed in
               callrpc() and clntcall().  This procedure should be
               used for a ping and nothing else.  See also
               clntbroadcast().

          pmapset(prognum, versnum, protocol, port)
          ulong prognum, versnum, protocol;
          ushort port;

               A user interface to the portmap service, which
               establishes a mapping between the triple
               [prognum,versnum,protocol] and port on the machine's
               portmap service. The value of protocol is most likely
               IPPROTOUDP or IPPROTOTCP.  This routine returns one



     Licensed material--property of copyright holder(s)        Page 11





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               if it succeeds, zero otherwise.  Automatically done by
               svcregister().

          pmapunset(prognum, versnum)
          ulong prognum, versnum;

               A user interface to the portmap service, which destroys
               all mapping between the triple [prognum,versnum,*] and
               ports on the machine's portmap service. This routine
               returns one if it succeeds, zero otherwise.

          registerrpc(prognum, versnum, procnum, procname, inproc, outproc)
          ulong prognum, versnum, procnum;
          char *(*procname) () ;
          xdrproct inproc, outproc;

               Register procedure procname with the RPC service
               package.  If a request arrives for program prognum,
               version versnum, and procedure procnum, procname is
               called with a pointer to its parameter(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
               svcudpcreate() for restrictions.

          struct rpccreateerr     rpccreateerr;

               A global variable whose value is set by any RPC client
               creation routine that does not succeed.  Use the
               routine clntpcreateerror() to print the reason why.

          svcdestroy(xprt)
          SVCXPRT *xprt;

               A macro that destroys the RPC service transport handle,
               xprt.  Destruction usually involves deallocation of
               private data structures, including xprt itself.  Use of
               xprt is undefined after calling this routine.

          fdset svcfdset;

               A global variable reflecting the RPC service side's
               read file descriptor bit mask; it is suitable as a
               parameter to the select system call. This is only of
               interest if a service implementor does not call
               svcrun(), but rather does his own asynchronous event
               processing.  This variable is read-only (do not pass
               its address to select!), yet it may change after calls



     Licensed material--property of copyright holder(s)        Page 12





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               to svcgetreqset() or any creation routines.

          int svcfds;

               Similar to svcfedset(), but limited to 32 descriptors.
               This interface is obsoleted by svcfdset().

          svcfreeargs(xprt, inproc, in)
          SVCXPRT *xprt;
          xdrproct inproc;
          char *in;

               A macro that frees any data allocated by the RPC/XDR
               system when it decoded the arguments to a service
               procedure using svcgetargs().  This routine returns 1
               if the results were successfully freed, and zero
               otherwise.

          svcgetargs(xprt, inproc, in)
          SVCXPRT *xprt;
          xdrproct inproc;
          char *in;

               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.

          struct sockaddrin *
          svcgetcaller(xprt)
          SVCXPRT *xprt;

               The approved way of getting the network address of the
               caller of a procedure associated with the RPC service
               transport handle, xprt.

          svcgetreqset(rdfds)
          fdset *rdfds;

               This routine is only of interest if a service
               implementor does not call svcrun(), but instead
               implements custom asynchronous event processing.  It is
               called when the select system call has determined that
               an RPC request has arrived on some RPC socket(s) ;
               rdfds is the resultant read file descriptor bit mask.
               The routine returns when all sockets associated with
               the value of rdfds have been serviced.

          svcgetreq(rdfds)
          int rdfds;



     Licensed material--property of copyright holder(s)        Page 13





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



               Similar to svcgetreqset(), but limited to 32
               descriptors. This interface is obsoleted by
               svcgetreqset().

          svcregister(xprt, prognum, versnum, dispatch, protocol)
          SVCXPRT *xprt;
          ulong prognum, versnum;
          void (*dispatch) ();
          ulong protocol;

               Associates prognum and versnum with the service
               dispatch procedure, dispatch.  If protocol is zero, the
               service is not registered with the portmap service.  If
               protocol is non-zero, then a mapping of the triple
               [prognum,versnum,protocol] to xprt->xpport is
               established with the local portmap service (generally
               protocol is zero, IPPROTOUDP or IPPROTOTCP ).  The
               procedure dispatch has the following form:
                    dispatch(request, xprt)
                    struct svcreq *request;
                    SVCXPRT *xprt;

               The svcregister() routine returns one if it succeeds,
               and zero otherwise.

          svcrun()

               This routine never returns. It waits for RPC requests
               to arrive, and calls the appropriate service procedure
               using svcgetreq() when one arrives. This procedure is
               usually waiting for a select() system call to return.

          svcsendreply(xprt, outproc, out)
          SVCXPRT *xprt;
          xdrproct outproc;
          char *out;

               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 otherwise.

          void
          svcunregister(prognum, versnum)
          ulong prognum, versnum;

               Remove all mapping of the double [prognum,versnum] to
               dispatch routines, and of the triple
               [prognum,versnum,*] to port number.




     Licensed material--property of copyright holder(s)        Page 14





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          void
          svcerrauth(xprt, why)
          SVCXPRT *xprt;
          enum authstat why;

               Called by a service dispatch routine that refuses to
               perform a remote procedure call due to an
               authentication error.

          void
          svcerrdecode(xprt)
          SVCXPRT *xprt;

               Called by a service dispatch routine that cannot
               successfully decode its parameters. See also
               svcgetargs().

          void
          svcerrnoproc(xprt)
          SVCXPRT *xprt;

               Called by a service dispatch routine that does not
               implement the procedure number that the caller
               requests.

          void
          svcerrnoprog(xprt)
          SVCXPRT *xprt;

               Called when the desired program is not registered with
               the RPC package. Service implementors usually do not
               need this routine.

          void
          svcerrprogvers(xprt)
          SVCXPRT *xprt;

               Called when the desired version of a program is not
               registered with the RPC package. Service implementors
               usually do not need this routine.

          void
          svcerrsystemerr(xprt)
          SVCXPRT *xprt;

               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 routine.

          void
          svcerrweakauth(xprt)



     Licensed material--property of copyright holder(s)        Page 15





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          SVCXPRT *xprt;

               Called by a service dispatch routine that refuses to
               perform a remote procedure call due to insufficient
               (but correct) authentication parameters.  The routine
               calls svcerrauth(xprt, AUTHTOOWEAK).

          SVCXPRT *
          svcrawcreate()

               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 clntrawcreate().  This routine
               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.

          SVCXPRT *
          svctcpcreate(sock, sendbufsize, recvbufsize)
          int sock;
          uint sendbufsize, recvbufsize;

               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 RPCANYSOCK, 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, xprt->xpsock is the transport's socket
               descriptor, nd xprt->xpport 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.

          void
          svcfdcreate(fd, sendsize, recvsize)
          int fd;
          uint sendsize;
          uint recvsize;

               Create a service on top of any open desciptor.
               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 chosen.

          SVCXPRT *
          svcudpcreate(sock)



     Licensed material--property of copyright holder(s)        Page 16





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          int sock;

               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 RPCANYSOCK , 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
               completion, xprt->xpsock is the transport's socket
               descriptor, and xprt->xpport is the transport's port
               number.  This routine returns NULL if it fails.

               Warning: 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 arguments or return
               huge results.

          user2netname(name, uid, domain)
          char *name;
          int uid;
          char *domain;

               Convert from a domain-specific username to an
               operating-system independent netname. Returns TRUE if
               it succeeds and FALSE if it fails. Inverse of
               netname2user().

          xdracceptedreply(xdrs, ar)
          XDR *xdrs;
          struct acceptedreply *ar;

               Used for encoding RPC reply messages. This routine is
               useful for users who wish to generate RPC-style
               messages without using the RPC package.

          xdrauthunixparms(xdrs, aupp)
          XDR *xdrs;
          struct authunixparms *aupp;

               Used for describing UNIX credentials. This routine is
               useful for users who wish to generate these credentials
               without using the RPC authentication package.

          void
          xdrcallhdr(xdrs, chdr)
          XDR *xdrs;
          struct rpcmsg *chdr;

               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.




     Licensed material--property of copyright holder(s)        Page 17





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          xdrcallmsg(xdrs, cmsg)
          XDR *xdrs;
          struct rpcmsg *cmsg;

               Used for describing RPC call messages.  This routine is
               useful for users who wish to generate RPC-style
               messages without using the RPC package.

          xdropaqueauth(xdrs, ap)
          XDR *xdrs;
          struct opaqueauth *ap;

               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.

          xdrpmap(xdrs, regs)
          XDR *xdrs;
          struct pmap *regs;

               Used for describing parameters to various portmap
               procedures, externally.  This routine is useful for
               users who wish to generate these parameters without
               using the pmap interface.

          xdrpmaplist(xdrs, rp)
          XDR *xdrs;
          struct pmaplist **rp;

               Used for describing a list of port mappings,
               externally.  This routine is useful for users who wish
               to generate these parameters without using the pmap
               interface.

          xdrrejectedreply(xdrs, rr)
          XDR *xdrs;
          struct rejectedreply *rr;

               Used for describing RPC reply messages.  This routine
               is useful for users who wish to generate RPC-style
               messages without using the RPC package.

          xdrreplymsg(xdrs, rmsg)
          XDR *xdrs;
          struct rpcmsg *rmsg;

               Used for describing RPC reply messages.  This routine
               is useful for users who wish to generate RPC style
               messages without using the RPC package.

          void



     Licensed material--property of copyright holder(s)        Page 18





     rpc(3N)                    DG/UX 4.30                     rpc(3N)



          xprtregister(xprt)
          SVCXPRT *xprt;

               After RPC service transport handles are created, they
               should register themselves with the RPC service
               package.  This routine modifies the global variable
               svcfds().  Service implementors usually do not need
               this routine.

          void
          xprtunregister(xprt)
          SVCXPRT *xprt;

               Before an RPC service transport handle is destroyed, it
               should unregister itself with the RPC service package.
               This routine modifies the global variable svcfds().
               Service implementors usually do not need this routine.

     SEE ALSO
          xdr(3N), keyserv(8).



































     Licensed material--property of copyright holder(s)        Page 19



Typewritten Software • bear@typewritten.org • Edmonds, WA 98026