VxWorks Reference Manual : Libraries

msgQDistGrpShow

NAME

msgQDistGrpShow - distributed message queue group show routines (VxFusion)

ROUTINES

msgQDistGrpShow( ) - display all or one group with its members

DESCRIPTION

This library provides a routine to show either the contents of the entire message queue group database or the contents of single message queue group.

INCLUDE FILES

msgQDistGrpShow.h

SEE ALSO

msgQDistGrpShow, msgQDistGrpLib


Libraries : Routines

msgQDistGrpShow( )

NAME

msgQDistGrpShow( ) - display all or one group with its members

SYNOPSIS

STATUS msgQDistGrpShow
    (
    char * distGrpName /* name of the group to display or NULL for all */
    )

DESCRIPTION

This routine displays either all distributed message queue groups or a specified group in the group database. For each group displayed on the node, this routine lists only members added (using msgQDistGrpAdd( )) from the node executing the msgQDistGrpShow( ) call.

If distGrpName is NULL, all groups and their locally added members are displayed. Otherwise, only the group specified by distGrpName and its locally added members are displayed.

NOTE

The concept of "locally added" is an important one. All nodes in the system can add groups to a message queue group. However, only those message queues (including remote distributed message queues) that were added to the group from the local node are displayed by this routine.

EXAMPLE

-> msgQDistGrpShow(0)
NAME OF GROUP         GROUP ID   STATE  MEMBER ID TYPE OF MEMBER
------------------- ---------- ------- ---------- ---------------------------
grp1                  0x3ff9e3  global   0x3ff98b distributed msg queue
                                         0x3ff9fb distributed msg queue
grp2                  0x3ff933  global   0x3ff89b distributed msg queue
                                         0x3ff8db distributed msg queue
                                         0x3ff94b distributed msg queue
value = 0 = 0x0

RETURNS

OK, always

ERRNO

S_msgQDistGrpLib_NO_MATCH
The group name was not found in the database.

SEE ALSO

msgQDistGrpShow