class Peer A peer represents a single area and is bound to a PeerOut. More...

Annotated List  Files  Globals  Hierarchy  Index  Top

Public Types

• enum InterfaceState { Down, Loopback, Waiting, Point2Point, DR_other, Backup, DR, }

Public Methods

•  Peer (Ospf<A>& ospf, PeerOut<A>& peerout, OspfTypes::AreaID area_id, OspfTypes::AreaType area_type)
•  ~Peer ()
• bool  init ()
• bool  shutdown ()
• bool  go ()
• bool  initV3 ()
• bool  goV3 ()
• bool  shutdownV3 ()
• void  populate_link_lsa ()
• bool  match (IPv6 source) const
• string  get_if_name () const
• OspfTypes::PeerID  get_peerid () const
• A  get_interface_address () const
• uint16_t  get_interface_prefix_length () const
• A  get_p2p_neighbour_address () const
• uint16_t  get_interface_mtu () const
• uint16_t  get_frame_size () const
• uint16_t  get_inftransdelay () const
• bool  transmit (typename Transmit<A>::TransmitRef tr)
• bool  add_neighbour (A neighbour_address, OspfTypes::RouterID rid)
• bool  remove_neighbour (A neighbour_address, OspfTypes::RouterID rid)
• bool  belongs (A addr) const
• bool  receive (A dst, A src, Packet *packet)
• bool  accept_lsa (Lsa::LsaRef lsar) const
• bool  send_lsa (const OspfTypes::NeighbourID nid, Lsa::LsaRef lsar) const
• bool  queue_lsa (OspfTypes::PeerID peerid, OspfTypes::NeighbourID nid, Lsa::LsaRef lsar, bool& multicast_on_peer) const
• bool  push_lsas ()
• bool  do_dr_or_bdr () const
• bool  is_DR () const
• bool  is_BDR () const
• bool  is_DR_or_BDR () const
• bool  neighbours_exchange_or_loading () const
• bool  neighbour_at_least_two_way (OspfTypes::RouterID rid, bool& twoway)
• bool  get_neighbour_address (OspfTypes::RouterID rid, uint32_t interface_id, A& neighbour_address)
• bool  on_link_state_request_list (const OspfTypes::NeighbourID nid, Lsa::LsaRef lsar) const
• bool  event_bad_link_state_request (const OspfTypes::NeighbourID nid) const
• bool  virtual_link_endpoint () const
• void  send_direct_acks (OspfTypes::NeighbourID nid, list<Lsa_header>& ack)
• void  send_delayed_acks (OspfTypes::NeighbourID nid, list<Lsa_header>& ack)
• Neighbour<A> * find_neighbour (A src, OspfTypes::RouterID rid)
• bool  is_neighbour_DR_or_BDR (OspfTypes::NeighbourID nid) const
• bool  process_hello_packet (A dst, A src, HelloPacket *hello)
• bool  process_data_description_packet (A dst, A src, DataDescriptionPacket *dd)
• bool  process_link_state_request_packet (A dst, A src, LinkStateRequestPacket *lsrp)
• bool  process_link_state_update_packet (A dst, A src, LinkStateUpdatePacket *lsup)
• bool  process_link_state_acknowledgement_packet (A dst, A src, LinkStateAcknowledgementPacket *lsap)
• void  start ()
• void  stop ()
• void  change_area_router_type (OspfTypes::AreaType area_type)
• void  event_interface_up ()
• void  event_wait_timer ()
• void  event_backup_seen ()
• void  event_neighbour_change ()
• void  event_loop_ind ()
• void  event_unloop_ind ()
• void  event_interface_down ()
• void  schedule_event (const char *)
• void  process_scheduled_events ()
• AreaRouter<A> * get_area_router ()
• OspfTypes::RouterID  get_candidate_id (A = A::ZERO()) const
• InterfaceState  get_state () const
• OspfTypes::LinkType  get_linktype () const
• Auth&  get_auth_handler ()
• uint32_t  send_options ()
• void  populate_common_header (Packet& packet)
• OspfTypes::AreaID  get_area_id () const
• OspfTypes::AreaType  get_area_type () const
• void  set_area_type (OspfTypes::AreaType area_type)
• void  router_id_changing ()
• bool  set_network_mask (uint32_t network_mask)
• uint32_t  get_network_mask () const
• bool  set_interface_id (uint32_t interface_id)
• uint32_t  get_interface_id () const
• bool  add_advertise_net (A addr, uint32_t prefix)
• bool  remove_all_nets ()
• bool  update_nets ()
• bool  set_hello_interval (uint16_t hello_interval)
• bool  set_options (uint32_t options)
• uint32_t  get_options () const
• bool  set_router_priority (uint8_t priority)
• bool  set_router_dead_interval (uint32_t router_dead_interval)
• uint32_t  get_router_dead_interval () const
• bool  set_simple_authentication_key (const string& password, string& error_msg)
• bool  delete_simple_authentication_key (string& error_msg)
• bool  set_md5_authentication_key (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 (uint8_t key_id, string& error_msg)
• bool  set_passive (bool passive, bool host)
• bool  get_passive () const
• bool  set_rxmt_interval (uint32_t rxmt_interval)
• uint32_t  get_rxmt_interval ()
• OspfTypes::RouterID  get_designated_router () const
• OspfTypes::RouterID  get_backup_designated_router () const
• uint32_t  get_designated_router_interface_id (A = A::ZERO()) const
• void  update_router_links ()
• void  adjacency_change (bool up)
• bool  get_neighbour_list (list<OspfTypes::NeighbourID>& neighbours) const
• bool  get_neighbour_info (OspfTypes::NeighbourID nid, NeighbourInfo& ninfo) const
• set<AddressInfo<A> >&  get_address_info ()
• bool  get_attached_routers (list<RouterInfo>& routers)

Public Static Methods

• static OspfTypes::RouterID  get_candidate_id (A, OspfTypes::RouterID)
• static string  pp_interface_state (InterfaceState is)

Detailed Description

A peer represents a single area and is bound to a PeerOut.

Interface as defined by OSPF not XORP.

Should be invoked just once.

Will only execute if go() has been called. Can be called multiple times paired with go().

Called once the peer is configured and enabled. Can be called multiple times paired with shutdown().

OSPFv3 specific initialisation.

OSPFv3 specific go

OSPFv3 specific shutdown

[const]

If the source address matches a global address return true.

[const]

For debugging only printable rendition of this interface/vif.

[const]

Get Peer ID.

[const]

Address of this interface/vif.

Returns: interface/vif address.

[const]

Returns: prefix length of this interface.

[const]

Address of the p2p neighbour.

Returns: p2p neighbour address.

[const]

Returns: mtu of this interface.

[const]

The maximum size of an OSPF frame, the MTU minus the IP header. Also include any bytes that the authentication scheme may use.

Returns: maximum frame size.

[const]

Returns: InfTransDelay

Used by external and internal entities to transmit packets.

Add neighbour

Remove neighbour

[const]

Address belongs to this router used for destination address validation.

Packets for this peer are received here.

[const]

Used to test if an lsa should be accepted for this peer/neighbour. Specifically to deal with the case that AS-External-LSAs should not be sent on virtual links.

[const]

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.

[const]

[const]

Returns: true if this router is the DR.

[const]

Returns: true if this router is the BDR.

[const]

Returns: true if this router is the DR or BDR.

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

Get the state of the neighbour with the specified router ID.

Parameters:

Returns: true if the neighbour is found.

Neighbour's source address.

Parameters:

Returns: true if the neighbour is found.

[const]

Is this LSA on this neighbours link state request list.

Returns: true if it is.

[const]

Generate a BadLSReq event.

[const]

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

Returns: true if any are.

Send direct ACKs

Parameters:

Send delayed ACKs

Parameters:

[const]

Returns: true if this routers neighbour is the DR or BDR.

Process a hello packet.

Process a data description packet.

Process a link state request packet.

Process a link state update packet.

Process a link state acknowledgement packet.

Start the protocol machinery running

Stop the protocol machinery running

Change the type of this area.

Event: InterfaceUP

Event: WaitTimer

Event: BackupSeen

Event: NeighborChange

Event: LoopInd

Event: UnLoopInd

Event: InterfaceDown

Schedule an event, used by the neighbours to schedule an interface event.

Run all the deferred events, callback method.

Get the area router.

[static]

Returns: the value that should be used for DR or BDR. In OSPFv2 its the source address of the interface. In OSPFv3 its the router ID.

[const]

Returns: the value that should be used for DR or BDR for this router In OSPFv2 its the source address of the interface. In OSPFv3 its the router ID. A dummy argument is used to force an IPv4 and an IPv6 instance of this method to be generated. Isn't C++ cool?

[const]

[const]

Returns: the link type.

Return the authentication handler.

Returns: the options field that is placed in some of outgoing packets.

Fill in the common header parts of the packet.

[static]

Pretty print the interface state.

[const]

Returns: the Area ID.

[const]

Returns: the Area Type.

Returns: the Area Type.

The router ID is about to change.

Set the network mask OSPFv2 only.

[const]

Set the network mask OSPFv2 only.

Set the interface ID OSPFv3 only.

[const]

Get the interface ID OSPFv3 only.

Set a network to advertise OSPFv3 only.

Remove all the networks that are being advertised OSPFv3 only.

Calls to add_advertise_net() and remove_all_nets() must be followed by a call to update nets to force a new Link-LSA to be sent out OSPFv3 only.

Set the hello interval in seconds.

Set options.

[const]

Get options.

Set router priority.

Set the router dead interval in seconds.

[const]

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

[const]

If all peers are in state passive then return passive.

Set RxmtInterval.

Get RxmtInterval.

[const]

Get the designated router.

[const]

Get the backup designated router.

[const]

Get the interface ID of the designated router. OSPFv3 only.

Compute the current router link.

Typically called after a state transition.

Used to notify the peer that a neighbour has become fully adjacent or a neighbour is no longer fully adjacent. Used to trigger the generation or withdrawal of a network-LSA. Should only be called if the interface is in state DR.

Parameters:

[const]

Get a list of all the neighbours.

[const]

Get state information about this neighbour.

Parameters:

Get this list of addresses that should be advertised OSPFv3 only.

Return a list of the fully adjacent routers.