MQ_GETATTR(2)

πŸ“¦ version 15.1, in freebsd 14.5, freebsd 15.1

πŸ’– mq_getattr β€” get message queue attributes (REALTIME) πŸ’–

okay so bestie, we're in section 2 of the System Calls Manual today and this one is literally the "tell me everything about my message queue" call πŸŽ€ it's giving peek-behind-the-curtain, and honestly? iconic.


🌸 LIBRARY 🌸

POSIX Real-time Library (librt, -lrt) β€” yeah you gotta link the real-time lib, no cap πŸ’…


✨ SYNOPSIS ✨

#include <mqueue.h>

int
mq_getattr(mqd_t mqdes, struct mq_attr *mqstat);

πŸ¦‹ DESCRIPTION πŸ¦‹

so the mq_getattr() system call obtains status information and attributes of the message queue and the open message queue description associated with the message queue descriptor. two things at once, she's multitasking, we love her 🫢

the mqdes argument specifies a message queue descriptor.

the results are returned in the mq_attr structure referenced by the mqstat argument.

upon return, the following members will have the values associated with the open message queue description β€” as set when the message queue was opened, and as modified by subsequent mq_setattr() calls: mq_flags.

the following attributes of the message queue will be returned as set at message queue creation: mq_maxmsg, mq_msgsize.

and upon return, the following members within the mq_attr structure referenced by the mqstat argument will be set to the current state of the message queue:

  • mq_curmsgs β€” the number of messages currently on the queue. that's the live count bestie, it's giving real-time πŸ‘‘

πŸ’œ RETURN VALUES πŸ’œ

upon successful completion, the value 0 is returned; otherwise the value -1 is returned and the global variable errno is set to indicate the error. zero means slay, negative one means go check errno 😭


πŸ”₯ ERRORS πŸ”₯

the mq_getattr() system call will fail if:

  • [EBADF] β€” the mqdes argument is not a valid message queue descriptor.
fr fr, that's the whole list. one error. she's low maintenance πŸ’€

🌈 SEE ALSO 🌈

mq_open(2), mq_send(2), mq_setattr(2), mq_timedsend(2)

like, go read the whole friend group, they all hang out together ✨


⭐ STANDARDS ⭐

the mq_getattr() system call conforms to IEEE Std 1003.1-2004 (β€œPOSIX.1”). certified standards girlie πŸ’…


πŸŽ€ HISTORY πŸŽ€

support for POSIX message queues first appeared in FreeBSD 7.0. so she's been serving looks since way back 🫢


portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.

ngl that's a lot of legalese but we keep it because it's the law, periodt 🧚

and that's the page bestie!! this one's from Debian, dated February 21, 2014 β€” mwah, go read your queue attributes responsibly πŸ’–πŸŒΈπŸ’…

πŸ“¦ where this page comes from