POSIX Message Queues API

name: POSIX Message Queues API
description: POSIX message queue interfaces for exchanging messages between processes with priority support.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: https://man7.org/linux/man-pages/man7/mq_overview.7.html
baseURL: system://unix/mqueue
tags:
- Asynchronous
- Ipc
- Message-Queues
- Messaging
properties:
- type: Documentation
  url: https://man7.org/linux/man-pages/man7/mq_overview.7.html
- type: Documentation
  url: https://pubs.opengroup.org/onlinepubs/9699919799/functions/mq_open.html
operations:
- name: mq_open
  description: Open or create a POSIX message queue
  parameters:
  - name
  - oflag
  - mode
  - attr
  returns: message queue descriptor, (mqd_t)-1 on error
- name: mq_close
  description: Close a message queue descriptor
  parameters:
  - mqdes
  returns: 0 on success, -1 on error
- name: mq_unlink
  description: Remove a message queue
  parameters:
  - name
  returns: 0 on success, -1 on error
- name: mq_send
  description: Send a message to a message queue
  parameters:
  - mqdes
  - msg_ptr
  - msg_len
  - msg_prio
  returns: 0 on success, -1 on error
- name: mq_receive
  description: Receive a message from a message queue
  parameters:
  - mqdes
  - msg_ptr
  - msg_len
  - msg_prio
  returns: number of bytes received, -1 on error
- name: mq_timedsend
  description: Send a message to a message queue with a timeout
  parameters:
  - mqdes
  - msg_ptr
  - msg_len
  - msg_prio
  - abs_timeout
  returns: 0 on success, -1 on error
- name: mq_timedreceive
  description: Receive a message from a message queue with a timeout
  parameters:
  - mqdes
  - msg_ptr
  - msg_len
  - msg_prio
  - abs_timeout
  returns: number of bytes received, -1 on error
- name: mq_notify
  description: Register for notification when a message is available
  parameters:
  - mqdes
  - sevp
  returns: 0 on success, -1 on error
- name: mq_getattr
  description: Get message queue attributes
  parameters:
  - mqdes
  - attr
  returns: 0 on success, -1 on error
- name: mq_setattr
  description: Set message queue attributes
  parameters:
  - mqdes
  - newattr
  - oldattr
  returns: 0 on success, -1 on error