MsgQueue.h

Go to the documentation of this file.
00001 /*
00002  * IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING. By
00003  * downloading, copying, installing or using the software you agree to
00004  * this license. If you do not agree to this license, do not download,
00005  * install, copy or use the software.
00006  * 
00007  * Intel Open Source License 
00008  * 
00009  * Copyright (c) 2004 Intel Corporation. All rights reserved. 
00010  * 
00011  * Redistribution and use in source and binary forms, with or without
00012  * modification, are permitted provided that the following conditions are
00013  * met:
00014  * 
00015  *   Redistributions of source code must retain the above copyright
00016  *   notice, this list of conditions and the following disclaimer.
00017  * 
00018  *   Redistributions in binary form must reproduce the above copyright
00019  *   notice, this list of conditions and the following disclaimer in the
00020  *   documentation and/or other materials provided with the distribution.
00021  * 
00022  *   Neither the name of the Intel Corporation nor the names of its
00023  *   contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *  
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00027  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00028  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00029  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
00030  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00031  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00033  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00034  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00035  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037  */
00038 
00039 #ifndef _OASYS_MSG_QUEUE_H_
00040 #define _OASYS_MSG_QUEUE_H_
00041 
00042 #include <queue>
00043 #include <unistd.h>
00044 #include <errno.h>
00045 #include <sys/poll.h>
00046 
00047 #include "Notifier.h"
00048 #include "SpinLock.h"
00049 #include "../debug/Log.h"
00050 #include "../debug/DebugUtils.h"
00051 
00052 namespace oasys {
00053 
00059 template<typename _elt_t>
00060 class MsgQueue : public Notifier {
00061 public:    
00065     MsgQueue(const char* logpath, SpinLock* lock = NULL);
00066         
00070     ~MsgQueue();
00071 
00076     void push(_elt_t msg, bool at_back = true);
00077     
00082     void push_front(_elt_t msg)
00083     {
00084         push(msg, false);
00085     }
00086 
00091     void push_back(_elt_t msg)
00092     {
00093         push(msg, true);
00094     }
00095 
00099     _elt_t pop_blocking();
00100 
00105     bool try_pop(_elt_t* eltp);
00106     
00110     size_t size()
00111     {
00112         ScopeLock l(lock_, "MsgQueue::size");
00113         return queue_.size();
00114     }
00115 
00128     void notify_when_empty();
00129 
00130 protected:
00131     SpinLock*          lock_;
00132     std::deque<_elt_t> queue_;
00133     bool               notify_when_empty_;
00134 };
00135 
00136 #include "MsgQueue.tcc"
00137 
00138 } // namespace oasys
00139 
00140 #endif //_OASYS_MSG_QUEUE_H_

Generated on Fri Dec 22 14:47:59 2006 for DTN Reference Implementation by  doxygen 1.5.1