QUERY_DIRECTORY_STATS


The Communications Server icon lets you know that there is a change in the way things operate.
 This verb applies only to Communications Server.

QUERY_DIRECTORY_STATS returns directory database statistics. (The statistics that refer to cache information are reserved in the case of an end node). The verb can be used to gauge the level of network locate traffic. In the case of a network node this information can be used to tune the size of the directory cache, which is configurable at node-initialization time.

VCB Structure

typedef struct query_directory_stats
{
        unsigned short  opcode;            /* verb operation code           */
        unsigned char   reserv2;           /* reserved                      */
        unsigned char   format;            /* format                        */
        unsigned short  primary_rc;        /* primary return code           */
        unsigned long   secondary_rc;      /* secondary return code         */
        unsigned long   max_caches;        /* max number of cache entries   */
        unsigned long   cur_caches;        /* cache entry count             */
        unsigned long   cur_home_entries;  /* home entry count              */
        unsigned long   cur_reg_entries;   /* registered entry count        */
        unsigned long   cur_directory_entries;
                                           /* current number of dir entries */
        unsigned long   cache_hits;        /* count of cache finds          */
        unsigned long   cache_misses;      /* count of resources found by   */
                                           /* broadcast search (not cache)  */
        unsigned long   in_locates;        /* locates in                    */
        unsigned long   in_bcast_locates;  /* broadcast locates in          */
        unsigned long   out_locates;       /* locates out                   */
        unsigned long   out_bcast_locates; /* broadcast locates out         */
        unsigned long   not_found_locates; /* unsuccessful locates          */
        unsigned long   not_found_bcast_locates;
                                           /* unsuccessful broadcast        */
                                           /* locates                       */
        unsigned long   locates_outstanding;
                                           /* total outstanding locates     */
        unsigned char   reserva[20];       /* reserved                      */
} QUERY_DIRECTORY_STATS;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_QUERY_DIRECTORY_STATS
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.

Returned Parameters

If the verb executes successfully, the Program returns the following parameters:
primary_rc
AP_OK
max_caches
Reserved.
cur_caches
Reserved.
cur_home_entries
Current number of home entries.
cur_reg_entries
Current number of registered entries.
cur_directory_entries
Total number of entries currently in the directory.
cache_hits
Reserved.
cache_misses
Reserved.
in_locates
Number of directed locates received.
in_bcast_locates
Number of broadcast locates received.
out_locates
Number of directed locates sent.
out_bcast_locates
Number of broadcast locates sent.
not_found_locates
Number of directed locates returned with a “not found.”
not_found_bcast_locates
Number of broadcast locates returned with a “not found.”
locates_outstanding
Current number of outstanding locates, both directed and broadcast.
If the verb does not execute because the node has not yet been started, the Program returns the following parameter:
primary_rc
AP_NODE_NOT_STARTED
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR