ifmgr_xrl_mirror.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 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


#ifndef __LIBFEACLIENT_XRL_IFMGR_MIRROR_HH__
#define __LIBFEACLIENT_XRL_IFMGR_MIRROR_HH__

#include "libxorp/xorp.h"
#include "libxorp/ipv4.hh"
#include "libxorp/timer.hh"
#include "libxorp/service.hh"
#include "libxipc/finder_constants.hh"

#include "xrl/targets/fea_ifmgr_mirror_base.hh"

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


class XrlStdRouter;
class EventLoop;
class IfMgrCommandBase;
class IfMgrXrlMirrorRouter;
class IfMgrXrlMirrorTarget;

class IfMgrXrlMirrorRouterObserver {
public:
    virtual ~IfMgrXrlMirrorRouterObserver() = 0;
    virtual void finder_disconnect_event() = 0;
    virtual void finder_ready_event() = 0;
};

class IfMgrHintObserver {
public:
    virtual ~IfMgrHintObserver() = 0;
    virtual void tree_complete() = 0;
    virtual void updates_made() = 0;
};

class IfMgrXrlMirror
    : public    ServiceBase,
      protected IfMgrXrlMirrorRouterObserver,
      protected IfMgrHintObserver
{
public:
    typedef IfMgrCommandSinkBase::Cmd Cmd;

public:
    IfMgrXrlMirror(EventLoop&   e,
           const char*  rtarget,
           IPv4     finder_addr,
           uint16_t finder_port);

    IfMgrXrlMirror(EventLoop&   e,
           const char*  rtarget,
           const char*  finder_hostname,
           uint16_t finder_port);

    ~IfMgrXrlMirror();

    int startup();

    int shutdown();

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

    bool attach_hint_observer(IfMgrHintObserver* o);

    bool detach_hint_observer(IfMgrHintObserver* o);

    void delay_updates(const TimeVal& delay);

protected:
    void finder_ready_event();
    void finder_disconnect_event();
    void register_with_ifmgr();
    void unregister_with_ifmgr();

protected:
    void tree_complete();
    void updates_made();

protected:
    void register_cb(const XrlError& e);
    void unregister_cb(const XrlError& e);

protected:
    EventLoop&          _e;
    IPv4            _finder_addr;
    string          _finder_hostname;
    uint16_t            _finder_port;
    IfMgrIfTree         _iftree;
    IfMgrCommandDispatcher  _dispatcher;
    string          _rtarget;   // registration target (ifmgr)

    IfMgrXrlMirrorRouter*   _rtr;
    IfMgrXrlMirrorTarget*   _xrl_tgt;

    list<IfMgrHintObserver*>    _hint_observers;

    XorpTimer           _reg_timer; // registration timer

private:
    void do_updates();

    TimeVal         _updates_delay;
    XorpTimer           _updates_timer;
};

#endif // __LIBFEACLIENT_XRL_IFMGR_MIRROR_HH__