mqueue.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. /* Copyright (C) 2004-2017 Free Software Foundation, Inc.
  2. This file is part of the GNU C Library.
  3. The GNU C Library is free software; you can redistribute it and/or
  4. modify it under the terms of the GNU Lesser General Public
  5. License as published by the Free Software Foundation; either
  6. version 2.1 of the License, or (at your option) any later version.
  7. The GNU C Library is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10. Lesser General Public License for more details.
  11. You should have received a copy of the GNU Lesser General Public
  12. License along with the GNU C Library; if not, see
  13. <http://www.gnu.org/licenses/>. */
  14. #ifndef _MQUEUE_H
  15. #define _MQUEUE_H 1
  16. #include <features.h>
  17. #include <sys/types.h>
  18. #include <fcntl.h>
  19. #define __need_sigevent_t
  20. #include <bits/siginfo.h>
  21. #include <bits/types/struct_timespec.h>
  22. /* Get the definition of mqd_t and struct mq_attr. */
  23. #include <bits/mqueue.h>
  24. __BEGIN_DECLS
  25. /* Establish connection between a process and a message queue NAME and
  26. return message queue descriptor or (mqd_t) -1 on error. OFLAG determines
  27. the type of access used. If O_CREAT is on OFLAG, the third argument is
  28. taken as a `mode_t', the mode of the created message queue, and the fourth
  29. argument is taken as `struct mq_attr *', pointer to message queue
  30. attributes. If the fourth argument is NULL, default attributes are
  31. used. */
  32. extern mqd_t mq_open (const char *__name, int __oflag, ...)
  33. __THROW __nonnull ((1));
  34. /* Removes the association between message queue descriptor MQDES and its
  35. message queue. */
  36. extern int mq_close (mqd_t __mqdes) __THROW;
  37. /* Query status and attributes of message queue MQDES. */
  38. extern int mq_getattr (mqd_t __mqdes, struct mq_attr *__mqstat)
  39. __THROW __nonnull ((2));
  40. /* Set attributes associated with message queue MQDES and if OMQSTAT is
  41. not NULL also query its old attributes. */
  42. extern int mq_setattr (mqd_t __mqdes,
  43. const struct mq_attr *__restrict __mqstat,
  44. struct mq_attr *__restrict __omqstat)
  45. __THROW __nonnull ((2));
  46. /* Remove message queue named NAME. */
  47. extern int mq_unlink (const char *__name) __THROW __nonnull ((1));
  48. /* Register notification issued upon message arrival to an empty
  49. message queue MQDES. */
  50. extern int mq_notify (mqd_t __mqdes, const struct sigevent *__notification)
  51. __THROW;
  52. /* Receive the oldest from highest priority messages in message queue
  53. MQDES. */
  54. extern ssize_t mq_receive (mqd_t __mqdes, char *__msg_ptr, size_t __msg_len,
  55. unsigned int *__msg_prio) __nonnull ((2));
  56. /* Add message pointed by MSG_PTR to message queue MQDES. */
  57. extern int mq_send (mqd_t __mqdes, const char *__msg_ptr, size_t __msg_len,
  58. unsigned int __msg_prio) __nonnull ((2));
  59. #ifdef __USE_XOPEN2K
  60. /* Receive the oldest from highest priority messages in message queue
  61. MQDES, stop waiting if ABS_TIMEOUT expires. */
  62. extern ssize_t mq_timedreceive (mqd_t __mqdes, char *__restrict __msg_ptr,
  63. size_t __msg_len,
  64. unsigned int *__restrict __msg_prio,
  65. const struct timespec *__restrict __abs_timeout)
  66. __nonnull ((2, 5));
  67. /* Add message pointed by MSG_PTR to message queue MQDES, stop blocking
  68. on full message queue if ABS_TIMEOUT expires. */
  69. extern int mq_timedsend (mqd_t __mqdes, const char *__msg_ptr,
  70. size_t __msg_len, unsigned int __msg_prio,
  71. const struct timespec *__abs_timeout)
  72. __nonnull ((2, 5));
  73. #endif
  74. /* Define some inlines helping to catch common problems. */
  75. #if __USE_FORTIFY_LEVEL > 0 && defined __fortify_function \
  76. && defined __va_arg_pack_len
  77. # include <bits/mqueue2.h>
  78. #endif
  79. __END_DECLS
  80. #endif /* mqueue.h */