Caching_Node.hxx

// 
// Copyright (C) 2006 James M. Lawrence.  All rights reserved.
// 
// software: esve-1.0.3
// file: esve/kernel/Caching_Node.hxx
// 
// Redistribution and use in source and binary forms, with or without
// modification, 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. The origin of this software must not be misrepresented; you must
//    not claim that you wrote the original software.  If you use this
//    software in a product, an acknowledgment in the product 
//    documentation would be appreciated but is not required.
// 
// 3. Altered source versions must be plainly marked as such, and must
//    not be misrepresented as being the original software.
// 
// 4. The name of the author may not be used to endorse or promote
//    products derived from this software without specific prior written
//    permission.
// 
// THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY,
// AND WITH NO CLAIM AS TO ITS SUITABILITY FOR ANY PURPOSE.  IN NO EVENT
// SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM WHATSOEVER MADE IN CONNECTION
// TO THIS SOFTWARE.
// 

#ifndef esve_kernel_Caching_Node_hxx
#define esve_kernel_Caching_Node_hxx

#include <esve/kernel/impl/Handler.hxx>
#include <esve/kernel/impl/Emitter.hxx>
#include <esve/kernel/Kernel_Node.hxx>
#include <esve/message/Active_State.hxx>
#include <memory>

namespace esve { namespace kernel {


class Caching_Node
    : virtual public Kernel_Node,
      virtual public impl::Handler,
      virtual public impl::Emitter
{
public:
    Caching_Node( bool caching ) ;

    virtual void start_caching() ;

    virtual bool stop_caching() ;

    virtual void discard_cache() ;

    virtual bool caching() const ;

    bool active() const ;
    void active( bool ) ;

    ~Caching_Node() ;

private:
    Caching_Node( const Caching_Node & ) ;
    Caching_Node & operator=( const Caching_Node & ) ;
    
    class Private ;
    const std::auto_ptr<Private> m ;
} ;

}} // namespace esve::kernel

#endif

---