rpc(3) — Subroutines
NAME
rpc, rpc_functions − Library routines for ONC remote procedure calls
DESCRIPTION
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.
The RPC subroutines and macros are grouped in the following categories:
•Client RPC routines (described in rpc_clnt(3))
callrpcCalls a remote procedure on a remote system.
clnt_broadcast
Broadcasts a call message to all locally connected broadcast nets.
clnt_callCalls the remote procedure that is associated with a specified client handle.
clnt_createCreates a generic RPC client.
clnt_control
Change or retrieves various information about a client object.
clnt_destroy
Destroys the client’s RPC handle.
clnt_freeres
Frees any data allocated by the RPC/XDR system.
clnt_geterrCopies the error structure out of the client handle.
clnt_pcreateerror
Prints a message to standard error indicating why a client RPC handle could not be created.
clnt_perrno
Prints a message to standard error corresponding to a condition.
clnt_perror
Prints a message to standard error indicating why an RPC call failed.
clnt_spcreateerror
Returns a string indicating why a client RPC handle could not be created.
clnt_sperrno
Returns a pointer to a string that indicates why an RPC call failed.
clnt_sperror
Returns a string that indicates why an RPC call failed.
clntraw_create
Creates a toy RPC client for a remote program.
clnttcp_create
Creates an RPC client that uses the TCP/IP transport.
clntudp_create
Creates an RPC client that uses the UDP/IP transport.
•Server RPC routines (described in rpc_svc(3))
svc_destroy
Destroys the RPC service transport handle.
svc_fdsetSpecifies the RPC service side’s read file descriptor bit mask.
svc_freeargs
Frees any data allocated by the RPC/XDR system.
svc_getargs
Decodes the arguments of an RPC request.
svc_getcaller
Gets the network address of the caller.
svc_getreqServices an RPC request.
svc_getreqset
Services an RPC request.
svc_register
Maps a program with a service dispatch procedure.
svc_runWaits and services RPC requests.
svc_sendreply
Send the results of a remote procedure call.
svc_unregister
Removes the mapping of program to service dispatch procedures.
svcerr_auth
Processes incorrect authentication errors.
svcerr_decode
Processes parameter decoding errors.
svcerr_noproc
Processes procedure number errors.
svcerr_noprog
Processes program registration errors.
svcerr_progvers
Processes program registration errors.
svcerr_systemerr
Processes system errors.
svcerr_weakauth
Processes insufficient authentication errors.
svcfd_create
Creates an RPC service on top of any open descriptor.
svcraw_create
Creates a toy RPC service transport.
svctcp_create
Creates a TCP/IP-based RPC service transport.
svcudp_create
Creates a UDP/IP-based RPC service transport.
•RPC XDR routines (described in rpc_xdr(3))
xdr_accepted_reply
Encodes RPC reply messages.
xdr_authunix_parms
Describes UNIX credentials.
xdr_callhdr
Describes RPC call header messages.
xdr_callmsg
Describes RPC call messages.
xdr_opaque_auth
Describes RPC authentication information messages.
xdr_rejected_reply
Describes RPC reply messages.
xdr_replymsg
Describes RPC reply messages.
•Miscellaneous RPC routines (described in rpc_misc(3))
auth_destroy
Destroys authentication information.
authnone_create
Creates and returns an RPC authentication handle.
authunix_create
Creates and returns an ONC RPC authentication handle that contains authentication information.
authunix_create_default
Creates and returns an ONC RPC authentication handle that contains default authentication information.
get_myaddress
Retrieves the machine’s IP address.
getnetnameRetrieves the network name of the caller.
host2netname
Converts from a domain-specific host name to an operating-system independent network name.
netname2host
Converts from an operating-system independent network name to a domain-specific host name.
netname2user
Converts from an operating-system independent network name to a domain-specific user ID.
pmap_getmaps
Returns a list of the current RPC program-to-port mappings on the host located at a specified IP address.
pmap_getport
Returns the port number on which waits a service that supports a specified program number and transport protocol.
pmap_rmtcall
Instructs portmap on a remote host to make an RPC call.
pmap_setMaps a program to a port.
pmap_unset
Destroys the mapping of a program to a port.
registerrpcRegisters a procedure with the RPC service package.
rpc_createrr
Specifies an error value that is set by an RPC client creation routine.
usr2netname
Converts from a domain-specific user name to an operating-system independent network name.
xprt_register
Register transport handle with service.
xprt_unregister
Unregister transport handle with service.
RELATED INFORMATION
rpc_clnt(3), rpc_misc(3), rpc_svc(3), rpc_xdr(3), xdr(3)
Remote Procedure Calls: Protocol Specification − RFC 1050