mqueue.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

 
/*
 *  COPYRIGHT (c) 1989-2011.
 *  On-Line Applications Research Corporation (OAR).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _MQUEUE_H
#define _MQUEUE_H
 
 
#include <unistd.h>
 
#if defined(_POSIX_MESSAGE_PASSING)
 
#include <sys/types.h>

 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 *  15.1.1 Data Structures, P1003.1b-1993, p. 271
 */

typedef uint32_t  mqd_t;

struct mq_attr {
  long  mq_flags;
  long  mq_maxmsg;
  long  mq_msgsize;
  long  mq_curmsgs;
};

mqd_t mq_open(
  const char *name,
  int         oflag,
  ...
);

int mq_close(
  mqd_t  mqdes
);

int mq_unlink(
  const char *name
);

int mq_send(
  mqd_t         mqdes,
  const char   *msg_ptr,
  size_t        msg_len,
  unsigned int  msg_prio
);
 
#if defined(_POSIX_TIMEOUTS)
 
#include <time.h>

int mq_timedsend(
  mqd_t                  mqdes,
  const char            *msg_ptr,
  size_t                 msg_len,
  unsigned int           msg_prio,
  const struct timespec *abstime
);
 
#endif /* _POSIX_TIMEOUTS */

ssize_t mq_receive(
  mqd_t         mqdes,
  char         *msg_ptr,
  size_t        msg_len,
  unsigned int *msg_prio
);
 
#if defined(_POSIX_TIMEOUTS)
 
ssize_t mq_timedreceive(
  mqd_t                  mqdes,
  char                  *__restrict msg_ptr,
  size_t                 msg_len,
  unsigned int          *__restrict msg_prio,
  const struct timespec *__restrict abstime
);
 
#endif /* _POSIX_TIMEOUTS */
 
#if defined(_POSIX_REALTIME_SIGNALS)

int mq_notify(
  mqd_t                  mqdes,
  const struct sigevent *notification
);
 
#endif /* _POSIX_REALTIME_SIGNALS */

int mq_setattr(
  mqd_t                 mqdes,
  const struct mq_attr *__restrict mqstat,
  struct mq_attr       *__restrict omqstat
);
 
/*
 *  15.2.8 Get Message Queue Attributes, P1003.1b-1993, p. 283
 */
 
int mq_getattr(
  mqd_t           mqdes,
  struct mq_attr *mqstat
);

 
#ifdef __cplusplus
}
#endif
 
#endif /* _POSIX_MESSAGE_PASSING */
 
#endif
/* end of include file */