summaryrefslogtreecommitdiffstats
path: root/common/collection/collection_queue.h
diff options
context:
space:
mode:
Diffstat (limited to 'common/collection/collection_queue.h')
-rw-r--r--common/collection/collection_queue.h81
1 files changed, 81 insertions, 0 deletions
diff --git a/common/collection/collection_queue.h b/common/collection/collection_queue.h
new file mode 100644
index 000000000..113fcbfb6
--- /dev/null
+++ b/common/collection/collection_queue.h
@@ -0,0 +1,81 @@
+/*
+ QUEUE
+
+ Header file for queue implemented using collection interface.
+
+ Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+ Collection Library is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Collection Library 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 Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with Collection Library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef COLLECTION_QUEUE_H
+#define COLLECTION_QUEUE_H
+
+#include "collection.h"
+
+
+#define COL_CLASS_QUEUE 40000
+#define COL_NAME_QUEUE "queue"
+
+/* Function that creates a queue object */
+int create_queue(struct collection_item **queue);
+
+/* Function that destroys a queue object */
+void destroy_queue(struct collection_item *queue);
+
+/* Family of functions that add property to a queue */
+/* Put a string property to queue. */
+int enqueue_str_property(struct collection_item *queue,
+ const char *property, char *string, int length);
+/* Put a binary property to queue. */
+int enqueue_binary_property(struct collection_item *queue,
+ const char *property, void *binary_data, int length);
+/* Put an int property to queue. */
+int enqueue_int_property(struct collection_item *queue,
+ const char *property, int number);
+/* Put an unsigned int property to queue. */
+int enqueue_unsigned_property(struct collection_item *queue,
+ const char *property, unsigned int number);
+/* Put a long property. */
+int enqueue_long_property(struct collection_item *queue,
+ const char *property, long number);
+/* Put an unsigned long property. */
+int enqueue_ulong_property(struct collection_item *queue,
+ const char *property, unsigned long number);
+/* Put a double property. */
+int enqueue_double_property(struct collection_item *queue,
+ const char *property, double number);
+/* Put a bool property. */
+int enqueue_bool_property(struct collection_item *queue,
+ const char *property, unsigned char logical);
+
+/* Put any property */
+int enqueue_any_property(struct collection_item *queue, /* Queue */
+ const char *property, /* Name */
+ int type, /* Data type */
+ void *data, /* Pointer to the data */
+ int length); /* Length of the data. For
+ strings it includes the
+ trailing 0 */
+/* Push item */
+int enqueue_item(struct collection_item *queue,
+ struct collection_item *item);
+
+
+/* Get item from queue */
+int dequeue_item(struct collection_item *queue,
+ struct collection_item **item);
+
+
+#endif