| rpc_clnt_calls.3 (108037) | rpc_clnt_calls.3 (108087) |
|---|---|
| 1.\" @(#)rpc_clnt_calls.3n 1.30 93/08/31 SMI; from SVr4 2.\" Copyright 1989 AT&T 3.\" @(#)rpc_clnt_calls 1.4 89/07/20 SMI; 4.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. | 1.\" @(#)rpc_clnt_calls.3n 1.30 93/08/31 SMI; from SVr4 2.\" Copyright 1989 AT&T 3.\" @(#)rpc_clnt_calls 1.4 89/07/20 SMI; 4.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. |
| 5.\" $FreeBSD: head/lib/libc/rpc/rpc_clnt_calls.3 108037 2002-12-18 12:45:11Z ru $ | 5.\" $FreeBSD: head/lib/libc/rpc/rpc_clnt_calls.3 108087 2002-12-19 09:40:28Z ru $ |
| 6.Dd May 7, 1993 7.Dt RPC_CLNT_CALLS 3 8.Os 9.Sh NAME 10.Nm rpc_clnt_calls , 11.Nm clnt_call , 12.Nm clnt_freeres , 13.Nm clnt_geterr , --- 58 unchanged lines hidden (view full) --- 72.Fn rpc_call , 73and 74.Fn rpc_broadcast 75routines handle the client side of the procedure call. 76The remaining routines deal with error handling in the case of errors. 77.Pp 78Some of the routines take a 79.Vt CLIENT | 6.Dd May 7, 1993 7.Dt RPC_CLNT_CALLS 3 8.Os 9.Sh NAME 10.Nm rpc_clnt_calls , 11.Nm clnt_call , 12.Nm clnt_freeres , 13.Nm clnt_geterr , --- 58 unchanged lines hidden (view full) --- 72.Fn rpc_call , 73and 74.Fn rpc_broadcast 75routines handle the client side of the procedure call. 76The remaining routines deal with error handling in the case of errors. 77.Pp 78Some of the routines take a 79.Vt CLIENT |
| 80handle as one of the parameters. | 80handle as one of the arguments. |
| 81A 82.Vt CLIENT 83handle can be created by an RPC creation routine such as 84.Fn clnt_create 85(see 86.Xr rpc_clnt_create 3 ) . 87.Pp 88These routines are safe for use in multithreaded applications. --- 13 unchanged lines hidden (view full) --- 102.Fa procnum 103associated with the client handle, 104.Fa clnt , 105which is obtained with an RPC 106client creation routine such as 107.Fn clnt_create 108(see 109.Xr rpc_clnt_create 3 ) . | 81A 82.Vt CLIENT 83handle can be created by an RPC creation routine such as 84.Fn clnt_create 85(see 86.Xr rpc_clnt_create 3 ) . 87.Pp 88These routines are safe for use in multithreaded applications. --- 13 unchanged lines hidden (view full) --- 102.Fa procnum 103associated with the client handle, 104.Fa clnt , 105which is obtained with an RPC 106client creation routine such as 107.Fn clnt_create 108(see 109.Xr rpc_clnt_create 3 ) . |
| 110The parameter | 110The |
| 111.Fa inproc | 111.Fa inproc |
| 112is the XDR function used to encode the procedure's parameters, and | 112argument 113is the XDR function used to encode the procedure's arguments, and |
| 113.Fa outproc 114is the XDR function used to decode the procedure's results; 115.Fa in 116is the address of the procedure's argument(s), and 117.Fa out 118is the address of where to place the result(s). | 114.Fa outproc 115is the XDR function used to decode the procedure's results; 116.Fa in 117is the address of the procedure's argument(s), and 118.Fa out 119is the address of where to place the result(s). |
| 120The |
|
| 119.Fa tout | 121.Fa tout |
| 122argument |
|
| 120is the time allowed for results to be returned, which is overridden by 121a time-out set explicitly through 122.Fn clnt_control , 123see 124.Xr rpc_clnt_create 3 . 125If the remote call succeeds, the status returned is 126.Dv RPC_SUCCESS , 127otherwise an appropriate status is returned. 128.It Fn clnt_freeres 129A function macro that frees any data allocated by the 130RPC/XDR system when it decoded the results of an RPC call. | 123is the time allowed for results to be returned, which is overridden by 124a time-out set explicitly through 125.Fn clnt_control , 126see 127.Xr rpc_clnt_create 3 . 128If the remote call succeeds, the status returned is 129.Dv RPC_SUCCESS , 130otherwise an appropriate status is returned. 131.It Fn clnt_freeres 132A function macro that frees any data allocated by the 133RPC/XDR system when it decoded the results of an RPC call. |
| 131The parameter | 134The |
| 132.Fa out | 135.Fa out |
| 136argument |
|
| 133is the address of the results, and 134.Fa outproc 135is the XDR routine describing the results. 136This routine returns 1 if the results were successfully freed, 137and 0 otherwise. 138.It Fn clnt_geterr 139A function macro that copies the error structure out of the client 140handle to the structure at address --- 111 unchanged lines hidden (view full) --- 252.It Fn rpc_broadcast_exp 253Like 254.Fn rpc_broadcast , 255except that the initial timeout, 256.Fa inittime 257and the maximum timeout, 258.Fa waittime 259are specified in milliseconds. | 137is the address of the results, and 138.Fa outproc 139is the XDR routine describing the results. 140This routine returns 1 if the results were successfully freed, 141and 0 otherwise. 142.It Fn clnt_geterr 143A function macro that copies the error structure out of the client 144handle to the structure at address --- 111 unchanged lines hidden (view full) --- 256.It Fn rpc_broadcast_exp 257Like 258.Fn rpc_broadcast , 259except that the initial timeout, 260.Fa inittime 261and the maximum timeout, 262.Fa waittime 263are specified in milliseconds. |
| 264The |
|
| 260.Fa inittime | 265.Fa inittime |
| 266argument |
|
| 261is the initial time that 262.Fn rpc_broadcast_exp 263waits before resending the request. 264After the first resend, the re-transmission interval 265increases exponentially until it exceeds 266.Fa waittime . 267.It Fn rpc_call 268Call the remote procedure associated with 269.Fa prognum , 270.Fa versnum , 271and 272.Fa procnum 273on the machine, 274.Fa host . | 267is the initial time that 268.Fn rpc_broadcast_exp 269waits before resending the request. 270After the first resend, the re-transmission interval 271increases exponentially until it exceeds 272.Fa waittime . 273.It Fn rpc_call 274Call the remote procedure associated with 275.Fa prognum , 276.Fa versnum , 277and 278.Fa procnum 279on the machine, 280.Fa host . |
| 275The parameter | 281The |
| 276.Fa inproc | 282.Fa inproc |
| 277is used to encode the procedure's parameters, and | 283argument 284is used to encode the procedure's arguments, and |
| 278.Fa outproc 279is used to decode the procedure's results; 280.Fa in 281is the address of the procedure's argument(s), and 282.Fa out 283is the address of where to place the result(s). | 285.Fa outproc 286is used to decode the procedure's results; 287.Fa in 288is the address of the procedure's argument(s), and 289.Fa out 290is the address of where to place the result(s). |
| 291The |
|
| 284.Fa nettype | 292.Fa nettype |
| 293argument |
|
| 285can be any of the values listed on 286.Xr rpc 3 . 287This routine returns 288.Dv RPC_SUCCESS 289if it succeeds, 290or an appropriate status is returned. 291Use the 292.Fn clnt_perrno --- 15 unchanged lines hidden --- | 294can be any of the values listed on 295.Xr rpc 3 . 296This routine returns 297.Dv RPC_SUCCESS 298if it succeeds, 299or an appropriate status is returned. 300Use the 301.Fn clnt_perrno --- 15 unchanged lines hidden --- |