mqueue.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /* Copyright (C) 2004-2016 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. #define __need_timespec
  22. #include <time.h>
  23. /* Get the definition of mqd_t and struct mq_attr. */
  24. #include <bits/mqueue.h>
  25. __BEGIN_DECLS
  26. /* Establish connection between a process and a message queue NAME and
  27. return message queue descriptor or (mqd_t) -1 on error. OFLAG determines
  28. the type of access used. If O_CREAT is on OFLAG, the third argument is
  29. taken as a `mode_t', the mode of the created message queue, and the fourth
  30. argument is taken as `struct mq_attr *', pointer to message queue
  31. attributes. If the fourth argument is NULL, default attributes are
  32. used. */
  33. extern mqd_t mq_open (const char *__name, int __oflag, ...)
  34. __THROW __nonnull ((1));
  35. /* Removes the association between message queue descriptor MQDES and its
  36. message queue. */
  37. extern int mq_close (mqd_t __mqdes) __THROW;
  38. /* Query status and attributes of message queue MQDES. */
  39. extern int mq_getattr (mqd_t __mqdes, struct mq_attr *__mqstat)
  40. __THROW __nonnull ((2));
  41. /* Set attributes associated with message queue MQDES and if OMQSTAT is
  42. not NULL also query its old attributes. */
  43. extern int mq_setattr (mqd_t __mqdes,
  44. const struct mq_attr *__restrict __mqstat,
  45. struct mq_attr *__restrict __omqstat)
  46. __THROW __nonnull ((2));
  47. /* Remove message queue named NAME. */
  48. extern int mq_unlink (const char *__name) __THROW __nonnull ((1));
  49. /* Register notification issued upon message arrival to an empty
  50. message queue MQDES. */
  51. extern int mq_notify (mqd_t __mqdes, const struct sigevent *__notification)
  52. __THROW;
  53. /* Receive the oldest from highest priority messages in message queue
  54. MQDES. */
  55. extern ssize_t mq_receive (mqd_t __mqdes, char *__msg_ptr, size_t __msg_len,
  56. unsigned int *__msg_prio) __nonnull ((2));
  57. /* Add message pointed by MSG_PTR to message queue MQDES. */
  58. extern int mq_send (mqd_t __mqdes, const char *__msg_ptr, size_t __msg_len,
  59. unsigned int __msg_prio) __nonnull ((2));
  60. #ifdef __USE_XOPEN2K
  61. /* Receive the oldest from highest priority messages in message queue
  62. MQDES, stop waiting if ABS_TIMEOUT expires. */
  63. extern ssize_t mq_timedreceive (mqd_t __mqdes, char *__restrict __msg_ptr,
  64. size_t __msg_len,
  65. unsigned int *__restrict __msg_prio,
  66. const struct timespec *__restrict __abs_timeout)
  67. __nonnull ((2, 5));
  68. /* Add message pointed by MSG_PTR to message queue MQDES, stop blocking
  69. on full message queue if ABS_TIMEOUT expires. */
  70. extern int mq_timedsend (mqd_t __mqdes, const char *__msg_ptr,
  71. size_t __msg_len, unsigned int __msg_prio,
  72. const struct timespec *__abs_timeout)
  73. __nonnull ((2, 5));
  74. #endif
  75. /* Define some inlines helping to catch common problems. */
  76. #if __USE_FORTIFY_LEVEL > 0 && defined __fortify_function \
  77. && defined __va_arg_pack_len
  78. # include <bits/mqueue2.h>
  79. #endif
  80. __END_DECLS
  81. #endif /* mqueue.h */