class Ospf

Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

•  Ospf (OspfTypes::Version version, EventLoop& eventloop, IO<A>* io)
• OspfTypes::Version  version ()
• bool  running ()
• ProcessStatus  status (string& reason)
• void  shutdown ()
• bool  transmit (const string& interface, const string& vif, A dst, A src, int ttl, uint8_t* data, uint32_t len)
• void  receive (const string& interface, const string& vif, A dst, A src, uint8_t* data, uint32_t len)
• bool  enable_interface_vif (const string& interface, const string& vif)
• bool  disable_interface_vif (const string& interface, const string& vif)
• bool  enabled (const string& interface, const string& vif)
• bool  enabled (const string& interface, const string& vif, A address)
• void  register_vif_status (typename IO<A>::VifStatusCb cb)
• void  register_address_status (typename IO<A>::AddressStatusCb cb)
• bool  get_addresses (const string& interface, const string& vif, list<A>& addresses) const
• bool  get_link_local_address (const string& interface, const string& vif, A& address)
• bool  get_interface_id (const string& interface, const string& vif, uint32_t& interface_id)
• bool  get_interface_vif_by_interface_id (uint32_t interface_id, string& interface, string& vif)
• bool  get_prefix_length (const string& interface, const string& vif, A address, uint16_t& prefix_length)
• uint32_t  get_mtu (const string& interface)
• bool  join_multicast_group (const string& interface, const string& vif, A mcast)
• bool  leave_multicast_group (const string& interface, const string& vif, A mcast)
• bool  set_hello_interval (const string& interface, const string& vif, OspfTypes::AreaID area, uint16_t hello_interval)
• bool  set_options (const string& interface, const string& vif, OspfTypes::AreaID area, uint32_t options)
• bool  create_virtual_link (OspfTypes::RouterID rid)
• bool  delete_virtual_link (OspfTypes::RouterID rid)
• bool  transit_area_virtual_link (OspfTypes::RouterID rid, OspfTypes::AreaID transit_area)
• bool  set_router_priority (const string& interface, const string& vif, OspfTypes::AreaID area, uint8_t priority)
• bool  set_router_dead_interval (const string& interface, const string& vif, OspfTypes::AreaID area, uint32_t router_dead_interval)
• bool  set_interface_cost (const string& interface, const string& vif, OspfTypes::AreaID area, uint16_t interface_cost)
• bool  set_retransmit_interval (const string& interface, const string& vif, OspfTypes::AreaID area, uint16_t retransmit_interval)
• bool  set_inftransdelay (const string& interface, const string& vif, OspfTypes::AreaID area, uint16_t inftransdelay)
• bool  set_simple_authentication_key (const string& interface, const string& vif, OspfTypes::AreaID area, const string& password, string& error_msg)
• bool  delete_simple_authentication_key (const string& interface, const string& vif, OspfTypes::AreaID area, string& error_msg)
• bool  set_md5_authentication_key (const string& interface, const string& vif, OspfTypes::AreaID area, uint8_t key_id, const string& password, const TimeVal& start_timeval, const TimeVal& end_timeval, const TimeVal& max_time_drift, string& error_msg)
• bool  delete_md5_authentication_key (const string& interface, const string& vif, OspfTypes::AreaID area, uint8_t key_id, string& error_msg)
• bool  set_passive (const string& interface, const string& vif, OspfTypes::AreaID area, bool passive, bool host)
• bool  originate_default_route (OspfTypes::AreaID area, bool enable)
• bool  stub_default_cost (OspfTypes::AreaID area, uint32_t cost)
• bool  summaries (OspfTypes::AreaID area, bool enable)
• bool  set_ip_router_alert (bool alert)
• bool  area_range_add (OspfTypes::AreaID area, IPNet<A> net, bool advertise)
• bool  area_range_delete (OspfTypes::AreaID area, IPNet<A> net)
• bool  area_range_change_state (OspfTypes::AreaID area, IPNet<A> net, bool advertise)
• bool  get_lsa (const OspfTypes::AreaID area, const uint32_t index, bool& valid, bool& toohigh, bool& self, vector<uint8_t>& lsa)
• bool  get_area_list (list<OspfTypes::AreaID>& areas) const
• bool  get_neighbour_list (list<OspfTypes::NeighbourID>& neighbours) const
• bool  get_neighbour_info (OspfTypes::NeighbourID nid, NeighbourInfo& ninfo) const
• bool  clear_database ()
• bool  add_route (IPNet<A> net, A nexthop, uint32_t nexthop_id, uint32_t metric, bool equal, bool discard, const PolicyTags& policytags)
• bool  replace_route (IPNet<A> net, A nexthop, uint32_t nexthop_id, uint32_t metric, bool equal, bool discard, const PolicyTags& policytags)
• bool  delete_route (IPNet<A> net)
• void  configure_filter (const uint32_t& filter, const string& conf)
• void  reset_filter (const uint32_t& filter)
• void  push_routes ()
• bool  originate_route (const IPNet<A>& net, const A& nexthop, const uint32_t& metric, const PolicyTags& policytags)
• bool  withdraw_route (const IPNet<A>& net)
• OspfTypes::Version  get_version () const
• EventLoop&  get_eventloop ()
• void  set_testing (bool testing)
• bool  get_testing () const
• PeerManager<A>&  get_peer_manager ()
• RoutingTable<A>&  get_routing_table ()
• LsaDecoder&  get_lsa_decoder ()
• PolicyFilters&  get_policy_filters ()
• uint8_t  get_instance_id () const
• void  set_instance_id (uint8_t instance_id)
• OspfTypes::RouterID  get_router_id () const
• void  set_router_id (OspfTypes::RouterID id)
• bool  get_rfc1583_compatibility () const
• void  set_rfc1583_compatibility (bool compatibility)
• Trace&  trace ()

