ifmgr_xrl_replicator.hh

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

// Copyright (c) 2001-2009 XORP, Inc.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License, Version
// 2.1, June 1999 as published by the Free Software Foundation.
// Redistribution and/or modification of this program under the terms of
// any other version of the GNU Lesser 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 Lesser General Public License, Version 2.1, a copy of
// which can be found in the XORP LICENSE.lgpl file.
// 
// XORP, Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net

// $XORP: xorp/libfeaclient/ifmgr_xrl_replicator.hh,v 1.15 2008/10/02 21:57:16 bms Exp $

#ifndef __LIBFEACLIENT_IFMGR_XRL_REPLICATOR_HH__
#define __LIBFEACLIENT_IFMGR_XRL_REPLICATOR_HH__

#include "ifmgr_atoms.hh"
#include "ifmgr_cmd_base.hh"
#include "ifmgr_cmd_queue.hh"

#include "libxorp/eventloop.hh"
#include "libxorp/safe_callback_obj.hh"
#include "libxipc/xrl_error.hh"

class IfMgrXrlReplicator :
    public IfMgrCommandSinkBase, public CallbackSafeObject  {
public:
    typedef IfMgrCommandSinkBase::Cmd Cmd;

public:
    IfMgrXrlReplicator(XrlSender&   sender,
               const string&    xrl_target_name);

    void push(const Cmd& cmd);

    void crank_replicator();

    const string& xrl_target_name() const   { return _tgt; }

    bool is_empty_queue() const { return (_queue.empty() == true); }

protected:
    virtual void crank_manager();

    virtual void crank_manager_cb();

    virtual void push_manager_queue();

    virtual void xrl_error_event(const XrlError& e);

protected:
    IfMgrXrlReplicator();

    IfMgrXrlReplicator(const IfMgrXrlReplicator&);

    IfMgrXrlReplicator& operator=(const IfMgrXrlReplicator&);

private:
    void xrl_cb(const XrlError& e);

protected:
    XrlSender&        _s;
    string        _tgt;

    IfMgrCommandFifoQueue _queue;
    bool          _pending;
};


class IfMgrXrlReplicationManager;

class IfMgrManagedXrlReplicator :
    public IfMgrXrlReplicator {
public:
    IfMgrManagedXrlReplicator(IfMgrXrlReplicationManager& manager,
                  XrlSender&         sender,
                  const string&      target_name);

protected:
    void crank_manager();

    void crank_manager_cb();

    void push_manager_queue();

    void xrl_error_event(const XrlError& e);

private:
    IfMgrXrlReplicationManager& _mgr;
};


class XrlRouter;

class IfMgrXrlReplicationManager : public IfMgrCommandSinkBase {
public:
    typedef IfMgrCommandSinkBase::Cmd Cmd;

public:
    IfMgrXrlReplicationManager(XrlRouter& rtr);

    ~IfMgrXrlReplicationManager();

    bool add_mirror(const string& xrl_target_name);

    bool remove_mirror(const string& xrl_target_name);

    void push(const Cmd& c);

    void crank_replicators_queue();

    void crank_replicators_queue_cb();

    void push_manager_queue(IfMgrManagedXrlReplicator* r);

    const IfMgrIfTree& iftree() const       { return _iftree; }

private:
    typedef list<IfMgrManagedXrlReplicator*> Outputs;

    IfMgrIfTree _iftree;
    XrlRouter&  _rtr;
    Outputs _outputs;
    Outputs _replicators_queue; // Cmd queue with ordered replicators
};

#endif // __LIBFEACLIENT_IFMGR_XRL_REPLICATOR_HH__