Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

xdr(3N)

keyserv(1M)



RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



NAME
     rpc - library routines for remote procedure calls

SYNOPSIS AND DESCRIPTION
   Headers
     For -systype svr3:

     #include <bsd/sys/types.h>
     #include <rpc/rpc.h>

     For -systype bsd43:

     #include <rpc/rpc.h>

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

     void
     auth_destroy(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 auth_destroy().

     AUTH *
     authnone_create()

          Create and returns an RPC authentication handle that
          passes nonusable authentication information with each
          remote procedure call. This is the default authentica-
          tion used by RPC.

     AUTH *
     authdes_create(name, window, syncaddr, ckey)
     char *name;
     unsigned window;
     struct sockaddr *addr;
     des_block *ckey;

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



                        Printed 11/19/92                   Page 1





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          authdes_create(), 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 host-
          name 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 resynchroniza-
          tions because of clock drift. The third parameter syn-
          caddr is optional.  If it is NULL, then the authentica-
          tion 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 sys-
          tem 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.

     authdes_getucred(adc, uid, gid, grouplen, groups)
     struct authdes_cred *adc;
     short *uid;
     short *gid;
     short *grouplen;
     int *groups;

          authdes_getucred(), the second of the two DES authenti-
          cation routines, is used on the server side for con-
          verting a DES credential, which is operating system
          independent, into a UNIX credential. This routine
          differs from utility routine netname2user in that
          authdes_getucred() pulls its information from a cache,
          and does not have to do a Network Information Service
          lookup every time it is called to get its information.

     AUTH *
     authunix_create(host, uid, gid, len, aup_gids)
     char *host;
     int uid, gid, len, *aup.gids;

          Create and return an RPC authentication handle that
          contains UNIX authentication information.  The parame-
          ter host is the name of the machine on which the infor-
          mation 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.



 Page 2                 Printed 11/19/92





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          It is easy to impersonate a user.

     AUTH *
     authunix_create_default()

          Calls authunix_create() with the appropriate parame-
          ters.

     callrpc(host, prognum, versnum, procnum, inproc, in, outproc, out)
     char *host;
     u_long prognum, versnum, procnum;
     char *in, *out;
     xdrproc_t inproc, outproc;

          Call the remote procedure associated with prognum,
          versnum, and procnum on the machine, host.  The parame-
          ter 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 clnt_stat cast to an integer if it fails.  The
          routine clnt_perrno() is handy for translating failure
          statuses into messages.

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

     enum clnt_stat
     clnt_broadcast(prognum, versnum, procnum, inproc, in, outproc, out, eachresult)
     u_long prognum, versnum, procnum;
     char *in, *out;
     xdrproc_t inproc, outproc;
     resultproc_t 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 sockaddr_in *addr;

          where out is the same as out passed to
          clnt_broadcast(), 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, clnt_broadcast() waits for more replies;



                        Printed 11/19/92                   Page 3





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          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 clnt_stat
     clnt_call(clnt, procnum, inproc, in, outproc, out, tout)
     CLIENT *clnt;
     u_long
     procnum;
     xdrproc_t inproc, outproc;
     char *in, *out;
     struct timeval tout;

          A macro that calls the remote procedure procnum associ-
          ated with the client handle, clnt, which is obtained
          with an RPC client creation routine such as
          clnt_create().  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.

     clnt_destroy(clnt)
     CLIENT *clnt;

          A macro that destroys the client's RPC handle. Destruc-
          tion usually involves deallocation of private data
          structures, including clnt itself.  Use of clnt is
          undefined after calling clnt_destroy().  If the RPC
          library opened the associated socket, it will close it
          also.  Otherwise, the socket remains open.

     CLIENT *
     clnt_create(host, prog, vers, proto)
     char *host;
     u_long 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 clnt_control().

          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 pro-
          cedures that take large arguments or return huge



 Page 4                 Printed 11/19/92





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          results.

     bool_t
     clnt_control(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 clnt_control(), the
          timeout parameter passed to clnt_call() will be ignored
          in all future calls.


          CLGET_SERVER_ADDR   struct sockaddr     get server's address

          The following operations are valid for UDP only:


          CLSET_RETRY_TIMEOUT struct timevalset the retry timeout
          CLGET_RETRY_TIMEOUT struct timevalget the retry timeout

          The retry timeout is the time that UDP RPC waits for
          the server to reply before retransmitting the request.

     clnt_freeres(clnt, outproc, out)
     CLIENT *clnt;
     xdrproc_t 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 success-
          fully freed, and zero otherwise.

     void
     clnt_geterr(clnt, errp)
     CLIENT *clnt;
     struct rpc_err *errp;

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



                        Printed 11/19/92                   Page 5





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



     void
     clnt_pcreateerror(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
          clnt_create(), clntraw_create(), clnttcp_create(), or
          clntudp_create() call fails.

     void
     clnt_perrno(stat)
     enum clnt_stat stat;

          Print a message to standard error corresponding to the
          condition indicated by stat.  Used after callrpc().

     clnt_perror(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 clnt_call().

     char *
     clnt_spcreateerror
     char *s;

          Like clnt_pcreateerror(), except that it returns a
          string instead of printing to the standard error.

          Bugs: returns pointer to static data that is overwrit-
          ten on each call.

     char *
     clnt_sperrno(stat)
     enum clnt_stat stat;

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

          clnt_sperrno() is used instead of clnt_perrno() 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 sup-
          ported by clnt_perrno() is to be used.  Note: unlike



 Page 6                 Printed 11/19/92





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          clnt_sperror() and clnt_spcreateerror(), clnt_sperrno()
          does not return pointer to static data so the result
          will not get overwritten on each call.

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

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

          Bugs: returns pointer to static data that is overwrit-
          ten on each call.

     CLIENT *
     clntraw_create(prognum, versnum)
     u_long 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 correspond-
          ing RPC server should live in the same address space;
          see svcraw_create().  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 *
     clnttcp_create(addr, prognum, versnum, sockp, sendsz, recvsz)
     struct sockaddr_in *addr;
     u_long prognum, versnum;
     int *sockp;
     u_int sendsz, recvsz;

          This routine creates an RPC client for the remote pro-
          gram prognum, version versnum; the client uses TCP/IP
          as a transport. The remote program is located at Inter-
          net address *addr.  If addr->sin_port 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 RPC_ANYSOCK, 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.





                        Printed 11/19/92                   Page 7





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



     CLIENT *
     clntudp_create(addr, pronum, versnum, wait, sockp)
     struct sockaddr_in *addr;
     u_long prognum, versnum;
     struct timeval wait;
     int *sockp;

          This routine creates an RPC client for the remote pro-
          gram prognum, version versnum; the client uses use
          UDP/IP as a transport. The remote program is located at
          Internet address addr.  If addr->sin_port 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 RPC_ANYSOCK, 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
          received or until the call times out.  The total time
          for the call to time out is specified by clnt_call().

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

     key_decryptsession(remotename, deskey)
     char *remotename;
     des_block *deskey;

          key_decryptsession() is an interface to the keyserver
          daemon, which is associated with RPC's secure authenti-
          cation system (DES authentication).  User programs
          rarely need to call it, or its associated routines
          key_encryptsession(), key_gendes() and key_setsecret().
          System commands such as login and the RPC library are
          the main clients of these four routines.

          key_decryptsession() 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 key_encryptsession().



 Page 8                 Printed 11/19/92





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



     key_encryptsession(remotename, deskey)
     char *remotename;
     des_block *deskey;

          key_encryptsession() 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
          key_decryptsession().

     key_gendes(deskey)
     des_block *deskey;

          key_gendes() is a keyserver interface routine. It is
          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.

     key_setsecret(key)
     char *key;

          key_setsecret() is a keyserver interface routine. It is
          used to set the key for the effective uid of the cal-
          ling process.

     void
     get_myaddress(addr)
     struct sockaddr_in *addr;

          Stuff the machine's IP address into *addr, without con-
          sulting 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().



                        Printed 11/19/92                   Page 9





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



     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 *
     pmap_getmaps(addr)
     struct sockaddr_in *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 rou-
          tine.

     u_short
     pmap_getport(addr, prognum, versnum, protocol)
     struct sockaddr_in *addr;
     u_long 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 IPPROTO_UDP or IPPROTO_TCP.
          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 rpc_createerr() contains the RPC status.

     enum clnt_stat
     pmap_rmtcall(addr, prognum, versnum, procnum, inproc, in, outproc, out, tout, portp)
     struct sockaddr_in *addr;
     u_long prognum, versnum, procnum;
     char *in, *out;
     xdrproc_t inproc, outproc;
     struct timeval tout;
     u_long *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 clnt_call().  This procedure should be



 Page 10                Printed 11/19/92





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          used for a ping and nothing else.  See also
          clnt_broadcast().

     pmap_set(prognum, versnum, protocol, port)
     u_long prognum, versnum, protocol;
     u_short port;

          A user interface to the portmap service, which estab-
          lishes a mapping between the triple
          [prognum,versnum,protocol] and port on the machine's
          portmap service. The value of protocol is most likely
          IPPROTO_UDP or IPPROTO_TCP.  This routine returns one
          if it succeeds, zero otherwise.  Automatically done by
          svc_register().

     pmap_unset(prognum, versnum)
     u_long 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)
     u_long prognum, versnum, procnum;
     char *(*procname) () ;
     xdrproc_t inproc, outproc;

          Register procedure procname with the RPC service pack-
          age.  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 regis-
          tration succeeded, -1 otherwise.

          Warning: remote procedures registered in this form are
          accessed using the UDP/IP transport; see
          svcudp_create() for restrictions.

     struct rpc_createerr     rpc_createerr;

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

     svc_destroy(xprt)
     SVCXPRT *
     xprt;

          A macro that destroys the RPC service transport handle,



                        Printed 11/19/92                  Page 11





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          xprt.  Destruction usually involves deallocation of
          private data structures, including xprt itself.  Use of
          xprt is undefined after calling this routine.

     fd_set svc_fdset;

          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
          svc_run(), 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
          to svc_getreqset() or any creation routines.

     int svc_fds;

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

     svc_freeargs(xprt, inproc, in)
     SVCXPRT *xprt;
     xdrproc_t inproc;
     char *in;

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

     svc_getargs(xprt, inproc, in)
     SVCXPRT *xprt;
     xdrproc_t 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 sockaddr_in *
     svc_getcaller(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.





 Page 12                Printed 11/19/92





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



     svc_getreqset(rdfds)
     fd_set *rdfds;

          This routine is only of interest if a service implemen-
          tor does not call svc_run(), 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 rou-
          tine returns when all sockets associated with the value
          of rdfds have been serviced.

     svc_getreq(rdfds)
     int rdfds;

          Similar to svc_getreqset(), but limited to 32 descrip-
          tors. This interface is obsoleted by svc_getreqset().

     svc_register(xprt, prognum, versnum, dispatch, protocol)
     SVCXPRT *xprt;
     u_long prognum, versnum;
     void (*dispatch) ();
     u_long 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->xp_port is esta-
          blished with the local portmap service (generally pro-
          tocol is zero, IPPROTO_UDP or IPPROTO_TCP ).  The pro-
          cedure dispatch has the following form:
               dispatch(request, xprt)
               struct svc_req *request;
               SVCXPRT *xprt;

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

     svc_run()

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

     svc_sendreply(xprt, outproc, out)
     SVCXPRT *xprt;
     xdrproc_t outproc;
     char *out;

          Called by an RPC service's dispatch routine to send the



                        Printed 11/19/92                  Page 13





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          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
     svc_unregister(prognum, versnum)
     u_long prognum, versnum;

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

     void
     svcerr_auth(xprt, why)
     SVCXPRT *xprt;
     enum auth_stat why;

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

     void
     svcerr_decode(xprt)
     SVCXPRT *xprt;

          Called by a service dispatch routine that cannot suc-
          cessfully decode its parameters. See also
          svc_getargs().

     void
     svcerr_noproc(xprt)
     SVCXPRT *xprt;

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

     void
     svcerr_noprog(xprt)
     SVCXPRT *xprt;

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

     void
     svcerr_progvers(xprt)
     SVCXPRT *xprt;

          Called when the desired version of a program is not



 Page 14                Printed 11/19/92





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          registered with the RPC package. Service implementors
          usually do not need this routine.

     void
     svcerr_systemerr(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
     svcerr_weakauth(xprt)
     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 svcerr_auth(xprt, AUTH_TOOWEAK).

     SVCXPRT *
     svcraw_create()

          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 clntraw_create().  This routine
          allows simulation of RPC and acquisition of RPC over-
          heads (such as round trip times), without any kernel
          interference.  This routine returns NULL if it fails.

     SVCXPRT *
     svctcp_create(sock, send_buf_size, recv_buf_size)
     int sock;
     u_int send_buf_size, recv_buf_size;

          This routine creates a TCP/IP-based RPC service tran-
          sport, to which it returns a pointer.  The transport is
          associated with the socket sock, which may be
          RPC_ANYSOCK, 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->xp_sock is the transport's socket descriptor, nd
          xprt->xp_port 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
     svcfd_create(fd, sendsize, recvsize)



                        Printed 11/19/92                  Page 15





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



     int fd;
     u_int sendsize;
     u_int recvsize;

          Create a service on top of any open desciptor. Typi-
          cally, 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 *
     svcudp_create(sock)
     int sock;

          This routine creates a UDP/IP-based RPC service tran-
          sport, to which it returns a pointer.  The transport is
          associated with the socket sock, which may be
          RPC_ANYSOCK , 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, xprt->xp_sock is the transport's socket
          descriptor, and xprt->xp_port 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().

     xdr_accepted_reply(xdrs, ar)
     XDR *xdrs;
     struct accepted_reply *ar;

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

     xdr_authunix_parms(xdrs, aupp)
     XDR *xdrs;
     struct authunix_parms *aupp;

          Used for describing UNIX credentials. This routine is



 Page 16                Printed 11/19/92





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          useful for users who wish to generate these credentials
          without using the RPC authentication package.

     void
     xdr_callhdr(xdrs, chdr)
     XDR *xdrs;
     struct rpc_msg *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.

     xdr_callmsg(xdrs, cmsg)
     XDR *xdrs;
     struct rpc_msg *cmsg;

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

     xdr_opaque_auth(xdrs, ap)
     XDR *xdrs;
     struct opaque_auth *ap;

          Used for describing RPC authentication information mes-
          sages.  This routine is useful for users who wish to
          generate RPC-style messages without using the RPC pack-
          age.

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

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

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

          Used for describing a list of port mappings, exter-
          nally.  This routine is useful for users who wish to
          generate these parameters without using the pmap inter-
          face.

     xdr_rejected_reply(xdrs, rr)
     XDR *xdrs;
     struct rejected_reply *rr;

          Used for describing RPC reply messages.  This routine



                        Printed 11/19/92                  Page 17





RPC(3N-BSD)         RISC/os Reference Manual          RPC(3N-BSD)



          is useful for users who wish to generate RPC-style mes-
          sages without using the RPC package.

     xdr_replymsg(xdrs, rmsg)
     XDR *xdrs;
     struct rpc_msg *rmsg;

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

     void
     xprt_register(xprt)
     SVCXPRT *xprt;

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

     void
     xprt_unregister(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 svc_fds().
          Service implementors usually do not need this routine.

SEE ALSO
     xdr(3N).
     keyserv(1M) in the System Administrator's Reference Manual.

     Chapter 19 in the Programmer's Guide.

ORIGIN
     Sun Microsystems

NOTE
     When these routines are used in a program which is compiled
     in -systype svr3, they are not resolved by libc.a.  See
     intro(3) for more information.












 Page 18                Printed 11/19/92



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