Detailed Description

Returns: version of OSPF this implementation represents.

Returns: true if ospf should still be running.

Status of process.

Shutdown OSPF.

Used to send traffic on the IO interface.

The callback method that is called when data arrives on the IO interface.

Enable the interface/vif to receive frames.

Disable this interface/vif from receiving frames.

Is this interface/vif enabled? This is a question asked of the FEA, has the interface/vif been marked as up.

Returns: true if it is.

Is this interface/vif/address enabled? This is a question asked of the FEA, has the interface/vif been marked as up.

Returns: true if it is.

Add a callback for tracking the interface/vif status.

The callback will be invoked whenever the status of the tuple (interface, vif) is changed from disabled to enabled or vice-versa.

Parameters:

Add a callback for tracking the interface/vif/address status.

The callback will be invoked whenever the status of the tuple (interface, vif, address) is changed from disabled to enabled or vice-versa.

Parameters:

[const]

Get all addresses associated with this interface/vif.

Parameters:

Returns: true if there are no errors.

Get a link local address for this interface/vif if available.

Parameters:

Returns: true if a link local address is available.

Get the interface ID required for OSPFv3. The vif argument is required for virtual links.

Given an interface ID return the interface and vif.

Returns: prefix length for this address.

Returns: the mtu for this interface.

On the interface/vif join this multicast group.

On the interface/vif leave this multicast group.

Set the hello interval in seconds.

Set options.

Create a virtual link

Parameters:

Delete a virtual link

Parameters:

Attach this transit area to the neighbours router ID.

Set router priority.

Set the router dead interval in seconds.

Set the interface cost.

Set the RxmtInterval.

Set InfTransDelay

Set a simple password authentication key.

Note that the current authentication handler is replaced with a simple password authentication handler.

Parameters:

Returns: true on success, otherwise false.

Delete a simple password authentication key.

Note that after the deletion the simple password authentication handler is replaced with a Null authentication handler.

Parameters:

Returns: true on success, otherwise false.

Set an MD5 authentication key.

Note that the current authentication handler is replaced with an MD5 authentication handler.

Parameters:

Returns: true on success, otherwise false.

Delete an MD5 authentication key.

Note that after the deletion if there are no more valid MD5 keys, the MD5 authentication handler is replaced with a Null authentication handler.

Parameters:

Returns: true on success, otherwise false.

Toggle the passive status of an interface.

If this is a "stub" or "nssa" area toggle the sending of a default route.

Set the StubDefaultCost, the default cost sent in a default route in a "stub" or "nssa" area.

Toggle the sending of summaries into "stub" or "nssa" areas.

Send router alerts in IP packets or not.

Add area range.

Delete area range.

Change the advertised state of this area.

Get a single lsa from an area. A stateless mechanism to get LSAs. The client of this interface should start from zero and continue to request LSAs (incrementing index) until toohigh becomes true.

Parameters:

[const]

Get a list of all the configured areas.

[const]

Get a list of all the neighbours.

[const]

Get state information about this neighbour.

Parameters:

Clear the database.

Add route

Parameters:

Replace route

Parameters:

Delete route

Configure a policy filter

Parameters:

Reset a policy filter.

Parameters:

Push routes through policy filters for re-filtering.

Originate a route.

Parameters:

Returns: true on success

Withdraw a route.

Parameters:

Returns: true on success

[const]

Get the current OSPF version.

Returns: a reference to the eventloop, required for timers etc...

The test status of OSPF.

[const]

Returns: true if OSPF is being tested.

Returns: a reference to the PeerManager.

Returns: a reference to the RoutingTable.

Returns: a reference to the LSA decoder.

Returns: a reference to the policy filters

[const]

Get the Instance ID.

Set the Instance ID.

[const]

Get the Router ID.

Set the Router ID.

[const]

Get RFC 1583 compatibility.

Set RFC 1583 compatibility.