GNU Radio 2.x: gr_msg_queue.h Source File

Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

# gr_msg_queue.h

Go to the documentation of this file.

    00001 /* -*- c++ -*- */
    00002 /*
    00003  * Copyright 2005 Free Software Foundation, Inc.
    00004  *
    00005  * This file is part of GNU Radio
    00006  *
    00007  * GNU Radio is free software; you can redistribute it and/or modify
    00008  * it under the terms of the GNU General Public License as published by
    00009  * the Free Software Foundation; either version 2, or (at your option)
    00010  * any later version.
    00011  *
    00012  * GNU Radio is distributed in the hope that it will be useful,
    00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    00015  * GNU General Public License for more details.
    00016  *
    00017  * You should have received a copy of the GNU General Public License
    00018  * along with GNU Radio; see the file COPYING.  If not, write to
    00019  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    00020  * Boston, MA 02111-1307, USA.
    00021  */
    00022 #ifndef INCLUDED_GR_MSG_QUEUE_H
    00023 #define INCLUDED_GR_MSG_QUEUE_H
    00024
    00025 #include <gr_msg_handler.h>
    00026 #include <omnithread.h>
    00027
    00028 class gr_msg_queue;
    00029 typedef boost::shared_ptr<gr_msg_queue> gr_msg_queue_sptr;
    00030
    00031 gr_msg_queue_sptr gr_make_msg_queue(unsigned int limit=0);
    00032
    00036 class gr_msg_queue : public gr_msg_handler {
    00037   omni_mutex            d_mutex;
    00038   omni_condition        d_not_empty;
    00039   omni_condition        d_not_full;
    00040   gr_message_sptr       d_head;
    00041   gr_message_sptr       d_tail;
    00042   unsigned int          d_count;    // # of messages in queue.
    00043   unsigned int          d_limit;    // max # of messages in queue.  0 -> unbounded
    00044
    00045 public:
    00046   gr_msg_queue(unsigned int limit);
    00047   ~gr_msg_queue();
    00048
    00050   void handle(gr_message_sptr msg) { insert_tail (msg); }
    00051
    00058   void insert_tail(gr_message_sptr msg);
    00059
    00064   gr_message_sptr delete_head();
    00065
    00070   gr_message_sptr delete_head_nowait();
    00071
    00073   void flush();
    00074
    00076   bool empty_p() const { return d_count == 0; }
    00077
    00079   bool full_p() const { return d_limit != 0 && d_count >= d_limit; }
    00080
    00082   unsigned int count() const { return d_count; }
    00083
    00085   unsigned int limit() const { return d_limit; }
    00086
    00087 };
    00088
    00089 #endif /* INCLUDED_GR_MSG_QUEUE_H */