class PeerManager Peer Manager: 1) Monitor the state of the interfaces. More...

Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

•  PeerManager (Ospf<A>& ospf)
•  ~PeerManager ()
• bool  check_area_type (OspfTypes::AreaID area, OspfTypes::AreaType area_type)
• bool  create_area_router (OspfTypes::AreaID area, OspfTypes::AreaType area_type, bool permissive = true)
• AreaRouter<A> * get_area_router (OspfTypes::AreaID area)
• bool  change_area_router_type (OspfTypes::AreaID area, OspfTypes::AreaType area_type)
• bool  destroy_area_router (OspfTypes::AreaID area)
• 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
• OspfTypes::PeerID  get_peerid (const string& interface, const string& vif)
• bool  get_interface_vif_by_peerid (OspfTypes::PeerID peerid, string& interface, string& vif) const
• OspfTypes::PeerID  create_peer (const string& interface, const string& vif, A source, OspfTypes::LinkType linktype, OspfTypes::AreaID area)
• bool  delete_peer (const OspfTypes::PeerID)
• bool  set_state_peer (const OspfTypes::PeerID, bool state)
• bool  set_link_status_peer (const OspfTypes::PeerID, bool state)
• bool  add_address_peer (const string& interface, const string& vif, OspfTypes::AreaID area, A addr)
• bool  remove_address_peer (const OspfTypes::PeerID, OspfTypes::AreaID area, A addr)
• bool  set_address_state_peer (const OspfTypes::PeerID, OspfTypes::AreaID area, A addr, bool enable)
• bool  activate_peer (const string& interface, const string& vif, OspfTypes::AreaID area)
• bool  update_peer (const string& interface, const string& vif, OspfTypes::AreaID area)
• bool  recompute_addresses_peer (const OspfTypes::PeerID, OspfTypes::AreaID area)
• void  address_status_change (const string& interface, const string& vif, A source, bool state)
• bool  add_neighbour (const OspfTypes::PeerID, OspfTypes::AreaID area, A neighbour_address, OspfTypes::RouterID)
• bool  remove_neighbour (const OspfTypes::PeerID, OspfTypes::AreaID area, A neighbour_address, OspfTypes::RouterID rid)
• bool  transmit (const string& interface, const string& vif, A dst, A src, uint8_t* data, uint32_t len)
• bool  receive (const string& interface, const string& vif, A dst, A src, Packet *packet)
• bool  queue_lsa (const OspfTypes::PeerID peerid, const OspfTypes::PeerID peer, OspfTypes::NeighbourID nid, Lsa::LsaRef lsar, bool &multicast_on_peer)
• bool  push_lsas (const OspfTypes::PeerID peerid)
• uint32_t  get_interface_id (const OspfTypes::PeerID peerid)
• bool  configured_network (const A address) const
• bool  known_interface_address (const A address) const
• bool  neighbours_exchange_or_loading (const OspfTypes::PeerID peerid, OspfTypes::AreaID area)
• bool  neighbour_at_least_two_way (const OspfTypes::PeerID peerid, OspfTypes::AreaID area, OspfTypes::RouterID rid, bool& twoway)
• bool  get_neighbour_address (const OspfTypes::PeerID peerid, OspfTypes::AreaID area, OspfTypes::RouterID rid, uint32_t interface_id, A& neighbour_address)
• bool  on_link_state_request_list (const OspfTypes::PeerID peerid, OspfTypes::AreaID area, const OspfTypes::NeighbourID nid, Lsa::LsaRef lsar)
• bool  event_bad_link_state_request (const OspfTypes::PeerID peerid, OspfTypes::AreaID area, const OspfTypes::NeighbourID nid)
• bool  send_lsa (const OspfTypes::PeerID peerid, OspfTypes::AreaID area, const OspfTypes::NeighbourID nid, Lsa::LsaRef lsar)
• void  adjacency_changed (const OspfTypes::PeerID peerid, OspfTypes::RouterID rid, bool up)
• void  area_border_router_transition (bool up) const
• void  refresh_router_lsas () const
• bool  create_virtual_peer (OspfTypes::RouterID rid)
• bool  delete_virtual_peer (OspfTypes::RouterID rid)
• bool  virtual_link_endpoint (OspfTypes::AreaID area) const
• bool  create_virtual_link (OspfTypes::RouterID rid)
• bool  transit_area_virtual_link (OspfTypes::RouterID rid, OspfTypes::AreaID transit_area)
• bool  delete_virtual_link (OspfTypes::RouterID rid)
• void  up_virtual_link (OspfTypes::RouterID rid, A source, uint16_t interface_cost, A destination)
• void  down_virtual_link (OspfTypes::RouterID rid)
• bool  receive_virtual_link (A dst, A src, Packet *packet)
• uint32_t  area_count (OspfTypes::AreaType area_type) const
• bool  internal_router_p () const
• bool  area_border_router_p () const
• bool  backbone_router_p () const
• bool  as_boundary_router_p () const
• uint32_t  compute_options (OspfTypes::AreaType area_type)
• void  router_id_changing ()
• bool  set_options (const PeerID, OspfTypes::AreaID area, uint32_t options)
• bool  set_interface_address (const OspfTypes::PeerID, A address)
• bool  set_hello_interval (const OspfTypes::PeerID, OspfTypes::AreaID area, uint16_t hello_interval)
• bool  set_router_priority (const OspfTypes::PeerID, OspfTypes::AreaID area, uint8_t priority)
• bool  set_router_dead_interval (const OspfTypes::PeerID, OspfTypes::AreaID area, uint32_t router_dead_interval)
• bool  set_interface_cost (const OspfTypes::PeerID, OspfTypes::AreaID area, uint16_t interface_cost)
• bool  set_retransmit_interval (const OspfTypes::PeerID, OspfTypes::AreaID area, uint16_t retransmit_interval)
• bool  set_inftransdelay (const OspfTypes::PeerID, OspfTypes::AreaID area, uint16_t inftransdelay)
• bool  set_simple_authentication_key (const OspfTypes::PeerID peerid, OspfTypes::AreaID area, const string& password, string& error_msg)
• bool  delete_simple_authentication_key (const OspfTypes::PeerID peerid, OspfTypes::AreaID area, string& error_msg)
• bool  set_md5_authentication_key (const OspfTypes::PeerID peerid, 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 OspfTypes::PeerID peerid, OspfTypes::AreaID area, uint8_t key_id, string& error_msg)
• bool  set_passive (const OspfTypes::PeerID, OspfTypes::AreaID area, bool passive)
• 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)
• size_t  number_of_areas () const
• void  summary_announce (OspfTypes::AreaID area, IPNet<A> net, RouteEntry<A>& rt)
• void  summary_withdraw (OspfTypes::AreaID area, IPNet<A> net, RouteEntry<A>& rt)
• void  summary_push (OspfTypes::AreaID area)
• bool  area_range_covered (OspfTypes::AreaID area, IPNet<A> net, bool& advertise)
• bool  area_range_configured (OspfTypes::AreaID area)
• bool  external_announce (OspfTypes::AreaID area, Lsa::LsaRef lsar)
• bool  external_announce (const IPNet<A>& net, const A& nexthop, const uint32_t& metric, const PolicyTags& policytags)
• bool  external_withdraw (OspfTypes::AreaID area, Lsa::LsaRef lsar)
• bool  external_withdraw (const IPNet<A>& net)
• bool  external_shove (OspfTypes::AreaID area)
• void  external_push (OspfTypes::AreaID area)
• void  external_push_routes ()
• void  routing_recompute_all_areas ()
• void  routing_recompute_all_transit_areas ()

