rpc_mgmt_inq_stats(3rpc)

Used by client, server, or management applications.

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 binding handle. To receive statistics about a remote application, specify a server binding handle for that application. To receive statistics about your own (local) application, specify NULL.

If the binding handle you supply refers to partially bound binding information and the binding information contains a nil object UUID, this routine returns the rpc_s_binding_incomplete status code. In this case, the DCE host daemon does not know which server instance to select from the local endpoint map because the RPC management interface is automatically registered (by the RPC runtime) for all RPC servers.

To avoid this situation, you can obtain a fully bound server binding handle by calling the rpc_ep_resolve_binding( ) routine.

Output

statistics
Returns the statistics vector for the server specified by the binding parameter. Each statistic is a value of the type unsigned32.

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

In addition to the above values, status can return the value of parameter status from the application-defined authorization function rpc_mgmt_authorization_fn_t( ). The prototype for such a function is defined in the authorization_fn parameter in the reference page for rpc_ mgmt_set_authorization_fn(3rpc).

Description
The rpc_mgmt_inq_stats( ) routine returns statistics from the RPC runtime about a specified server.

The explanation of a statistics vector in rpc_intro(3rpc) lists the elements of the vector.

The RPC runtime 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 runtime allows all clients to remotely call this routine. To restrict remote calls of this routine, a server application supplies an authorization function using the rpc_mgmt_set_authorization_fn( ) routine.

Return Values
No value is returned.

Errors

The following describes a partial list of errors that might be returned. Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages.

rpc_s_ok
Success.

rpc_s_binding_incomplete
Binding incomplete (no object ID and no endpoint).

rpc_s_comm_failure
Communications failure.

rpc_s_invalid_binding
Invalid binding handle.

rpc_s_mgmt_op_disallowed
Management operation disallowed.

rpc_s_wrong_kind_of_binding
Wrong kind of binding for operation.

Related Information
Functions: rpc_ep_resolve_binding(3rpc)

rpc_mgmt_set_authorization_fn(3rpc)

rpc_mgmt_stats_vector_free(3rpc)