Port FFS tools over from Building Block repository.

1 files changed, 144 insertions, 0 deletions

diff --git a/clib/mq.h b/clib/mq.h
new file mode 100644
index 0000000..95cca4d
--- /dev/null
+++ b/clib/mq.h
@@ -0,0 +1,144 @@
+/*
+ * Copyright (c) International Business Machines Corp., 2014
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+/*!
+ * @file mqueue.h
+ * @brief Message queues
+ * @author Shaun Wetzstein <shaun@us.ibm.com>
+ * @date 2010-2011
+ */
+
+#ifndef __MQUEUE_H__
+#define __MQUEUE_H__
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <mqueue.h>
+
+#include "attribute.h"
+
+/* ==================================================================== */
+
+typedef struct mqueue mqueue_t;	//!< Alias for the @em mqueue class
+typedef struct mq_attr mqueue_attr_t;
+
+#define	INIT_MQUEUE	{NULL,-1,-1}
+
+/*!
+ * @brief POSIX message queues
+ */
+struct mqueue {
+	char *service;		//!< Message queue name
+
+	mqd_t in;		//!< Inbound message queue
+	mqd_t out;		//!< Outbound message queue
+};
+
+/* ==================================================================== */
+
+/*!
+ * @brief Constructs a @em mqueue object
+ * @memberof mqueue
+ * @param self [in] mqueue object @em self pointer
+ * @param service [in] mqueue service name
+ * @return None
+ * @throws UNEXPECTED if @em self pointer is NULL
+ */
+extern int mqueue_init(mqueue_t *, const char *)
+/*! @cond */
+__nonnull((1, 2)) /*! @endcond */ ;
+
+/*!
+ * @brief Destructs a @em mqueue object
+ * @details Closes all message queues associated with this \em mqueue object
+ * @memberof mqueue
+ * @param self [in] mqueue object @em self pointer
+ * @return None
+ */
+extern int mqueue_delete(mqueue_t *)
+/*! @cond */
+__nonnull((1)) /*! @endcond */ ;
+
+/*!
+ * @brief Create the server-side of a @em mqueue object
+ * @memberof mqueue
+ * @param self [in] mqueue object @em self pointer
+ * @param tid [in] thread id
+ * @return None
+ */
+extern int mqueue_create(mqueue_t *, pid_t)
+/*! @cond */
+__nonnull((1)) /*! @endcond */ ;
+
+/*!
+ * @brief Create the client-side of a @em mqueue object
+ * @memberof mqueue
+ * @param self [in] mqueue object @em self pointer
+ * @param path [in] FIX ME
+ * @return None
+ */
+extern int mqueue_open(mqueue_t *, char *)
+/*! @cond */
+__nonnull((1, 2)) /*! @endcond */ ;
+
+/*!
+ * @brief Close a @em mqueue object
+ * @memberof mqueue
+ * @param self [in] mqueue object @em self pointer
+ * @param path [in] FIX ME
+ * @return None
+ */
+extern int mqueue_close(mqueue_t *, char *)
+/*! @cond */
+__nonnull((1, 2)) /*! @endcond */ ;
+
+/*!
+ * @brief Get message queue operating attributes of a @em mqueue object
+ * @memberof mqueue
+ * @param self [in] mqueue object @em self pointer
+ * @return Initialized mqueue_attr object
+ */
+extern mqueue_attr_t mqueue_getattr(mqueue_t *)
+/*! @cond */
+__nonnull((1)) /*! @endcond */ ;
+
+/*!
+ * @brief Write (send) a message to a @em mqueue object
+ * @memberof mqueue
+ * @param self [in] mqueue object @em self pointer
+ * @param ptr [in] Reference to data bytes to send
+ * @param ptr [in] Length (in bytes) of the data bytes
+ * @return non-0 on success, 0 othereise
+ */
+extern int mqueue_send(mqueue_t *, void *, size_t)
+/*! @cond */
+__nonnull((1, 2)) /*! @endcond */ ;
+
+/*!
+ * @brief Read (receive) a message from a @em mqueue object
+ * @memberof mqueue
+ * @param self [in] mqueue object @em self pointer
+ * @param ptr [out] Reference to data bytes to send
+ * @param ptr [in] Length (in bytes) of the buffer referenced by @em ptr
+ * @return non-0 on success, 0 othereise
+ */
+extern int mqueue_receive(mqueue_t *, void *, size_t)
+/*! @cond */
+__nonnull((1, 2)) /*! @endcond */ ;
+
+#endif				/* __MQUEUE_H__ */