Linux程序员手册 第3部分
更新日期： 2020-06-09

名称

mq_getattr，mq_setattr-获取/设置消息队列属性

语法

#include <mqueue.h>

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

int mq_setattr(mqd_t mqdes, const struct mq_attr *newattr,
                 struct mq_attr *oldattr);

与-lrt链接。

说明

mq_getattr()和mq_setattr()分别检索和修改消息队列描述符mqdes引用的消息队列的属性。

mq_getattr()在attr指向的缓冲区中返回mq_attr结构。此结构定义为：

struct mq_attr {
    long mq_flags;       /* Flags: 0 or O_NONBLOCK */
    long mq_maxmsg;      /* Max. # of messages on queue */
    long mq_msgsize;     /* Max. message size (bytes) */
    long mq_curmsgs;     /* # of messages currently in queue */
};

mq_flags字段包含与打开的消息队列描述关联的标志。由mq_open(3)创建队列时，将初始化此字段。可以在此字段中显示的唯一标志是O_NONBLOCK。

由mq_open(3)创建消息队列时，将设置mq_maxmsg和mq_msgsize字段。 mq_maxmsg字段是使用mq_send(3)可以放入队列的消息数的上限。 mq_msgsize字段是可放入队列中的邮件大小的上限。这两个字段的值都必须大于零。 mq_overview(7)中描述了两个将这些字段的值作为上限的/ proc文件。

mq_curmsgs字段返回队列中当前保留的消息数。

mq_setattr()使用newattr指向的mq_attr结构中提供的信息来设置消息队列属性。唯一可以修改的属性是mq_flags中O_NONBLOCK标志的设置。 newattr中的其他字段将被忽略。如果oldattr字段不为NULL，则它指向的缓冲区将用于返回mq_attr结构，该结构包含与mq_getattr()返回的信息相同的信息。

返回值

成功时，mq_getattr()和mq_setattr()返回0；否则，返回0。如果出错，则返回-1，并设置errno表示错误。

错误说明

EBADF

在mqdes中指定的消息队列描述符无效。

EINVAL

newattr->mq_flags包含O_NONBLOCK以外的其他设置位。

属性

有关本节中使用的术语的说明，请参见attribute(7)。

遵循规范

POSIX.1-2001，POSIX.1-2008。

备注

在Linux上，mq_getattr()和mq_setattr()是库函数，位于mq_getsetattr(2)系统调用之上。

示例

下面的程序可用于显示分配给通过调用mq_open(3)创建的消息队列的默认mq_maxmsg和mq_msgsize值，其中attr参数为NULL。这是该程序的示例运行：

$ ./a.out /testq
Maximum # of messages on queue:   10
Maximum message size:             8192

从Linux 3.5开始，以下/ proc文件(在mq_overview(7)中进行了描述)可用于控制默认值：

$ uname -sr
Linux 3.8.0
$ cat /proc/sys/fs/mqueue/msg_default
10
$ cat /proc/sys/fs/mqueue/msgsize_default
8192

Program source

#include <mqueue.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

#define errExit(msg)    do { perror(msg); exit(EXIT_FAILURE); \
                        } while (0)

int
main(int argc, char *argv[])
{
    mqd_t mqd;
    struct mq_attr attr;

    if (argc != 2) {
        fprintf(stderr, "Usage: %s mq-name\n", argv[0]);
        exit(EXIT_FAILURE);
    }

    mqd = mq_open(argv[1], O_CREAT | O_EXCL, S_IRUSR | S_IWUSR, NULL);
    if (mqd == (mqd_t) -1)
        errExit("mq_open");

    if (mq_getattr(mqd, &attr) == -1)
        errExit("mq_getattr");

    printf("Maximum # of messages on queue:   %ld\n", attr.mq_maxmsg);
    printf("Maximum message size:             %ld\n", attr.mq_msgsize);

    if (mq_unlink(argv[1]) == -1)
        errExit("mq_unlink");

    exit(EXIT_SUCCESS);
}

另外参见

mq_close(3)，mq_notify(3)，mq_open(3)，mq_receive(3)，mq_send(3)，mq_unlink(3)，mq_overview(7)

出版信息

这个页面是Linux手册页项目5.08版的一部分。有关项目的说明、有关报告错误的信息以及此页面的最新版本，请访问https://www.kernel.org/doc/man-pages/。