link.hh

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

// 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 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/contrib/olsr/link.hh,v 1.3 2008/10/02 21:56:34 bms Exp $

#ifndef __OLSR_LINK_HH__
#define __OLSR_LINK_HH__

class Neighbor;
class Neighborhood;

class LogicalLink {
  public:
    LogicalLink(Neighborhood* tm,
     EventLoop& eventloop,
     const OlsrTypes::LogicalLinkID id,
     const TimeVal& vtime,
     const IPv4& remote_addr,
     const IPv4& local_addr);

    inline OlsrTypes::LogicalLinkID id() const { return _id; }

    inline OlsrTypes::NeighborID neighbor_id() const { return _neighborid; }

    inline void set_neighbor_id(OlsrTypes::NeighborID neighborid) {
    _neighborid = neighborid;
    }

    inline Neighbor* destination() const {
    XLOG_ASSERT(0 != _destination); // Pilot error if we get here.
    return _destination;
    }

    inline void set_destination(Neighbor* n) { _destination = n; }

    inline OlsrTypes::FaceID faceid() const { return _faceid; }

    inline void set_faceid(OlsrTypes::FaceID faceid) {
    _faceid = faceid;
    }

    inline IPv4 local_addr() const { return _local_addr; }

    inline IPv4 remote_addr() const { return _remote_addr; }

    inline double near_etx() const { return _near_etx; }

    inline double far_etx() const { return _far_etx; }

    void update_timers(const TimeVal& vtime,
               bool saw_self = false,
               const LinkCode lc = LinkCode());

    OlsrTypes::LinkType link_type() const;

    inline bool is_sym() const {
    return link_type() == OlsrTypes::SYM_LINK;
    }

    inline TimeVal sym_time_remaining() const {
    TimeVal tv;
    _sym_timer.time_remaining(tv);
    return tv;
    }

    inline TimeVal asym_time_remaining() const {
    TimeVal tv;
    _asym_timer.time_remaining(tv);
    return tv;
    }

    inline TimeVal time_remaining() const {
    TimeVal tv;
    _dead_timer.time_remaining(tv);
    return tv;
    }

    inline bool pending() const { return _is_pending; }

    void event_sym_timer();

    void event_asym_timer();

    void event_lost_timer();

    void event_dead_timer();

  private:
    Neighborhood*   _nh;
    EventLoop&      _eventloop;

    OlsrTypes::LogicalLinkID        _id;

    OlsrTypes::FaceID       _faceid;

    OlsrTypes::NeighborID   _neighborid;

    Neighbor*           _destination;

    IPv4            _remote_addr;

    IPv4            _local_addr;

    //
    // Link state timers.
    //

    XorpTimer           _sym_timer;

    XorpTimer           _asym_timer;

    XorpTimer           _lost_timer;

    XorpTimer           _dead_timer;

    //
    // Link etx fields.
    //

    bool            _is_pending;

    double          _near_etx;

    double          _far_etx;
};

#endif // __OLSR_LINK_HH__