msgQueueStat(2K)

NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO

NAME

msgQueueStat- get the statistics of a message queue

SYNOPSIS

#include <mipc/chMipc.h>

int msgQueueStat(int spaceLid, unsigned int msgQueueId);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

FEATURES

MIPC

DESCRPTION

The msgQueueStat() function gets the statistics from the message queue of the index msgQueueId in the message space spaceLid.

The queueStat pointer points to the KnMsgQueueStat structure that contains the number of messages currently waiting in the queue:

struct { unsigned int msgNumber; } KnmsgQueueStat

RETURN VALUE

Upon successful completion, msgQueueStat() returns 0. Otherwise, a negative error code is returned.

ERRORS

[K_EINVAL]

spaceLid is not valid.

[K_EARGS]

msgQueueId is not a valid message queue.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

msgSpaceCreate(2K), msgSpaceOpen(2K), msgAllocate(2K), msgFree(2K), msgGet(2K), msgPut(2K)msgRemove(2K)

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO