class Olsr An OLSR routing process. More...

Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

•  Olsr (EventLoop& eventloop, IO* io)
• inline bool  running ()
• ProcessStatus  status (string& reason)
• void  shutdown ()
• void  receive (const string& interface, const string& vif, IPv4 dst, uint16_t dport, IPv4 src, uint16_t sport, uint8_t* data, uint32_t len)
• bool  transmit (const string& interface, const string& vif, const IPv4& dst, const uint16_t& dport, const IPv4& src, const uint16_t& sport, uint8_t* data, const uint32_t& len)
• inline void  register_vif_status (IO::VifStatusCb cb)
• inline void  register_address_status (IO::AddressStatusCb cb)
• inline EventLoop&  get_eventloop ()
• inline FaceManager&  face_manager ()
• inline Neighborhood&  neighborhood ()
• inline TopologyManager&  topology_manager ()
• inline ExternalRoutes&  external_routes ()
• inline RouteManager&  route_manager ()
• inline bool  set_main_addr (const IPv4& addr)
• inline IPv4  get_main_addr ()
• inline bool  set_mpr_coverage (const uint32_t mpr_coverage)
• inline uint32_t  get_mpr_coverage ()
• inline bool  set_tc_redundancy (const uint32_t tc_redundancy)
• inline uint32_t  get_tc_redundancy ()
• inline bool  set_hello_interval (const TimeVal& interval)
• inline TimeVal  get_hello_interval ()
• inline bool  set_mid_interval (const TimeVal& interval)
• inline TimeVal  get_mid_interval ()
• inline bool  set_refresh_interval (const TimeVal& interval)
• inline TimeVal  get_refresh_interval ()
• inline bool  set_tc_interval (TimeVal interval)
• inline TimeVal  get_tc_interval ()
• inline bool  set_willingness (const OlsrTypes::WillType willingness)
• inline OlsrTypes::WillType  get_willingness ()
• inline bool  set_hna_interval (const TimeVal& interval)
• inline TimeVal  get_hna_interval ()
• inline bool  set_dup_hold_time (const TimeVal& interval)
• inline TimeVal  get_dup_hold_time ()
• bool  bind_address (const string& interface, const string& vif, const IPv4& local_addr, const uint32_t& local_port, const IPv4& all_nodes_addr, const uint32_t& all_nodes_port)
• bool  unbind_address (const string& interface, const string& vif)
• bool  enable_address (const string& interface, const string& vif, const IPv4& address, const uint16_t& port, const IPv4& all_nodes_address)
• bool  disable_address (const string& interface, const string& vif, const IPv4& address, const uint16_t& port)
• bool  set_interface_enabled (const string& interface, const string& vif, const bool enabled)
• bool  get_interface_enabled (const string& interface, const string& vif, bool& enabled)
• bool  get_interface_stats (const string& interface, const string& vif, FaceCounters& stats)
• inline bool  set_interface_cost (const string& interface, const string& vif, int cost)
• uint32_t  get_mtu (const string& interface)
• bool  get_broadcast_address (const string& interface, const string& vif, const IPv4& address, IPv4& bcast_address)
• bool  is_vif_broadcast_capable (const string& interface, const string& vif)
• bool  is_vif_multicast_capable (const string& interface, const string& vif)
• bool  add_route (IPv4Net net, IPv4 nexthop, uint32_t nexthop_id, uint32_t metric, const PolicyTags& policytags)
• bool  replace_route (IPv4Net net, IPv4 nexthop, uint32_t nexthop_id, uint32_t metric, const PolicyTags& policytags)
• bool  delete_route (IPv4Net net)
• void  configure_filter (const uint32_t& filter, const string& conf)
• void  reset_filter (const uint32_t& filter)
• void  push_routes ()
• bool  originate_external_route (const IPv4Net& net, const IPv4& nexthop, const uint32_t& metric, const PolicyTags& policytags)
• bool  withdraw_external_route (const IPv4Net& net)
• PolicyFilters&  get_policy_filters ()
• Trace&  trace ()
• bool  clear_database ()

Detailed Description

IO is performed by the associated class IO.

Returns: true if this routing process is running.

Determine routing process status.

Parameters:

Returns: status of the routing process.

Shut down this routing process.

Callback method to: receive a datagram.

All packets for OLSR are received through this interface. All good packets are sent to the face manager which verifies that the packet is expected, and is wholly responsible for further processing.

Transmit a datagram.

Register vif status callback with the FEA.

Parameters:

Register address status callback with the FEA.

Parameters:

Set the main address for the node.

Parameters:

Returns: true if the main address was set successfully.

Returns: the main address.

Set the MPR_COVERAGE for the node.

Parameters:

Returns: true if MPR_COVERAGE was set successfully.

Returns: the value of the MPR_COVERAGE variable.

Set the TC_REDUNDANCY for the node.

Parameters:

Returns: true if TC_REDUNDANCY was set successfully.

Returns: the value of the TC_REDUNDANCY variable.

Set the HELLO_INTERVAL.

Parameters:

Returns: true if HELLO_INTERVAL was set successfully.

Returns: the value of the HELLO_INTERVAL variable.

Set the MID_INTERVAL.

Parameters:

Returns: true if MID_INTERVAL was set successfully.

Returns: the value of the MID_INTERVAL variable.

Set the REFRESH_INTERVAL.

Parameters:

Returns: true if the refresh interval was set successfully.

Returns: the value of the REFRESH_INTERVAL protocol variable.

Set the TC interval for the node.

Parameters:

Returns: true if the TC interval was set successfully.

Returns: the value of the TC_INTERVAL protocol variable.

Set the WILLINGNESS.

Parameters:

Returns: true if the willingness was set successfully.

Returns: the WILLINGNESS protocol variable.

Set the HNA interval.

Parameters:

Returns: true if the HNA interval was set successfully.

Returns: the value of the HNA_INTERVAL protocol variable.

Set the DUP_HOLD_TIME.

Parameters:

Returns: true if the DUP_HOLD_TIME was set successfully.

Returns: the value of the DUP_HOLD_TIME protocol variable.

Bind OLSR to an interface.

Parameters:

Returns: true if the address was bound successfully.

Unbind OLSR from an interface.

OLSR may only be bound to a single address on an interface, therefore there is no 'address' argument to this method.

Parameters:

Returns: true if the interface was unbound successfully.

Enable I/O for OLSR on a given address.

Proxy for class IO.

Parameters:

Returns: true if the address was enabled successfully.

Disable I/O for OLSR on a given address.

Proxy for class IO.

Parameters:

Returns: true if the address was enabled successfully.

Enable or disable an interface for OLSR.

Parameters:

Returns: true if the interface state was set to @param enabled successfully.

Determine if an interface is enabled for OLSR.

Parameters:

Returns: true if the enable state was retrieved successfully.

Get an interface's statistics.

Parameters:

Returns: true if the stats werre retrieved successfully.

Set the cost on an interface.

Parameters:

Returns: true if the interface cost was set successfully.

Get the MTU of an interface.

Parameters:

Returns: the MTU of the interface.

Get the primary IPv4 broadcast address configured for this interface/vif/address.

Parameters:

Returns: true if the broadcast address was obtained successfully.

Test whether this interface/vif is broadcast capable.

Parameters:

Returns: true if it is broadcast capable, otherwise false.

Test whether this interface/vif is multicast capable.

Parameters:

Returns: true if it is multicast capable, otherwise false.

Add route.

Parameters:

Replace route.

Parameters:

Delete route.

Parameters:

Configure a policy filter

Parameters:

Reset a policy filter.

Parameters:

Push routes through policy filters for re-filtering.

Originate an external route in HNA.

Parameters:

Returns: true if the route was originated successfully.

Withdraw an external route from HNA.

Parameters:

Returns: true if the route was withdrawn successfully.

Returns: a reference to the policy filters

Returns: a reference to the tracing variables

Clear protocol databases.

A full routing recomputation should be triggered by this operation. This specifically clears links, MID, TC, learned HNA entries, and the duplicate message set only.