|RPCGEN(1)||General Commands Manual||RPCGEN(1)|
rpcgenis a tool that generates C code to implement an RPC protocol. The input is a language similar to C known as RPC Language (Remote Procedure Call Language).
rpcgenis normally used as in the first synopsis where it takes an input file and generates up to four output files. If the infile is named proto.x, then
rpcgenwill generate a header file in proto.h, XDR routines in proto_xdr.c, server-side stubs in proto_svc.c, and client-side stubs in proto_clnt.c. With the
-Toption, it will also generate the RPC dispatch table in proto_tbl.i. With the
-Scoption, it will also generate sample code which would illustrate how to use the remote procedures on the client side. This code would be created in proto_client.c. With the
-Ssoption, it will also generate a sample server code which would illustrate how to write the remote procedures. This code would be created in proto_server.c. The server created can be started both by the port monitors (for example, inetd(8)) or by itself. When it is started by a port monitor, it creates servers only for the transport for which the file descriptor 0 was passed. The transports are chosen at run time and not at compile time. When the server is self-started, it backgrounds itself by default. A special define symbol
RPC_SVC_FGcan be used to run the server process in the foreground. The second synopsis provides special features which allow for the creation of more sophisticated RPC servers. These features include support for user provided
#definesand RPC dispatch tables. The entries in the RPC dispatch table contain:
rpcgenis executed with the
-soption, it creates servers for that particular class of transports. When executed with the
-noption, it creates a server for the transport specified by netid. If infile is not specified,
rpcgenaccepts the standard input. The C preprocessor, cpp(1) is run on the input file before it is actually interpreted by
rpcgen. For each type of output file,
rpcgendefines a special preprocessor symbol for use by the
rpcgen. For every data type referred to in infile
rpcgenassumes that there exists a routine with the string “xdr_” prepended to the name of the data type. If this routine does not exist in the RPC/XDR library, it must be provided. Providing an undefined data type allows customization of XDR routines. The options are as follows:
name. Equivalent to the
#definedirective in the source. If no value is given, value is defined as 1. This option may be specified more than once.
-Toption can be used in conjunction to produce a header file which supports RPC dispatch tables.
rpcgenwait 120 seconds after servicing a request before exiting. That interval can be changed using the
-Kflag. To create a server that exits immediately upon servicing a request, “
-K0” can be used. To create a server that never exits, the appropriate argument is “
-K-1”. When monitoring for a server, some port monitors, like the AT&T System V UNIX listen utility, always spawn a new process in response to a service request. If it is known that a server will be used with such a monitor, the server should exit immediately on completion. For such servers,
rpcgenshould be used with “
main() routine. This option is useful for doing callback-routines and for users who need to write their own
main() routine to do initialization.
rpcgen. This allows procedures to have multiple arguments. It also uses the style of parameter passing that closely resembles C. So, when passing an argument to a remote procedure you do not have to pass a pointer to the argument but the argument itself. This behaviour is different from the oldstyle of
rpcgengenerated code. The newstyle is not the default case because of backward compatibility.
-tare used exclusively to generate a particular type of file, while the options
-Tare global and can be used with the other options.
$ rpcgen -T prot.x
$ rpcgen -h prot.x
-DTEST, server side stubs for all the transport belonging to the class datagram_n to standard output, use:
$ rpcgen -s datagram_n -DTEST prot.x
$ rpcgen -n tcp -o prot_svc.c prot.x
-noption refers to the transport indicated by netid and hence is very site specific. cpp(1)
|September 11, 2015||OpenBSD-current|