diff options
Diffstat (limited to 'man3/rpc.3')
| -rw-r--r-- | man3/rpc.3 | 106 |
1 files changed, 53 insertions, 53 deletions
@@ -41,7 +41,7 @@ Destruction usually involves deallocation of private data structures. The use of .I auth is undefined after calling -.BR auth_destroy() . +.BR auth_destroy (). .br .if t .ne 6 .LP @@ -103,7 +103,7 @@ authunix_create_default() .ft R .IP Calls -.B authunix_create() +.BR authunix_create () with the appropriate parameters. .br .if t .ne 13 @@ -139,14 +139,14 @@ This routine returns zero if it succeeds, or the value of .B "enum clnt_stat" cast to an integer if it fails. The routine -.B clnt_perrno() +.BR clnt_perrno () is handy for translating failure statuses into messages. .IP Warning: calling remote procedures with this routine uses .SM UDP/IP as a transport; see -.B clntudp_create() +.BR clntudp_create () for restrictions. You do not have control of timeouts or authentication using this routine. @@ -166,11 +166,11 @@ resultproc_t eachresult; .ft R .IP Like -.BR callrpc() , +.BR callrpc (), except the call message is broadcast to all locally connected broadcast nets. Each time it receives a response, this routine calls -.BR eachresult() , +.BR eachresult (), whose form is: .IP .RS 1i @@ -188,14 +188,14 @@ where is the same as .I out passed to -.BR clnt_broadcast() , +.BR clnt_broadcast (), except that the remote procedure's output is decoded there; .I addr points to the address of the machine that sent the results. If -.B eachresult() +.BR eachresult () returns zero, -.B clnt_broadcast() +.BR clnt_broadcast () waits for more replies; otherwise it returns with appropriate status. .IP @@ -226,7 +226,7 @@ associated with the client handle, which is obtained with an .SM RPC client creation routine such as -.BR clnt_create() . +.BR clnt_create (). The parameter .I in is the address of the procedure's argument(s), and @@ -257,7 +257,7 @@ of private data structures, including itself. Use of .I clnt is undefined after calling -.BR clnt_destroy() . +.BR clnt_destroy (). If the .SM RPC library opened the associated socket, it will close it also. @@ -285,7 +285,7 @@ indicates which kind of transport protocol to use. The currently supported values for this field are \(lqudp\(rq and \(lqtcp\(rq. Default timeouts are set, but can be modified using -.BR clnt_control() . +.BR clnt_control (). .IP Warning: Using .SM UDP @@ -328,9 +328,9 @@ and their argument types and what they do are: .fi .IP Note: if you set the timeout using -.BR clnt_control() , +.BR clnt_control (), the timeout parameter passed to -.B clnt_call() +.BR clnt_call () will be ignored in all future calls. .IP .nf @@ -418,11 +418,11 @@ The message is prepended with string .I s and a colon. Used when a -.BR clnt_create() , -.BR clntraw_create() , -.BR clnttcp_create() , +.BR clnt_create (), +.BR clntraw_create (), +.BR clnttcp_create (), or -.B clntudp_create() +.BR clntudp_create () call fails. .br .if t .ne 8 @@ -440,7 +440,7 @@ Print a message to standard error corresponding to the condition indicated by .IR stat . Used after -.BR callrpc() . +.BR callrpc (). .br .if t .ne 8 .LP @@ -462,7 +462,7 @@ The message is prepended with string .I s and a colon. Used after -.BR clnt_call() . +.BR clnt_call (). .br .if t .ne 9 .LP @@ -476,7 +476,7 @@ char *s; .ft R .IP Like -.BR clnt_pcreateerror() , +.BR clnt_pcreateerror (), except that it returns a string instead of printing to the standard error. .IP @@ -495,7 +495,7 @@ enum clnt_stat stat; .ft R .IP Take the same arguments as -.BR clnt_perrno() , +.BR clnt_perrno (), but instead of sending a message to the standard error indicating why an .SM RPC @@ -503,22 +503,22 @@ call failed, return a pointer to a string which contains the message. The string ends with a .SM NEWLINE\s0. .IP -.B clnt_sperrno() +.BR clnt_sperrno () is used instead of -.B clnt_perrno() +.BR 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 .BR printf , or if a message format different than that supported by -.B clnt_perrno() +.BR clnt_perrno () is to be used. Note: unlike -.B clnt_sperror() +.BR clnt_sperror () and -.BR clnt_spcreaterror() , -.B clnt_sperrno() +.BR clnt_spcreaterror (), +.BR clnt_sperrno () returns pointer to static data, but the result will not get overwritten on each call. .br @@ -535,9 +535,9 @@ char *s; .ft R .IP Like -.BR clnt_perror() , +.BR clnt_perror (), except that (like -.BR clnt_sperrno() ) +.BR clnt_sperrno ()) it returns a string instead of printing to standard error. .IP Bugs: returns pointer to static data that is overwritten @@ -565,7 +565,7 @@ actually a buffer within the process's address space, so the corresponding .SM RPC server should live in the same address space; see -.BR svcraw_create() . +.BR svcraw_create (). This allows simulation of .SM RPC and acquisition of @@ -670,7 +670,7 @@ transport resends the call message in intervals of time until a response is received or until the call times out. The total time for the call to time out is specified by -.BR clnt_call() . +.BR clnt_call (). .IP Warning: since .SM UDP\s0-based @@ -724,7 +724,7 @@ transport resends the call message in intervals of time until a response is received or until the call times out. The total time for the call to time out is specified by -.BR clnt_call() . +.BR clnt_call (). .IP This allows the user to specify the maximum packet size for sending and receiving .SM UDP\s0-based @@ -812,7 +812,7 @@ the system failed to contact the remote .B portmap service. In the latter case, the global variable -.B rpc_createerr() +.BR rpc_createerr () contains the .SM RPC status. @@ -850,13 +850,13 @@ will be modified to the program's port number if the procedure succeeds. The definitions of other parameters are discussed in -.B callrpc() +.BR callrpc () and -.BR clnt_call() . +.BR clnt_call (). This procedure should be used for a \(lqping\(rq and nothing else. See also -.BR clnt_broadcast() . +.BR clnt_broadcast (). .br .if t .ne 9 .LP @@ -886,7 +886,7 @@ or .BR \s-1IPPROTO_TCP\s0 . This routine returns one if it succeeds, zero otherwise. Automatically done by -.BR svc_register() . +.BR svc_register (). .br .if t .ne 7 .LP @@ -946,7 +946,7 @@ Warning: remote procedures registered in this form are accessed using the .SM UDP/IP transport; see -.B svcudp_create() +.BR svcudp_create () for restrictions. .br .if t .ne 5 @@ -962,7 +962,7 @@ A global variable whose value is set by any .SM RPC client creation routine that does not succeed. Use the routine -.B clnt_pcreateerror() +.BR clnt_pcreateerror () to print the reason why. .if t .ne 7 .LP @@ -1003,12 +1003,12 @@ to the .B select system call. This is only of interest if a service implementor does not call -.BR svc_run() , +.BR svc_run (), but rather does his own asynchronous event processing. This variable is read-only (do not pass its address to .BR select !), yet it may change after calls to -.B svc_getreqset() +.BR svc_getreqset () or any creation routines. .br .if t .ne 6 @@ -1042,7 +1042,7 @@ A macro that frees any data allocated by the .SM RPC/XDR system when it decoded the arguments to a service procedure using -.BR svc_getargs() . +.BR svc_getargs (). This routine returns 1 if the results were successfully freed, and zero otherwise. @@ -1105,7 +1105,7 @@ fd_set *rdfds; .IP This routine is only of interest if a service implementor does not call -.BR svc_run() , +.BR svc_run (), but instead implements custom asynchronous event processing. It is called when the .B select @@ -1132,9 +1132,9 @@ int rdfds; .ft R .IP Similar to -.BR svc_getreqset() , +.BR svc_getreqset (), but limited to 32 descriptors. This interface is obsoleted by -.BR svc_getreqset() . +.BR svc_getreqset (). .br .if t .ne 17 .LP @@ -1190,7 +1190,7 @@ struct svc_req *request; .RE .IP The -.B svc_register() +.BR svc_register () routine returns one if it succeeds, and zero otherwise. .br .if t .ne 6 @@ -1206,9 +1206,9 @@ This routine never returns. It waits for .SM RPC requests to arrive, and calls the appropriate service procedure using -.B svc_getreq() +.BR svc_getreq () when one arrives. This procedure is usually waiting for a -.B select() +.BR select () system call to return. .br .if t .ne 9 @@ -1282,7 +1282,7 @@ svcerr_decode(xprt) .IP Called by a service dispatch routine that cannot successfully decode its parameters. See also -.BR svc_getargs() . +.BR svc_getargs (). .br .if t .ne 7 .LP @@ -1406,7 +1406,7 @@ so the corresponding client should live in the same address space; see -.BR clntraw_create() . +.BR clntraw_create (). This routine allows simulation of .SM RPC and acquisition of @@ -1701,7 +1701,7 @@ they should register themselves with the .SM RPC service package. This routine modifies the global variable -.BR svc_fds() . +.BR svc_fds (). Service implementors usually do not need this routine. .br .if t .ne 8 @@ -1722,7 +1722,7 @@ it should unregister itself with the .SM RPC service package. This routine modifies the global variable -.BR svc_fds() . +.BR svc_fds (). Service implementors usually do not need this routine. .SH "SEE ALSO" .\" We don't have an rpc_secure.3 page in the set at the moment -- MTK, 19 Sep 05 |