class PeerOut In OSPF terms this class represents an interface/link; interface is too overloaded a term. More...

Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

•  PeerOut (Ospf<A>& ospf, const string interface, const string vif, PeerID peerid, const A source, const uint16_t prefix_length, const uint16_t interface_mtu, OspfTypes::LinkType linktype, OspfTypes::AreaID area, OspfTypes::AreaType area_type)
•  ~PeerOut ()
• string  get_if_name () const
• bool  match (A source, string& interface, string& vif)
• PeerID  get_peerid () const
• bool  set_interface_address (A interface_address)
• A  get_interface_address () const
• uint16_t  get_interface_prefix_length () const
• uint16_t  get_interface_mtu () const
• uint16_t  get_frame_size () const
• void  join_multicast_group (A address)
• void  leave_multicast_group (A address)
• uint16_t  get_interface_cost () const
• uint16_t  get_inftransdelay () const
• bool  add_area (OspfTypes::AreaID area, OspfTypes::AreaType area_type)
• bool  change_area_router_type (OspfTypes::AreaID area, OspfTypes::AreaType area_type)
• bool  remove_area (OspfTypes::AreaID area)
• bool  add_neighbour (OspfTypes::AreaID area, A neighbour_address, OspfTypes::RouterID)
• bool  remove_neighbour (OspfTypes::AreaID area, A neighbour_address, OspfTypes::RouterID rid)
• void  set_state (bool state)
• bool  get_state () const
• void  set_link_status (bool status)
• void  peer_change ()
• bool  transmit (typename Transmit<A>::TransmitRef tr)
• bool  receive (A dst, A src, Packet *packet)
• bool  send_lsa (OspfTypes::AreaID area, const OspfTypes::NeighbourID nid, Lsa::LsaRef lsar)
• bool  queue_lsa (PeerID peerid, OspfTypes::NeighbourID nid, Lsa::LsaRef lsar, bool &multicast_on_peer) const
• bool  push_lsas ()
• bool  neighbours_exchange_or_loading (OspfTypes::AreaID area)
• bool  on_link_state_request_list (OspfTypes::AreaID area, const OspfTypes::NeighbourID nid, Lsa::LsaRef lsar)
• bool  event_bad_link_state_request (OspfTypes::AreaID area, const OspfTypes::NeighbourID nid)
• bool  virtual_link_endpoint (OspfTypes::AreaID area)
• OspfTypes::LinkType  get_linktype () const
• void  router_id_changing ()
• bool  set_interface_id (OspfTypes::AreaID area, uint32_t interface_id)
• bool  set_hello_interval (OspfTypes::AreaID area, uint16_t hello_interval)
• bool  set_options (OspfTypes::AreaID area, uint32_t options)
• bool  set_router_priority (OspfTypes::AreaID area, uint8_t priority)
• bool  set_router_dead_interval (OspfTypes::AreaID area, uint32_t router_dead_interval)
• bool  set_simple_authentication_key (OspfTypes::AreaID area, const string& password, string& error_msg)
• bool  delete_simple_authentication_key (OspfTypes::AreaID area, string& error_msg)
• bool  set_md5_authentication_key (OspfTypes::AreaID area, uint8_t key_id, const string& password, uint32_t start_secs, uint32_t end_secs, string& error_msg)
• bool  delete_md5_authentication_key (OspfTypes::AreaID area, uint8_t key_id, string& error_msg)
• bool  set_passive (OspfTypes::AreaID area, bool passive)
• bool  set_interface_cost (uint16_t interface_cost)
• bool  set_retransmit_interval (OspfTypes::AreaID area, uint16_t retransmit_interval)
• bool  set_inftransdelay (uint16_t inftransdelay)
• bool  get_neighbour_list (list<OspfTypes::NeighbourID>& neighbours) const
• bool  get_neighbour_info (OspfTypes::NeighbourID nid, NeighbourInfo& ninfo) const

Detailed Description

In OSPF terms this class represents an interface/link; interface is too overloaded a term. The Peer class is also associated with an area. In OSPFv2 there is a one-to-one correspondence. In OSPFv3 an interface/link can belong to multiple areas.

Responsibilities: 1) Packet transmission; the outgoing queue lives here. 2) Exchange Hello packets. 3) Bring up adjacency, synchronize databases. 4) Elect designated and backup router.

[const]

For debugging only printable rendition of this interface/vif.

If the source address matches the interface address return the interface and vif.

[const]

Get Peer ID.

Set the address of this interface/vif

[const]

Address of this interface/vif.

Returns: interface/vif address.

[const]

Returns: prefix length of this interface.

[const]

Returns: mtu of this interface.

[const]

The maximum size of an OSPF frame, the MTU minus the IP header.

Returns: maximum frame size.

Join multicast group on this interface/vif.

Leave multicast group on this interface/vif.

[const]

Returns: cost of this interface.

[const]

Returns: InfTransDelay

Add another Area for this peer to be in, should only be allowed for OSPFv3.

Change the type of this area.

This area is being removed.

Returns: true if this peer is no longer associated with any areas. Allowing the caller to delete this peer.

Add a neighbour to the peer.

Remove a neighbour from the peer.

Set the state of this peer.

[const]

Get the state of this peer.

Set the link status. This is not only the link status but is the interface/vif/address configured up.

Dependent on the configured peer status and the link status decide if the peer should be brought up or taken down.

Used by external and internal entities to transmit packets.

Packets for this peer are received here.

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

Returns: true on success

[const]

Queue an LSA for transmission.

Parameters:

Returns: true on success.

Send (push) any queued LSAs.

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 this LSA on this neighbours link state request list.

Returns: true if it is.

Generate a BadLSReq event.

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

Returns: true if any are.

[const]

Returns: the link type.

The router ID is about to change.

Set the interface ID OSPFv3 only.

Set the hello interval in seconds.

Set options.

Set router priority.

Set the router dead interval in seconds.

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.

Set the interface cost.

Set RxmtInterval.

Set InfTransDelay.

[const]

Get a list of all the neighbours.

[const]

Get state information about this neighbour.

Parameters: