varrw.hh

// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// vim:set sts=4 ts=8:

// Copyright (c) 2001-2011 XORP, Inc and Others
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, Version 2, June
// 1991 as published by the Free Software Foundation. Redistribution
// and/or modification of this program under the terms of any other
// version of the GNU General Public License is not permitted.
// 
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For more details,
// see the GNU General Public License, Version 2, a copy of which can be
// found in the XORP LICENSE.gpl file.
// 
// XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net

// $XORP: xorp/policy/common/varrw.hh,v 1.19 2008/10/02 21:58:07 bms Exp $

#ifndef __POLICY_BACKEND_VARRW_HH__
#define __POLICY_BACKEND_VARRW_HH__

#include "element_base.hh"



class VarRW {
public:
    typedef int Id;
    enum {
        VAR_TRACE   = 0,
        VAR_POLICYTAGS,
        VAR_FILTER_IM,
        VAR_FILTER_SM,
        VAR_FILTER_EX,
    VAR_TAG     = 5,
        VAR_PROTOCOL    = 10, // protocol specific vars start here
        VAR_MAX     = 32  // must be last
    };

    VarRW();
    virtual ~VarRW();

    virtual const Element& read(const Id& id) = 0;

    virtual void write(const Id& id, const Element& e) = 0;

    virtual void sync();

    void enable_trace(bool on);

    const Element& read_trace(const Id& id); 

    void write_trace(const Id& id, const Element& e);

    uint32_t trace();

    string tracelog();

    virtual string more_tracelog();

    void reset_trace();

private:
    bool        _do_trace;
    uint32_t        _trace;
    ostringstream   _tracelog;
};

#endif // __POLICY_BACKEND_VARRW_HH__