Detailed Description

Peer Manager: 1) Monitor the state of the interfaces. An interface going up/down will be monitored and trigger either adjacency attempts or new (withdraw) LSAs. 2) Manage interface configuration state. Control peers and area state. 3) Accept incoming hello's and demultiplex to the correct peer. 4) Manage the set of peers (peers are bound to interface and area). The peers themselves are hidden and are only exposed by reference (PeerID).

Check area type.

Verify that this area can be set to this area type.

Create an area router.

Parameters:

Change the type of this area.

Destroy an area router.

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:

Convert an interface/vif to a PeerID. Throw an exception if no mapping is found.

[const]

Given a PeerID convert it back to an interface and vif.

Create a peer.

Parameters:

Returns: PeerID on success otherwise throw an exception.

Delete a peer.

Take a peer up or down.

Set the link status of the peer.

Add an address to this peer OSPFv3 only.

Remove an address from this peer OSPFv3 only.

Set the state of the address on this peer OSPFv3 only.

Activate this peer OSPFv3 only. Called once after the peer is created and every time a new address is added, but not when an address is deleted.

Update this peer OSPFv3 only. Called every time a variable related to this peer is changed.

Update this peer OSPFv3 only. Reset the addresses that should be advertised by this peer.

Track the state of an address. Callback when the status of the address changes.

