rpc(3)

๐ŸŒธ rpc โ€” library routines for remote procedure calls ๐ŸŒธ

okay bestie, so this is the <pink>rpc</pink> manual page โ€” it lives in section 3 of the manual, the Library Functions Manual, and it's literally the whole vibe of making procedure calls happen on other machines across the network. remote procedure calls, no cap. ๐Ÿ’…


๐Ÿ“š LIBRARY

Standard C library โ€” link it with -lc, that's it. ๐Ÿซถ


โœจ SYNOPSIS AND DESCRIPTION โœจ

okay so here's the whole story: these routines let your C programs make procedure calls on other machines across the network. ๐Ÿฆ‹ Here's how the little dance goes:

  1. First, the client calls a procedure to send a data packet to the server. ๐Ÿ“ฆ
  2. Upon receipt of the packet, the server calls a dispatch routine to perform the requested service, and then sends back a reply. ๐Ÿ’Œ
  3. Finally, the procedure call returns to the client. ๐ŸŽ€

To take use of these routines, include the header file <rpc/rpc.h>. (yes, literally that one, don't skip it) โœจ

The prototypes below make use of the following types:

typedef int bool_t;

typedef typeof(bool_t (XDR *, void *, ...))  *xdrproc_t;

typedef typeof(bool_t (caddr_t resp, struct sockaddr_in *raddr)
    *resultproc_t;

See the header files for the declarations of the AUTH, CLIENT, SVCXPRT, and XDR types. they're just vibing in there, go look. ๐Ÿ‘€


void auth_destroy(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() โ€” like, it's gone gone, don't text it back. ๐Ÿ™ˆ

AUTH *authnone_create(void);

Create and return an RPC authentication handle that passes nonusable authentication information with each remote procedure call. This is the default authentication used by RPC. so if you didn't ask for auth, this is the one you got, bestie. ๐ŸŽ€

AUTH *authunix_create(char *host, uid_t uid, gid_t gid, int n, gid_t aup_gids[n]);

Create and return an RPC authentication handle that contains authentication information. Here's the breakdown:

  • host โ€” the name of the machine on which the information was created ๐Ÿ–ฅ๏ธ
  • uid โ€” the user's user ID
  • gid โ€” the user's current group ID
  • n and aup_gids โ€” a counted array of groups to which the user belongs
โš ๏ธ It is easy to impersonate a user. bestie this is not a flex, it's a warning ๐Ÿ˜ญ

AUTH *authunix_create_default(void);

Calls authunix_create() with the appropriate parameters. it just does the thing for you, slay. โœจ

int callrpc(char *host, unsigned long prognum, unsigned long versnum, unsigned long procnum, xdrproc_t inproc, const char *in, xdrproc_t outproc, char *out);

Call the remote procedure associated with prognum, versnum, and procnum on the machine, host. ๐Ÿ›ฐ๏ธ

  • in โ€” the address of the procedure's argument(s)
  • out โ€” the address of where to place the result(s)
  • inproc โ€” used to encode the procedure's parameters
  • outproc โ€” 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(unsigned long prognum, unsigned long versnum, unsigned long procnum, xdrproc_t inproc, char *in, xdrproc_t outproc, char *out, 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(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; 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. so mind your packet size bestie ๐Ÿ’€

enum clnt_stat clnt_call(CLIENT *clnt, unsigned long procnum, xdrproc_t inproc, char *in, xdrproc_t outproc, char *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 clnt_create(). ๐Ÿ’…

  • in โ€” the address of the procedure's argument(s)
  • out โ€” the address of where to place the result(s)
  • inproc โ€” used to encode the procedure's parameters
  • outproc โ€” used to decode the procedure's results
  • tout โ€” the time allowed for results to come back โณ

clnt_destroy(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 clnt_destroy(). If the RPC library opened the associated socket, it will close it also. Otherwise, the socket remains open. ๐Ÿšช

CLIENT *clnt_create(const char *host, unsigned long prog, unsigned long vers, const 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 hold only up to 8 Kbytes of encoded data, this transport cannot be used for procedures that take large arguments or return huge results. ๐Ÿ˜ญ

bool_t clnt_control(CLIENT *cl, int req, 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. lowkey a trap, fr fr ๐Ÿ™ˆ
CLGET_SERVER_ADDR  struct sockaddr_in
                // get server's address

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. ๐Ÿ”

clnt_freeres(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. ๐Ÿงน

  • out โ€” the address of the results
  • outproc โ€” the XDR routine describing the results

This routine returns one if the results were successfully freed, and zero otherwise.

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

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

void clnt_pcreateerror(const 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(enum clnt_stat stat);

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

clnt_perror(CLIENT *clnt, const 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(const 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 overwritten on each call. so don't hold onto it, bestie ๐Ÿ’€

char *clnt_sperrno(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
  • the programmer does not want the message to be output with printf(3), or
  • a message format different than that supported by clnt_perrno() is to be used
๐Ÿ“ Note: unlike clnt_sperror() and clnt_spcreateerror(), clnt_sperrno() returns pointer to static data, but the result will not get overwritten on each call. one of these things is not like the others โœจ

char *clnt_sperror(CLIENT *rpch, const 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 overwritten on each call. yep, same trap again ๐Ÿ˜ญ

CLIENT *clntraw_create(unsigned long prognum, unsigned long 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 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(struct sockaddr_in *addr, unsigned long prognum, unsigned long versnum, int *sockp, unsigned int sendsz, unsigned int recvsz);

(bestie this one's getting cut off right here โ€” more incoming, don't go anywhere ๐Ÿ’–)

okay so closing out clnttcp_create() ๐Ÿ’™ โ€” it creates an RPC client for the remote program prognum, version versnum, and this baby rides TCP/IP as its transport. The remote program is located at Internet address *addr. If addr->sin_port is zero, then it gets set to the actual port that the remote program is listening on (and yes bestie, the remote portmap service is consulted for exactly that info ๐Ÿ‘€). The parameter sockp is a socket; if it's RPC_ANYSOCK, then this routine opens a new one and sets sockp. And since TCP-based RPC uses buffered I/O, you get to 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. ๐Ÿ™ˆ


๐Ÿฆ‹ clntudp_create()

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

This routine creates an RPC client for the remote program prognum, version versnum; the client uses 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 the actual port that the remote program is listening on (the remote portmap service is consulted for this information, iykyk โœจ). The parameter sockp is a socket; if it's 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 hold only up to 8 Kbytes of encoded data, this transport cannot be used for procedures that take large arguments or return huge results. So if your payload is thicc, this is not the vibe. ๐Ÿ’€

๐ŸŒธ clntudp_bufcreate()

CLIENT *clntudp_bufcreate(struct sockaddr_in *addr,
            unsigned long prognum, unsigned long versnum,
            struct timeval wait, int *sockp,
            unsigned int sendsize, unsigned int recosize);

This routine creates an RPC client for the remote program prognum, on versnum; the client uses 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 the actual port that the remote program is listening on (yes, the remote portmap service is consulted for this information again ๐ŸŽ€). The parameter sockp is a socket; if it's 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().

This one is the upgrade, bestie โ€” it allows the user to specify the maximum packet size for sending and receiving UDP-based RPC messages. ๐Ÿ’…


๐Ÿงš get_myaddress()

void get_myaddress(struct sockaddr_in *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). That's it, that's the whole girl. โœจ


๐Ÿ‘‘ pmap_getmaps()

struct pmaplist *pmap_getmaps(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 routine. So if you've ever run that and wondered who's behind the curtain... it's her. ๐Ÿซถ


๐Ÿ’œ pmap_getport()

unsigned short pmap_getport(struct sockaddr_in *addr,
                    unsigned long prognum, unsigned long versnum,
                    unsigned int 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 failed to contact the remote portmap service. In the latter case, the global variable rpc_createerr contains the RPC status. So zero is giving ambiguous energy and you gotta go check rpc_createerr to find out which one it is, fr fr. ๐Ÿ˜ญ


๐ŸŒˆ pmap_rmtcall()

enum clnt_stat pmap_rmtcall(struct sockaddr_in *addr,
                    unsigned long prognum, unsigned long versnum,
                    unsigned long procnum,
                    xdrproc_t inproc, char *in,
                    xdrproc_t outproc, char *out,
                    struct timeval tout, unsigned 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 the other parameters are discussed in callrpc() and clnt_call().

Important: this procedure should be used for a โ€œpingโ€ and nothing else. Just a little hey-girl-are-you-there. Don't build your whole architecture on it. ๐Ÿ™…โ€โ™€๏ธ

See also clnt_broadcast().


๐ŸŽ€ pmap_set()

bool_t pmap_set(unsigned long prognum, unsigned long versnum,
                int protocol, unsigned short 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 IPPROTO_UDP or IPPROTO_TCP. This routine returns one if it succeeds, zero otherwise.

And fun fact that saves you a whole step: it's automatically done by svc_register(). ๐Ÿ‘‘


๐Ÿ“ pmap_unset()

bool_t pmap_unset(unsigned long prognum, unsigned long 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. Note the * โ€” she's taking out everything for that program/version combo, no survivors. This routine returns one if it succeeds, zero otherwise.


โœจ registerrpc()

int registerrpc(unsigned long prognum, unsigned long versnum,
                unsigned long procnum, typeof(char *(char *)) *procname,
                xdrproc_t inproc, xdrproc_t 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); procname 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 svcudp_create() for restrictions. ๐Ÿ‘€

๐Ÿ’… rpc_createerr

struct rpc_createerr rpc_createerr;

A global variable whose value is set by any RPC client creation routine that does not succeed. Use the routine clnt_pcreateerror() to print the reason why. It's basically the group chat where all the failed client creations leave their drama. ๐Ÿ˜ญ


๐Ÿซถ svc_destroy()

void svc_destroy(SVCXPRT *xprt);

A macro that destroys the RPC service transport handle, xprt. Destruction usually involves deallocation of private data structures, including xprt itself.

Careful bestie: use of xprt is undefined after calling this routine. She's gone. Don't text her. ๐Ÿ’€

๐ŸŒธ svc_fdset

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(2) system call. This is of interest only if a service implementor does their own asynchronous event processing, instead of calling svc_run().

This variable is read-only (do not pass its address to select(2)!), yet it may change after calls to svc_getreqset() or any creation routines. So look, don't touch. ๐Ÿ™ˆ

๐Ÿฆ‹ svc_fds

int svc_fds;

Similar to svc_fdset, but limited to 32 file descriptors. This interface is obsoleted by svc_fdset. She's legacy, she's retired, we respect her history. ๐ŸŽ€


๐Ÿ’œ svc_freeargs()

svc_freeargs(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 procedure using svc_getargs(). This routine returns 1 if the results were successfully freed, and zero otherwise. Cleanup queen. ๐Ÿงนโœจ


๐ŸŒˆ svc_getargs()

svc_getargs(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. And when you're done with them, svc_freeargs() is right there waiting for you. ๐Ÿซถ


๐Ÿงš svc_getcaller()

struct sockaddr_in *svc_getcaller(SVCXPRT *xprt);

The approved way of getting the network address of the caller of a procedure associated with the RPC service transport handle, xprt. Approved as in, this is the sanctioned move โ€” take notes. ๐Ÿ‘‘


๐Ÿ”ฅ svc_getreqset()

void svc_getreqset(fd_set *rdfds);

This routine is of interest only if a service implementor does not call svc_run(), but instead implements custom asynchronous event processing. It is called when the select(2) 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.


๐ŸŒŸ svc_getreq()

void svc_getreq(int rdfds);

Similar to svc_getreqset(), but limited to 32 file descriptors. This interface is obsoleted by svc_getreqset(). Same deal as her sibling svc_fds โ€” iconic in her day, but we've moved on. ๐Ÿ’…


๐ŸŽ€ svc_register()

bool_t svc_register(SVCXPRT *xprt, unsigned long prognum,
                    unsigned long versnum,
                    typeof(void (struct svc_req *, SVCXPRT *)) *dispatch,
                    unsigned 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 nonzero, then a mapping of the triple [prognum,versnum,protocol] to xprt->xp_port is established with the local portmap service (generally protocol is zero, IPPROTO_UDP or IPPROTO_TCP).

The procedure dispatch has the following form:

dispatch(struct svc_req *request, SVCXPRT *xprt);

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


๐Ÿฆ‹ svc_run()

void svc_run(void);
This routine never returns.

She is eternal. ๐Ÿ•ฐ๏ธโœจ 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(2) system call to return.


๐Ÿ’– svc_sendreply()

bool_t svc_sendreply(SVCXPRT *xprt, xdrproc_t 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. Delivering the results like the main character she is. ๐Ÿ‘‘

  • void svc_unregister(unsigned long prognum, unsigned long versnum); โ€” bestie, this one yeets all mapping of the double [prognum,versnum] to dispatch routines, and of the triple [prognum,versnum,*] to port number. Like, gone. โœจ
  • void svcerr_auth(SVCXPRT *xprt, enum auth_stat why); โ€” your service dispatch routine calls this when it's refusing to perform a remote procedure call because of an authentication error. It's giving โ€œnot today, auth said noโ€. ๐Ÿ”’
  • void svcerr_decode(SVCXPRT *xprt); โ€” called by a service dispatch routine that literally cannot successfully decode its parameters. The struggle is real, bestie. Also go peek at svc_getargs(). ๐Ÿ˜ญ
  • void svcerr_noproc(SVCXPRT *xprt); โ€” for when a service dispatch routine does not implement the procedure number that the caller is requesting. It's the โ€œI don't know herโ€ of RPC. ๐Ÿ™…โ€โ™€๏ธ
  • void svcerr_noprog(SVCXPRT *xprt); โ€” gets called when the desired program is not registered with the RPC package. Service implementors usually do not need this routine, so don't stress, okay? ๐Ÿซถ
  • void svcerr_progvers(SVCXPRT *xprt, unsigned long low_vers, unsigned long high_vers); โ€” called when the desired version of a program isn't registered with the RPC package. Again, service implementors usually do not need this routine. lowkey no thoughts, just vibes. ๐ŸŒธ
  • void svcerr_systemerr(SVCXPRT *xprt); โ€” a service dispatch routine calls this when it detects a system error that isn't covered by any particular protocol. For example, if a service can no longer allocate storage, it may call this routine. chaos, but make it protocol-correct. ๐Ÿ’€
  • void svcerr_weakauth(SVCXPRT *xprt); โ€” called by a service dispatch routine that refuses to perform a remote procedure call due to insufficient authentication parameters. The routine calls svcerr_auth(xprt, AUTH_TOOWEAK). Weak auth? Not on her watch. ๐Ÿ‘‘
  • SVCXPRT *svcfd_create(int fd, unsigned int sendsize, unsigned int recvsize); โ€” create a service on top of any open file descriptor. Typically, this file 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. flexible queen. ๐Ÿงš
  • SVCXPRT *svcraw_create(void); โ€” 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 overheads (such as round trip times), without any kernel interference. This routine returns NULL if it fails. toy transport, no kernel drama. ๐ŸŽ€
  • SVCXPRT *svctcp_create(int sock, unsigned int send_buf_size, unsigned int recv_buf_size); โ€” 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 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, and 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. TCP realness with buffer control. ๐Ÿ”ฅ
  • SVCXPRT *svcudp_bufcreate(int sock, unsigned int sendsize, unsigned int recosize); โ€” 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 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 completion, 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. This allows the user to specify the maximum packet size for sending and receiving UDP-based RPC messages. UDP but make it sized. โœจ
  • SVCXPRT *svcudp_create(int sock); โ€” this call is equivalent to svcudp_bufcreate(sock,SZ,SZ) for some default size SZ. same energy, default size. ๐Ÿ’…
  • bool_t xdr_accepted_reply(XDR *xdrs, struct accepted_reply *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. DIY RPC vibes. ๐Ÿฆ‹
  • bool_t xdr_authunix_parms(XDR *xdrs, struct authunix_parms *aupp); โ€” used for describing UNIX credentials. This routine is useful for users who wish to generate these credentials without using the RPC authentication package. credentials, but handmade. ๐Ÿ’–
  • void xdr_callhdr(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. header tea. ๐Ÿ“
  • bool_t xdr_callmsg(XDR *xdrs, struct rpc_msg *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. call message, no package needed. ๐ŸŒˆ
  • bool_t xdr_opaque_auth(XDR *xdrs, struct opaque_auth *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. opaque but iconic. โญ
  • bool_t xdr_pmap(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. portmap but offline. ๐Ÿ”
  • bool_t xdr_pmaplist(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. list of mappings, served fresh. ๐Ÿซถ
  • bool_t xdr_rejected_reply(XDR *xdrs, struct rejected_reply *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. rejected, but make it XDR. ๐Ÿ˜ญ
  • bool_t xdr_replymsg(XDR *xdrs, struct rpc_msg *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. reply message realness. ๐Ÿ’œ
  • void xprt_register(SVCXPRT *xprt); โ€” after RPC service transport handles are created, they should register themselves with the RPC service package. This routine modifies the global variable svc_fds. Service implementors usually do not need this routine. registration era. ๐Ÿ“
  • void xprt_unregister(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. clean exit, bestie. ๐Ÿ‘‹

๐Ÿ’… ATTRIBUTES ๐Ÿ’…

For an explanation of the terms used in this section, see attributes(7). iykyk. ๐Ÿ’–

  • Thread safety: MT-Safe โ€” and it applies to this whole squad: auth_destroy(), authnone_create(), 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(), clntudp_bufcreate(), get_myaddress(), pmap_getmaps(), pmap_getport(), 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(), svcfd_create(), svcraw_create(), svctcp_create(), svcudp_bufcreate(), svcudp_create(), xdr_accepted_reply(), xdr_authunix_parms(), xdr_callhdr(), xdr_callmsg(), xdr_opaque_auth(), xdr_pmap(), xdr_pmaplist(), xdr_rejected_reply(), xdr_replymsg(), xprt_register(), xprt_unregister(). MT-Safe across the board. ๐ŸŒˆโœจ

๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

  • xdr(3) โ€” the bestie companion page. ๐Ÿ’œ

The following manuals:

  • Remote Procedure Calls: Protocol Specification
  • Remote Procedure Call Programming Guide
  • rpcgen Programming Guide

Also: RPC: Remote Procedure Call Protocol Specification, RFC 1050, Sun Microsystems, Inc., USC-ISI. academic baddie energy. ๐Ÿ“š


This page came from Linux man-pages 6.20, dated 2025-09-21, and it's serving rpc(3) realness. Periodt. ๐Ÿ’…โœจ

๐Ÿ“ฆ where this page comes from
  • arch rolling: man-pages 6.20-1 ยท BSD-2-Clause AND BSD-3-Clause AND BSD-4.3TAHOE AND BSD-4-Clause-UC AND GPL-1.0-or-later AND GPL-2.0-only AND GPL-2.0-or-later AND GPL-3.0-or-later AND LGPL-3.0-linking-exception AND LGPL-3.0-or-later AND LicenseRef-Public-Domain AND LicenseRef-UltraPermissive AND Linux-man-pages-1-para AND Linux-man-pages-copyleft AND Linux-man-pages-copyleft-2-para AND Linux-man-pages-copyleft-var AND MIT AND Spencer-94
  • nixpkgs unstable: man-pages 6.20
  • ๐Ÿ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms