Return to msg_queue.h CVS log

Up to [Synchronet] / sbbs / src / xpdev

Annotation of sbbs/src/xpdev/msg_queue.h, revision 1.1.1.2

1.1       root        1: /* msg_queue.h */
                      2: 
                      3: /* Uni or Bi-directional FIFO message queue */
                      4: 
1.1.1.2 ! root        5: /* $Id: msg_queue.h,v 1.6 2011/09/01 20:37:30 rswindell Exp $ */
1.1       root        6: 
                      7: /****************************************************************************
                      8:  * @format.tab-size 4          (Plain Text/Source Code File Header)                    *
                      9:  * @format.use-tabs true       (see http://www.synchro.net/ptsc_hdr.html)              *
                     10:  *                                                                                                                                                     *
1.1.1.2 ! root       11:  * Copyright 2011 Rob Swindell - http://www.synchro.net/copyright.html         *
1.1       root       12:  *                                                                                                                                                     *
                     13:  * This library is free software; you can redistribute it and/or                       *
                     14:  * modify it under the terms of the GNU Lesser General Public License          *
                     15:  * as published by the Free Software Foundation; either version 2                      *
                     16:  * of the License, or (at your option) any later version.                                      *
                     17:  * See the GNU Lesser General Public License for more details: lgpl.txt or     *
                     18:  * http://www.fsf.org/copyleft/lesser.html                                                                     *
                     19:  *                                                                                                                                                     *
                     20:  * Anonymous FTP access to the most recent released source is available at     *
                     21:  * ftp://vert.synchro.net, ftp://cvs.synchro.net and ftp://ftp.synchro.net     *
                     22:  *                                                                                                                                                     *
                     23:  * Anonymous CVS access to the development source and modification history     *
                     24:  * is available at cvs.synchro.net:/cvsroot/sbbs, example:                                     *
                     25:  * cvs -d :pserver:[email protected]:/cvsroot/sbbs login                       *
                     26:  *     (just hit return, no password is necessary)                                                     *
                     27:  * cvs -d :pserver:[email protected]:/cvsroot/sbbs checkout src                *
                     28:  *                                                                                                                                                     *
                     29:  * For Synchronet coding style and modification guidelines, see                                *
                     30:  * http://www.synchro.net/source.html                                                                          *
                     31:  *                                                                                                                                                     *
                     32:  * You are encouraged to submit any modifications (preferably in Unix diff     *
                     33:  * format) via e-mail to [email protected]                                                                      *
                     34:  *                                                                                                                                                     *
                     35:  * Note: If this box doesn't appear square, then you need to fix your tabs.    *
                     36:  ****************************************************************************/
                     37: 
                     38: #ifndef _MSG_QUEUE_H
                     39: #define _MSG_QUEUE_H
                     40: 
                     41: #include "link_list.h"
1.1.1.2 ! root       42: #include "threadwrap.h"
1.1       root       43: 
                     44: #if defined(__cplusplus)
                     45: extern "C" {
                     46: #endif
                     47: 
                     48: typedef struct {
                     49:        char                    name[128];                      /* for named-queues */
                     50:        link_list_t             in;
                     51:        link_list_t             out;
                     52:        pthread_t               owner_thread_id;        /* reads from in, writes to out */
                     53:        long                    refs;
                     54:        unsigned long   flags;                          /* private use flags */
                     55:        void*                   private_data;
                     56: } msg_queue_t;
                     57: 
                     58: #define MSG_QUEUE_MALLOC               (1<<0)  /* Queue allocated with malloc() */
                     59: #define MSG_QUEUE_BIDIR                        (1<<1)  /* Bi-directional message queue */
                     60: 
                     61: msg_queue_t*   msgQueueInit(msg_queue_t*, long flags);
                     62: BOOL                   msgQueueFree(msg_queue_t*);
                     63: 
                     64: long                   msgQueueAttach(msg_queue_t*);
                     65: long                   msgQueueDetach(msg_queue_t*);
                     66: 
                     67: /* Get/Set queue private data */
                     68: void*                  msgQueueSetPrivateData(msg_queue_t*, void*);
                     69: void*                  msgQueueGetPrivateData(msg_queue_t*);
                     70: 
                     71: BOOL                   msgQueueWait(msg_queue_t* q, long timeout);
                     72: long                   msgQueueReadLevel(msg_queue_t*);
                     73: void*                  msgQueueRead(msg_queue_t*, long timeout);
                     74: void*                  msgQueuePeek(msg_queue_t*, long timeout);
                     75: void*                  msgQueueFind(msg_queue_t*, const void*, size_t length);
                     76: list_node_t*   msgQueueFirstNode(msg_queue_t*);
                     77: list_node_t*   msgQueueLastNode(msg_queue_t*);
                     78: #define                        msgQueueNextNode(node)                  listNextNode(node)
                     79: #define                        msgQueuePrevNode(node)                  listPrevNode(node)
                     80: #define                        msgQueueNodeData(node)                  listNodeData(node)
                     81: 
                     82: long                   msgQueueWriteLevel(msg_queue_t*);
                     83: BOOL                   msgQueueWrite(msg_queue_t*, const void*, size_t length);
                     84: 
                     85: #if defined(__cplusplus)
                     86: }
                     87: #endif
                     88: 
                     89: #endif /* Don't add anything after this line */

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.