Add a neighbour to the peer.

Remove a neighbour from the peer.

Transmit packets

Demultiplex incoming packets to the associated peer. If the packet contains LSAs send it to the LSA database manager if appropriate.

Parameters:

Returns: true if the packet is now owned by the peer manager.

Queue an LSA for transmission.

Parameters:

Returns: true on success.

Send (push) any queued LSAs.

Get the interface ID of this peer OSPFv3 only.

[const]

[const]

Are any of the neighbours of this peer in the state exchange or loading.

Returns: true if any of the neighbours are in state exchange or loading.

Is the state of the neighbour with the specified Router ID at least 2-Way.

Parameters:

Returns: true if the neighbour is found.

Neighbour's source address.

Parameters:

Returns: true if the neighbour is found.

Is this LSA on this neighbours link state request list.

Returns: true if it is.

Generate a BadLSReq event.

Returns: true if it is.

Send this LSA directly to the neighbour. Do not place on retransmission list.

Returns: true on success

Upcall from a peer to notify the peer manager that a full adjacency has been achieved or lost.

Parameters:

[const]

Track border router transitions.

Parameters:

[const]

Send a new Router-LSA in all areas.

Typically called when one of the Router-LSA flags changes state.

Create a virtual link peer.

Delete a virtual link peer.

[const]

Are any of neighbours of this area a virtual link endpoint.

Returns: true if any are.

Create a virtual link (Configuration).

Parameters:

Attach this transit area to the neighbours router ID (Configuration).

Delete a virtual link (Configuration).

Parameters:

Bring virtual link up (Upcall from area router).

Parameters:

Take this virtual link down (Upcall from area router).

A packet was sent to a peer that rejected it so this may be a virtual link candidate.

[const]

Return the number of areas of the specified type.

[const]

Is this an internal router?

[const]

Is this an area border router?

[const]

Is this a backbone router?

[const]

Is this an AS boundary router?

Compute the options that are sent in hello packets, data description packets, LSA headers (OSPFv2), Router-LSAs (OSPFv3) and Network-LSAs (OSPFv3).

The router ID is about to change.

Set options.

Set the interface address of this peer.

Set the hello interval in seconds.

Set router priority.

Set the router dead interval in seconds.

Set interface cost

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

[const]

Number of areas this router serves.

A new route has been added to the routing table announce it to all areas as it is a candidate for Summary-LSA generation.

Parameters:

A route has been deleted from the routing table. It may previously have caused a Summary-LSA which now needs to be withdrawn.

Parameters:

Send all the summary information to specified area. New areas or stub areas that change from do not advertise can use this hook to force all routes to be sent to the specified area.

Parameters:

In the specified area is the net covered by an area range.

Parameters:

Returns: true if the area is covered.

Does the specified area have any area ranges configured.

The primary purpose is to discover if the backbone area has any area ranges configured, this is required when an area becomes a transit area.

An AS-External-LSA has arrived from this area announce it to all others.

The LSAs should not be scheduled for transmission until the external_shove() is seen. In many cases a number of LSAs may arrive in a single packet, waiting for the external_shove() offers an opportunity for aggregation.

Create an AS-External-LSA and announce it to all appropriate areas.

An AS-External-LSA is being withdrawn from this area withdraw from all others.

Withdraw a previously createed and announced AS-External-LSA from all areas.

Called to complete a series of calls to external_announce(area).

When a new area is configured it can use this method to

Parameters:

Re-run the policy filters on all routes.

Recompute routing calculation all areas BACKBONE first.

Recompute routing calculation for all transit areas.