include/tr_mq.h

   1 #ifndef _TR_MQ_H_
   2 #define _TR_MQ_H_
   3
   4 #include <talloc.h>
   5 #include <pthread.h>
   6
   7 /* Note on mq priorities: High priority messages are guaranteed to be
   8  * processed before any normal priority messages. Otherwise, messages
   9  * will be processed in the order they are added to the queue. */
  10
  11 typedef enum tr_mq_priority {
  12   TR_MQ_PRIO_NORMAL=0,
  13   TR_MQ_PRIO_HIGH
  14 } TR_MQ_PRIORITY;
  15
  16 /* msg for inter-thread messaging */
  17 typedef struct tr_mq_msg TR_MQ_MSG;
  18 struct tr_mq_msg {
  19   TR_MQ_MSG *next;
  20   TR_MQ_PRIORITY prio;
  21   char *message;
  22   void *p; /* payload */
  23   void (*p_free)(void *); /* function to free payload */
  24 };
  25
  26 /* message queue for inter-thread messaging */
  27
  28 typedef struct tr_mq TR_MQ;
  29 typedef void (*TR_MQ_NOTIFY_FN)(TR_MQ *, void *);
  30 struct tr_mq {
  31   pthread_mutex_t mutex;
  32   TR_MQ_MSG *head;
  33   TR_MQ_MSG *tail;
  34   TR_MQ_MSG *last_hi_prio;
  35   TR_MQ_NOTIFY_FN notify_cb; /* callback when queue becomes non-empty */
  36   void *notify_cb_arg;
  37 };
  38
  39 /* message string for sending trpc messages */
  40 #define TR_MQMSG_TRPC_SEND "trpc send msg"
  41
  42 TR_MQ_MSG *tr_mq_msg_new(TALLOC_CTX *mem_ctx, const char *msg, TR_MQ_PRIORITY prio);
  43 void tr_mq_msg_free(TR_MQ_MSG *msg);
  44 TR_MQ_PRIORITY tr_mq_msg_get_prio(TR_MQ_MSG *msg);
  45 const char *tr_mq_msg_get_message(TR_MQ_MSG *msg);
  46 void *tr_mq_msg_get_payload(TR_MQ_MSG *msg);
  47 void tr_mq_msg_set_payload(TR_MQ_MSG *msg, void *p, void (*p_free)(void *));
  48
  49
  50 TR_MQ *tr_mq_new(TALLOC_CTX *mem_ctx);
  51 void tr_mq_free(TR_MQ *mq);
  52 int tr_mq_lock(TR_MQ *mq);
  53 int tr_mq_unlock(TR_MQ *mq);
  54 void tr_mq_set_notify_cb(TR_MQ *mq, TR_MQ_NOTIFY_FN cb, void *arg);
  55 void tr_mq_add(TR_MQ *mq, TR_MQ_MSG *msg);
  56 TR_MQ_MSG *tr_mq_pop(TR_MQ *mq);
  57 void tr_mq_clear(TR_MQ *mq);
  58
  59 #endif /*_TR_MQ_H_ */