- send_queue written, but not tested
authorJan Hutter <jhutter@hsr.ch>
Mon, 7 Nov 2005 07:49:59 +0000 (07:49 -0000)
committerJan Hutter <jhutter@hsr.ch>
Mon, 7 Nov 2005 07:49:59 +0000 (07:49 -0000)
Source/charon/job_queue.c
Source/charon/send_queue.c [new file with mode: 0644]
Source/charon/send_queue.h [new file with mode: 0644]

index a42a582..3844004 100644 (file)
@@ -59,7 +59,7 @@ struct private_job_queue_s {
 /**
  * @brief implements function get_count of job_queue_t
  */
 /**
  * @brief implements function get_count of job_queue_t
  */
-status_t get_count(private_job_queue_t *this, int *count)
+static status_t get_count(private_job_queue_t *this, int *count)
 {
        pthread_mutex_lock(&(this->mutex));
        this->list->get_count(this->list,count);
 {
        pthread_mutex_lock(&(this->mutex));
        this->list->get_count(this->list,count);
@@ -70,7 +70,7 @@ status_t get_count(private_job_queue_t *this, int *count)
 /**
  * @brief implements function get of job_queue_t
  */
 /**
  * @brief implements function get of job_queue_t
  */
-status_t get(private_job_queue_t *this, job_t **job)
+static status_t get(private_job_queue_t *this, job_t **job)
 {
        int count;
        int oldstate;
 {
        int count;
        int oldstate;
@@ -97,7 +97,7 @@ status_t get(private_job_queue_t *this, job_t **job)
 /**
  * @brief implements function add of job_queue_t
  */
 /**
  * @brief implements function add of job_queue_t
  */
-status_t add(private_job_queue_t *this, job_t *job)
+static status_t add(private_job_queue_t *this, job_t *job)
 {
        pthread_mutex_lock(&(this->mutex));
        this->list->insert_last(this->list,job);
 {
        pthread_mutex_lock(&(this->mutex));
        this->list->insert_last(this->list,job);
@@ -110,7 +110,7 @@ status_t add(private_job_queue_t *this, job_t *job)
  * @brief implements function destroy of job_queue_t
  * 
  */
  * @brief implements function destroy of job_queue_t
  * 
  */
-status_t job_queue_destroy (private_job_queue_t *this)
+static status_t job_queue_destroy (private_job_queue_t *this)
 {      
        int count;
        this->list->get_count(this->list,&count);
 {      
        int count;
        this->list->get_count(this->list,&count);
diff --git a/Source/charon/send_queue.c b/Source/charon/send_queue.c
new file mode 100644 (file)
index 0000000..3fe04d5
--- /dev/null
@@ -0,0 +1,169 @@
+/**
+ * @file send_queue.c
+ * 
+ * @brief Send-Queue based on linked_list_t
+ * 
+ */
+
+/*
+ * Copyright (C) 2005 Jan Hutter, Martin Willi
+ * Hochschule fuer Technik Rapperswil
+ *
+ * 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * 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.
+ */
+ #include <pthread.h>
+ #include "send_queue.h"
+ #include "linked_list.h"
+ /**
+ * @brief Private Variables and Functions of send_queue class
+ * 
+ */
+typedef struct private_send_queue_s private_send_queue_t;
+
+struct private_send_queue_s {
+       /**
+        * Public part of the send_queue_t object
+        */
+       send_queue_t public;
+       
+       /**
+        * The packets are stored in a linked list
+        */
+       linked_list_t *list;
+       
+       /**
+        * access to linked_list is locked through this mutex
+        */
+       pthread_mutex_t mutex;
+       
+       /**
+        * If the queue is empty a thread has to wait
+        * This condvar is used to wake up such a thread
+        */
+       pthread_cond_t condvar; 
+};
+/**
+ * @brief implements function get_count of send_queue_t
+ */
+static status_t get_count(private_send_queue_t *this, int *count)
+{
+       pthread_mutex_lock(&(this->mutex));
+       this->list->get_count(this->list,count);
+       pthread_mutex_unlock(&(this->mutex));
+       return SUCCESS;
+}
+ /**
+ * @brief implements function get of send_queue_t
+ */
+static status_t get(private_send_queue_t *this, packet_t **packet)
+{
+       int count;
+       int oldstate;
+       pthread_mutex_lock(&(this->mutex));
+       /* go to wait while no packets available */
+       this->list->get_count(this->list,&count);
+       while(count == 0)
+       {
+               /* add mutex unlock handler for cancellation, enable cancellation */
+               pthread_cleanup_push((void(*)(void*))pthread_mutex_unlock, (void*)&(this->mutex));
+               pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldstate);
+               pthread_cond_wait( &(this->condvar), &(this->mutex));
+               
+               /* reset cancellation, remove mutex-unlock handler (without executing) */
+               pthread_setcancelstate(oldstate, NULL);
+               pthread_cleanup_pop(0);
+               this->list->get_count(this->list,&count);
+       }
+       this->list->remove_first(this->list,(void **) packet);
+       pthread_mutex_unlock(&(this->mutex));
+       return SUCCESS;
+}
+ /**
+ * @brief implements function add of send_queue_t
+ */
+static status_t add(private_send_queue_t *this, packet_t *packet)
+{
+       pthread_mutex_lock(&(this->mutex));
+       this->list->insert_last(this->list,packet);
+       pthread_cond_signal( &(this->condvar));
+       pthread_mutex_unlock(&(this->mutex));
+       return SUCCESS;
+}
+ /**
+ * @brief implements function destroy of send_queue_t
+ * 
+ */
+static status_t destroy (private_send_queue_t *this)
+{
+       int count;
+       this->list->get_count(this->list,&count);
+       
+       /* destroy all packets in list before destroying list */
+       while (count > 0) 
+       {
+               packet_t *packet;
+               if (this->list->remove_first(this->list,(void *) &packet) != SUCCESS)
+               {
+                       this->list->destroy(this->list);
+                       break;
+               }
+               packet->destroy(packet);
+               this->list->get_count(this->list,&count);
+       }
+       this->list->destroy(this->list);
+       
+       pthread_mutex_destroy(&(this->mutex));
+       
+       pthread_cond_destroy(&(this->condvar));
+       
+       pfree(this);
+       return SUCCESS;
+}
+ /*
+ * 
+ * Documented in header
+ */
+send_queue_t *send_queue_create()
+{
+       linked_list_t *linked_list = linked_list_create();
+       if (linked_list == NULL)
+       {
+               return NULL;
+       }
+       
+       private_send_queue_t *this = alloc_thing(private_send_queue_t, "private_send_queue_t");
+       if (this == NULL)
+       {
+               linked_list->destroy(linked_list);
+               return NULL;
+       }
+       
+       this->public.get_count = (status_t(*)(send_queue_t*, int*)) get_count;
+       this->public.get = (status_t(*)(send_queue_t*, packet_t**)) get;
+       this->public.add = (status_t(*)(send_queue_t*, packet_t*)) add;
+       this->public.destroy = (status_t(*)(send_queue_t*)) destroy;
+       
+       this->list = linked_list;
+       pthread_mutex_init(&(this->mutex), NULL);
+       pthread_cond_init(&(this->condvar), NULL);
+       
+       return (&this->public);
+}
diff --git a/Source/charon/send_queue.h b/Source/charon/send_queue.h
new file mode 100644 (file)
index 0000000..d4e5cc5
--- /dev/null
@@ -0,0 +1,94 @@
+/**
+ * @file send_queue.h
+ * 
+ * @brief Send-Queue based on linked_list_t
+ * 
+ */
+
+/*
+ * Copyright (C) 2005 Jan Hutter, Martin Willi
+ * Hochschule fuer Technik Rapperswil
+ *
+ * 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * 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.
+ */
+
+#ifndef SEND_QUEUE_H_
+#define SEND_QUEUE_H_
+
+#include "types.h"
+#include "packet.h"
+
+/**
+ * @brief Send-Queue
+ *
+ * Although the send-queue is based on a linked_list_t 
+ * all access functions are thread-save implemented
+ */
+typedef struct send_queue_s send_queue_t;
+
+struct send_queue_s {
+       
+       /**
+        * @brief returns number of packets in queue
+        * 
+        * @param send_queue_t calling object
+        * @param[out] count integer pointer to store the count in
+        * @returns SUCCESS if succeeded, FAILED otherwise
+        */
+       status_t (*get_count) (send_queue_t *send_queue, int *count);
+
+       /**
+        * @brief get the next packet from the queue
+        * 
+        * If the queue is empty, this function blocks until a packet can be returned.
+        * 
+        * After using, the returned packet has to get destroyed by the caller.
+        * 
+        * @param send_queue_t calling object
+        * @param[out] packet pointer to a packet_t pointer where to packet is returned to
+        * @returns SUCCESS if succeeded, FAILED otherwise
+        */
+       status_t (*get) (send_queue_t *send_queue, packet_t **packet);
+       
+       /**
+        * @brief adds a packet to the queue
+        * 
+        * This function is non blocking and adds a packet_t to the list.
+        * The specific packet-object has to get destroyed by the thread which 
+        * removes the packet.
+        * 
+        * @param send_queue_t calling object
+        * @param[in] packet packet_t to add to the queue (packet is not copied)
+        * @returns SUCCESS if succeeded, FAILED otherwise
+        */
+       status_t (*add) (send_queue_t *send_queue, packet_t *packet);
+
+       /**
+        * @brief destroys a send_queue object
+        * 
+        * @warning The caller of this function has to make sure
+        * that no thread is going to add or get a packet from the send_queue
+        * after calling this function.
+        * 
+        * @param send_queue_t calling object
+        * @returns SUCCESS if succeeded, FAILED otherwise
+        */
+       status_t (*destroy) (send_queue_t *send_queue);
+};
+
+/**
+ * @brief Creates an empty send_queue_t
+ * 
+ * @return send_queue_t empty send_queue_t
+ */
+send_queue_t *send_queue_create();
+
+#endif /*SEND_QUEUE_H_*/