bstr_object_get_statistics(3) — Subroutines

Name

bstr_object_get_statistics − Gets the value of the statistic counters for an object (VODB only).

Syntax

bstr_t_status   bstr_object_get_statistics (
                                  bstr_t_reference        ∗object,
                                  bstr_t_rcb              ∗control,
                                  bstr_t_statistic_header ∗stats_header,
                                  void                    ∗∗msgs_stats,
                                  bstr_t_natural          ∗msgs_stats_size,
                                  void                    ∗∗specific_stats,
                                  bstr_t_natural          ∗specific_stats_size);

Description

Returns object statistics. The common statistics are returned by stats_header, the statistics for the messages class are returned by msgs_stats, whereas class-specific statistics are returned by specific_stats.

Arguments

object
access: read
The reference to the object whose statistics must be received.

control
access: write
The address of the optional request control block.

stats_header
access: read
The address of a bstr_t_statistic_header data structure which returns the common statistics associated with object.

msgs_statistics
access: read
The address of a pointer to a buffer returned by BASEstar Open. The returned buffer contains an array of bstr_t_message_stat data structures, one for each public message defined for the class to which object belongs.

See the bstrstat.h include file to find out how many elements are returned in the array, and the BASEstar Open messages they refer to.

You must free the returned buffer after use.

msgs_stats_size
access: read
The number of bytes BASEstar Open allocates for the msgs_stats buffer.

specific_stats
access: read
The address of a pointer to a buffer where BASEstar Open returns class-specific statistics. The type of data structure returned in the buffer depends on the class to which the object belongs as shown in the table below.

Class Name	Statistics Data Structure Type
Enbox	bstr_t_enbox_specific_stat
Event	bstr_t_event_specific_stat
Named_Variable	bstr_t_named_variable_specific_stat
Packet	bstr_t_packet_specific_stat
Polling_set	bstr_t_polling_set_specific_stat
Port	bstr_t_port_specific_stat
Unnamed_Variable	bstr_t_unnamed_variable_specific_stat
VMD	bstr_t_VMD_specific_stat

See the bstrstat.h include file for a description of the statistic data structures.

You must free the returned buffer after use.

specific_stats_size
access: read
The number of bytes BASEstar Open allocates for the specific_stats buffer.

Return Values

BSTR_S_ABORTED	Operation aborted
BSTR_S_BAD_PARAMETER	Bad parameter value
BSTR_S_BAD_REFERENCE	Bad reference
BSTR_S_COMMUNICATION_ERROR	Communication error
BSTR_S_COM_PC_SIZE_MISMATCH	Number of bytes requested does not match the number of bytes returned
BSTR_S_FINISH	Request aborted by bstr_finish
BSTR_S_INTERNAL_ERROR	Internal error
BSTR_S_INTR	Operation interrupted
BSTR_S_INVALID_OPERATION	Invalid operation
BSTR_S_INVALID_RCB	Invalid Request Control Block
BSTR_S_NORMAL	Normal successful completion
BSTR_S_NOT_INITIALIZED	BASEstar Open not initialized
BSTR_S_NO_MEMORY	Insufficient virtual memory
BSTR_S_SERVICES_NOT_AVAILABLE	Services not available
BSTR_S_TIMEOUT	Timeout expired
BSTR_S_TOO_MANY_REQUESTS	Too many pending requests

Museum