queue.h

Go to the documentation of this file.

// -*- C++ -*-
//  Copyright (C) 2009-2017, Vaclav Haisman. All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without modifica-
//  tion, are permitted provided that the following conditions are met:
//
//  1. Redistributions of  source code must  retain the above copyright  notice,
//     this list of conditions and the following disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//
//  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
//  FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
//  APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
//  INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
//  DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
//  OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
//  ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
//  (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
//  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
#ifndef LOG4CPLUS_HELPERS_QUEUE_H
#define LOG4CPLUS_HELPERS_QUEUE_H
 
#include <log4cplus/config.hxx>
 
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
 
#if ! defined (LOG4CPLUS_SINGLE_THREADED)
 
#include <deque>
#include <log4cplus/spi/loggingevent.h>
#include <log4cplus/thread/threads.h>
#include <log4cplus/thread/syncprims.h>
 
 
namespace log4cplus { namespace thread {
 

class LOG4CPLUS_EXPORT Queue
    : public virtual helpers::SharedObject
{
public:
    typedef unsigned flags_type;

    typedef std::deque<spi::InternalLoggingEvent> queue_storage_type;
 
    explicit Queue (unsigned len = 100);
    virtual ~Queue ();
 
    // Producers' methods.

    flags_type put_event (spi::InternalLoggingEvent const & ev);

    flags_type signal_exit (bool drain = true);
 
    // Consumer's methods.

    flags_type get_events (queue_storage_type * buf);

    enum Flags
    {
        EVENT       = 0x0001,

        QUEUE       = 0x0002,

        EXIT        = 0x0004,

        DRAIN       = 0x0008,

        ERROR_BIT   = 0x0010,

        ERROR_AFTER = 0x0020
    };
 
protected:
    queue_storage_type queue;

    Mutex mutex;

    ManualResetEvent ev_consumer;

    Semaphore sem;

    flags_type flags;
 
private:
    Queue (Queue const &);
    Queue & operator = (Queue const &);
};
 
 
typedef helpers::SharedObjectPtr<Queue> QueuePtr;
 
 
} } // namespace log4cplus { namespace thread {
 
 
#endif // LOG4CPLUS_SINGLE_THREADED
 
#endif // LOG4CPLUS_HELPERS_QUEUE_H