Home

C-Bits Package Documentation

Project Page

---

             

---

LogStream.h

Go to the documentation of this file.

/* ====================================================================
 *              The CBITS Software License, Version 1.0
 *
 *               Copyright (c) 2002-2003 Bruce Lowery
 *                       All rights reserved
 *
 * Redistribution and use of this software, in source and binary forms, 
 * with or without modification, are permitted provided that the above 
 * copyright notice, this paragraph, and the following paragraph are 
 * retained in each source code file.
 *
 * 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 BRUCE LOWERY OR OTHER CONTRIBUTORS 
 * TO THE CBITS LIBRARY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 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 LogStream_H
#define LogStream_H

#include <iostream>
#include <string>
#include <map>

#include <cbits/LogLevel.h>
#include <cbits/LogStreamExceptions.h>
#include <cbits/NullStream.h>


#ifdef WIN32
#include <winnt.h>
#else
#include <pthread.h>
#endif


namespace cbits
{

class LogStream 
{

public:

    LogStream
    ( 
        const std::string& path,    
        const LogLevel::Level level,
        const bool appnd = true     
    )
    throw( LogStreamException );


    LogStream
    ( 
        std::ostream* os,           
        const LogLevel::Level level 
    )
    throw( LogStreamException );


    LogStream();


    inline const char*  get_file_path()  const
        { 
        if( _path )
        {
            return _path->c_str();
        }
        else
        {
            return 0;
        }
        }


    inline const LogLevel::Level get_max_level()  const
        { 
           return _max_level; 
        }


    LogLevel::Level reset_max_level
    ( 
        LogLevel::Level new_level 
    );


    void increaseLevel();


    void decreaseLevel();


    void setTrace
    (
        const bool on 
    )
    {
        _trace = on;
    }


    const bool isTraceOn() const
    {
        return _trace;
    }


    virtual ~LogStream( void );


    std::ostream* replace_stream
    ( 
        std::ostream*  
    ) 
        throw( LogStreamException);


    std::ostream* get_logstream() const;


    inline std::ostream* get_nullstream() const { return &_nullstream; }

    
    inline std::ostream* get_ostream()    const { return _ostream; }

    void lock() {
#ifdef WIN32
        EnterCriticalSection(&_lock);
#else
        pthread_mutex_lock(&_lock);
#endif
    }

    void unlock() {
#ifdef WIN32
        LeaveCriticalSection(&_lock);
#else
        pthread_mutex_unlock(&_lock);
#endif
    }

private:

    std::string*    _path;         
    LogLevel::Level _max_level;    
    mutable std::ostream* _ostream;
    bool            _own_stream;   
    mutable NullStream _nullstream;
    bool _trace;                   
    // COPY PROTECTION
    LogStream( const LogStream& );
    LogStream& operator=( const LogStream& );

    // Lock
#ifdef WIN32
    critical_section_t _lock; 
#else
    pthread_mutex_t _lock;    
#endif


};

}; /* END OF namespace cbits */


std::ostream& operator<<
( 
    cbits::LogStream&, 
    cbits::LogLevel::Level 
);

#endif /* LogStream_H */


/*
 * $Id: LogStream.h,v 1.10 2002/10/12 02:19:56 brulow Exp $
 * 
 * History: (Add nothing manually below)
 * -----------------------------------------------------------------------
 *
 * $Log: LogStream.h,v $
 * Revision 1.10  2002/10/12 02:19:56  brulow
 * Add socket pkg unit tests
 *
 * Revision 1.9  2002/10/11 15:58:25  brulow
 * Improve LogStream documentation
 *
 * Revision 1.8  2002/10/11 05:06:59  brulow
 * Clarify 'tracing' with LogStream.
 *
 * Revision 1.7  2002/10/11 01:47:29  brulow
 * Add logstream unit tests
 *
 * Revision 1.6  2002/10/10 01:16:22  brulow
 * Improve documentation
 *
 * Revision 1.5  2002/10/09 02:02:26  brulow
 * Improve package documentation
 *
 * Revision 1.4  2002/10/08 17:11:20  brulow
 * Improve documentation
 *
 * Revision 1.3  2002/09/28 00:08:50  brulow
 * Add lock/unlock methods to support thread safety.
 *
 * Revision 1.2  2002/09/27 22:04:16  brulow
 * Add history footer to all .h .cpp files
 *
 *
 */

---

Generated by

Hosted by