NAME

rpc_mgmt_inq_stats-returns RPC run-time statistics

SYNOPSIS

#include <dce/rpc.h>

void rpc_mgmt_inq_stats(
	rpc_binding_handle_t binding,
	rpc_stats_vector_t **statistics,
	unsigned32 *status);

PARAMETERS

Input

binding

Specifies a server binding handle. To receive statistics about a remote application, the calling application specifies a server binding handle for that application. To receive statistics itself, the application specifies NULL. To avoid this situation, applications can obtain a fully bound server binding handle by calling routine rpc_ep_resolve_binding().

Output

statistics

Returns the statistics vector for the server specified by the binding argument.

status

Returns the status code from this routine. The status code indicates whether the routine completed successfully, or if not, why not.

Possible status codes and their meanings include:

rpc_s_ok

Success.

rpc_s_binding_incomplete

Binding incomplete (no object ID and no endpoint).

rpc_s_comm_failure

Communications failure.

rpc_s_mgmt_op_disallowed

Not authorised for operation.

In addition to the above values, status can return the value of status from an application-defined authorisation function. The prototype for such a function is defined in the authorization_fn argument description in tagmref_rpc_mgmt_set_authorization_fn .

DESCRIPTION

The rpc_mgmt_inq_stats() routine returns statistics from the RPC run-time system about a specified server. The statistics returned refer to all calls on the server by all clients.

The elements of a statistics vector are described in RPC Data Types .

The binding handle supplied in the binding argument must refer to binding information that is fully bound or contains a non-nil object UUID. If the binding handle supplied refers to partially bound binding information that contains a nil object UUID, the routine returns the rpc_s_binding_incomplete status code.

The RPC run-time system allocates memory for the statistics vector. The application calls the rpc_mgmt_stats_vector_free() routine to release the memory that the statistics vector used.

By default, the RPC run-time system allows all clients to remotely call this routine. To restrict remote calls of this routine, a server application supplies an authorisation function using the rpc_mgmt_set_authorization_fn() routine.

RETURN VALUE

None.

SEE ALSO

rpc_ep_resolve_binding()
rpc_mgmt_set_authorization_fn()
rpc_mgmt_stats_vector_free().

Please note that the html version of this specification may contain formatting aberrations. The definitive version is available as an electronic publication on CD-ROM from The Open Group.