|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlOlsr4TargetBase (XrlCmdMap* cmds = 0)
| XrlOlsr4TargetBase |
Constructor.
Parameters:
| cmds | an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target. |
| ~XrlOlsr4TargetBase ()
| ~XrlOlsr4TargetBase |
[virtual]
Destructor.
Dissociates instance commands from command map.
| bool set_command_map (XrlCmdMap* cmds)
| set_command_map |
Set command map.
Parameters:
| cmds | pointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target. |
Returns: true on success, false if cmds is null or a command map has already been supplied.
| const string& name ()
| name |
[const]
Get Xrl instance name associated with command map.
| const char* version ()
| version |
[const]
Get version string of instance.
| XrlCmdError common_0_1_get_target_name (
string& name)
| common_0_1_get_target_name |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_get_version (
string& version)
| common_0_1_get_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get version string from Xrl Target
| XrlCmdError common_0_1_get_status (
uint32_t& status,
string& reason)
| common_0_1_get_status |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_shutdown ()
| common_0_1_shutdown |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Request clean shutdown of Xrl Target
| XrlCmdError finder_event_observer_0_1_xrl_target_birth (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_birth |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target birth to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError finder_event_observer_0_1_xrl_target_death (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_death |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target death to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError socket4_user_0_1_recv_event (
const string& sockid,
const string& if_name,
const string& vif_name,
const IPv4& src_host,
const uint32_t& src_port,
const vector<uint8_t>& data)
| socket4_user_0_1_recv_event |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Method invoked by target implementing socket4/0.1 when a packet arrives from an IPv4 source.
Parameters:
| sockid | the identifier associated with socket where the event occurred. |
| if_name | the interface name the packet arrived on, if known. If unknown, then it is an empty string. |
| vif_name | the vif name the packet arrived on, if known. If unknown, then it is an empty string. |
| src_host | the originating host. |
| src_port | the originating IP port. |
| data | the data received. |
| XrlCmdError socket4_user_0_1_inbound_connect_event (
const string& sockid,
const IPv4& src_host,
const uint32_t& src_port,
const string& new_sockid,
bool& accept)
| socket4_user_0_1_inbound_connect_event |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Method invoked by target implementing socket4/0.1 when a connection request is received from an IPv4 source. It applies only to TCP sockets.
Parameters:
| sockid | the identifier associated with socket where the event occurred. |
| src_host | the connecting host. |
| src_port | the connecting IP port. |
| new_sockid | the identifier associated with the new socket that has been created to handle the new connection. |
| accept | if true, the connection request has been accepted, otherwise it has been rejected. |
| XrlCmdError socket4_user_0_1_outgoing_connect_event (
const string& sockid)
| socket4_user_0_1_outgoing_connect_event |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Method invoked by target implementing socket4/0.1 when an outgoing connection request originated by the local host is completed. It applies only to TCP sockets. Note that if the connection failed, the error_event will be dispatched instead.
Parameters:
| sockid | the identifier associated with socket where the event occurred. |
| XrlCmdError socket4_user_0_1_error_event (
const string& sockid,
const string& error,
const bool& fatal)
| socket4_user_0_1_error_event |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Method invoked by target implementing socket4/0.1 when an error occurs.
Parameters:
| sockid | the identifier associated with socket where the event occurred. |
| error | a textual description of the error. |
| fatal | indication of whether socket is shutdown because of error. |
| XrlCmdError socket4_user_0_1_disconnect_event (
const string& sockid)
| socket4_user_0_1_disconnect_event |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Method invoked by target implementing socket4/0.1 when the peer has closed the connection. It applies only to TCP sockets. Note that the socket itself is left open and must be explicitly closed.
Parameters:
| sockid | the identifier associated with socket where the event occurred. |
| XrlCmdError policy_backend_0_1_configure (
const uint32_t& filter,
const string& conf)
| policy_backend_0_1_configure |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Configure a policy filter.
Parameters:
| filter | the identifier of the filter to configure. |
| conf | the configuration of the filter. |
| XrlCmdError policy_backend_0_1_reset (
const uint32_t& filter)
| policy_backend_0_1_reset |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Reset a policy filter.
Parameters:
| filter | the identifier of the filter to reset. |
| XrlCmdError policy_backend_0_1_push_routes ()
| policy_backend_0_1_push_routes |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Push all available routes through all filters for re-filtering.
| XrlCmdError policy_redist4_0_1_add_route4 (
const IPv4Net& network,
const bool& unicast,
const bool& multicast,
const IPv4& nexthop,
const uint32_t& metric,
const XrlAtomList& policytags)
| policy_redist4_0_1_add_route4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Start route redistribution for an IPv4 route.
Parameters:
| network | the route to advertise. |
| unicast | whether the route is unicast. |
| multicast | whether the route is multicast. |
| nexthop | the nexthop of the route. |
| metric | the metric of the route. |
| policytags | the set of policy-tags associated with the route. |
| XrlCmdError policy_redist4_0_1_delete_route4 (
const IPv4Net& network,
const bool& unicast,
const bool& multicast)
| policy_redist4_0_1_delete_route4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Terminate route redistribution for an IPv4 route.
Parameters:
| network | the route for which advertisements should cease. |
| unicast | whether the route is unicast. |
| multicast | whether the route is multicast. |
| XrlCmdError profile_0_1_enable (
const string& pname)
| profile_0_1_enable |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable profiling
Parameters:
| pname | profile variable |
| XrlCmdError profile_0_1_disable (
const string& pname)
| profile_0_1_disable |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Disable profiling
Parameters:
| pname | profile variable |
| XrlCmdError profile_0_1_get_entries (
const string& pname,
const string& instance_name)
| profile_0_1_get_entries |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get log entries.
Parameters:
| pname | profile variable |
| instance_name | to send the profiling info to. |
| XrlCmdError profile_0_1_clear (
const string& pname)
| profile_0_1_clear |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Clear the profiling entries
Parameters:
| pname | profile variable |
| XrlCmdError profile_0_1_list (
string& info)
| profile_0_1_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
List all the profiling variables registered with this target.
| XrlCmdError olsr4_0_1_trace (
const string& tvar,
const bool& enable)
| olsr4_0_1_trace |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/Disable tracing.
Parameters:
| tvar | trace variable. |
| enable | set to true to enable, false to disable. |
| XrlCmdError olsr4_0_1_clear_database ()
| olsr4_0_1_clear_database |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Clear all OLSR protocol databases.
| XrlCmdError olsr4_0_1_set_willingness (
const uint32_t& willingness)
| olsr4_0_1_set_willingness |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the willingness-to-forward.
Parameters:
| willingness | the new willingness-to-forward. |
| XrlCmdError olsr4_0_1_get_willingness (
uint32_t& willingness)
| olsr4_0_1_get_willingness |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the willingness-to-forward.
| XrlCmdError olsr4_0_1_set_mpr_coverage (
const uint32_t& coverage)
| olsr4_0_1_set_mpr_coverage |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the MPR_COVERAGE.
Parameters:
| coverage | the new MPR_COVERAGE value. |
| XrlCmdError olsr4_0_1_get_mpr_coverage (
uint32_t& coverage)
| olsr4_0_1_get_mpr_coverage |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_set_tc_redundancy (
const string& redundancy)
| olsr4_0_1_set_tc_redundancy |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_get_tc_redundancy (
string& redundancy)
| olsr4_0_1_get_tc_redundancy |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_set_tc_fisheye (
const bool& enabled)
| olsr4_0_1_set_tc_fisheye |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable TC fisheye mode.
Parameters:
| enabled | true to enable fisheye, false to disable it. |
| XrlCmdError olsr4_0_1_get_tc_fisheye (
bool& enabled)
| olsr4_0_1_get_tc_fisheye |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the current TC fisheye mode.
| XrlCmdError olsr4_0_1_set_hna_base_cost (
const uint32_t& metric)
| olsr4_0_1_set_hna_base_cost |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the current HNA base cost metric.
| XrlCmdError olsr4_0_1_get_hna_base_cost (
uint32_t& metric)
| olsr4_0_1_get_hna_base_cost |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the current HNA base cost metric.
| XrlCmdError olsr4_0_1_set_hello_interval (
const uint32_t& interval)
| olsr4_0_1_set_hello_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the HELLO_INTERVAL.
Parameters:
| interval | the new HELLO_INTERVAL. |
| XrlCmdError olsr4_0_1_get_hello_interval (
uint32_t& interval)
| olsr4_0_1_get_hello_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_set_refresh_interval (
const uint32_t& interval)
| olsr4_0_1_set_refresh_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the REFRESH_INTERVAL.
Parameters:
| interval | the new REFRESH_INTERVAL. |
| XrlCmdError olsr4_0_1_get_refresh_interval (
uint32_t& interval)
| olsr4_0_1_get_refresh_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_set_tc_interval (
const uint32_t& interval)
| olsr4_0_1_set_tc_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the TC_INTERVAL.
Parameters:
| interval | the new TC_INTERVAL. |
| XrlCmdError olsr4_0_1_get_tc_interval (
uint32_t& interval)
| olsr4_0_1_get_tc_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_set_mid_interval (
const uint32_t& interval)
| olsr4_0_1_set_mid_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the MID_INTERVAL.
Parameters:
| interval | the new MID_INTERVAL. |
| XrlCmdError olsr4_0_1_get_mid_interval (
uint32_t& interval)
| olsr4_0_1_get_mid_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_set_hna_interval (
const uint32_t& interval)
| olsr4_0_1_set_hna_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the HNA_INTERVAL.
Parameters:
| interval | the new HNA_INTERVAL. |
| XrlCmdError olsr4_0_1_get_hna_interval (
uint32_t& interval)
| olsr4_0_1_get_hna_interval |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_set_dup_hold_time (
const uint32_t& dup_hold_time)
| olsr4_0_1_set_dup_hold_time |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the DUP_HOLD_TIME.
Parameters:
| dup_hold_time | the new DUP_HOLD_TIME. |
| XrlCmdError olsr4_0_1_get_dup_hold_time (
uint32_t& dup_hold_time)
| olsr4_0_1_get_dup_hold_time |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_set_main_address (
const IPv4& addr)
| olsr4_0_1_set_main_address |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the main address.
Parameters:
| addr | Our main IPv4 address which OLSR uses as a router ID. |
| XrlCmdError olsr4_0_1_get_main_address (
IPv4& addr)
| olsr4_0_1_get_main_address |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError olsr4_0_1_bind_address (
const string& ifname,
const string& vifname,
const IPv4& local_addr,
const uint32_t& local_port,
const IPv4& all_nodes_addr,
const uint32_t& all_nodes_port)
| olsr4_0_1_bind_address |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create an IPv4 address binding for OLSR. OLSR must be bound to a given protocol address on each interface, which means interface bindings in OLSRv1 must be keyed by interface name as well as protocol address. Only a single IPv4 address may be thus bound, and the address must be supplied when the binding is created. This is to workaround the lack of RFC 3927 link-scoped IPv4 capability in most IPv4 implementations. The addition of address is not instantaneous. OLSR has to instantiate state in the FEA to send and receive packets. Once instantiated, the address must be explicitly enabled with the set_binding_enabled XRL.
Parameters:
| ifname | the interface that owns vif that has addr |
| vifname | virtual interface owning addr |
| local_addr | the address to be added. |
| local_port | the port to listen for control traffic on. |
| all_nodes_addr | the address to use for transmission. |
| all_nodes_port | the port to use for transmission. |
| XrlCmdError olsr4_0_1_unbind_address (
const string& ifname,
const string& vifname)
| olsr4_0_1_unbind_address |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Destroy an IPv4 address binding for OLSR.
Parameters:
| ifname | the interface to unbind. |
| vifname | the vif to unbind. |
| XrlCmdError olsr4_0_1_set_binding_enabled (
const string& ifname,
const string& vifname,
const bool& enabled)
| olsr4_0_1_set_binding_enabled |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the enabled state of an IPv4 address binding for OLSR.
Parameters:
| ifname | the interface to set enabled state for. |
| vifname | the vif to set enabled state for. |
| enabled | true if OLSR is to be configured administratively up on the interface, false if it is to be configured down. |
| XrlCmdError olsr4_0_1_get_binding_enabled (
const string& ifname,
const string& vifname,
bool& enabled)
| olsr4_0_1_get_binding_enabled |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the state of an IPv4 address binding for OLSR.
Parameters:
| ifname | the interface to query. |
| vifname | the vif to qurery |
| enabled | true if OLSR is configured administratively up on the given interface. |
| XrlCmdError olsr4_0_1_change_local_addr_port (
const string& ifname,
const string& vifname,
const IPv4& local_addr,
const uint32_t& local_port)
| olsr4_0_1_change_local_addr_port |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Change the UDP address and port where OLSR listens for control traffic on this interface. In order to do this the process must tell the FEA to tear down and re-bind the control traffic socket.
Parameters:
| ifname | the name of the interface. |
| vifname | the name of the vif. |
| local_addr | the new local IPv4 address. |
| local_port | the new local port number. |
| XrlCmdError olsr4_0_1_change_all_nodes_addr_port (
const string& ifname,
const string& vifname,
const IPv4& all_nodes_addr,
const uint32_t& all_nodes_port)
| olsr4_0_1_change_all_nodes_addr_port |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Change the address where OLSR sends control traffic on the given interface. By default OLSR will attempt to use the all-ones broadcast address. Currently multicast addresses are NOT supported.
Parameters:
| ifname | the name of the interface. |
| vifname | the name of the vif. |
| all_nodes_addr | the address to use. |
| all_nodes_port | the port to use. |
| XrlCmdError olsr4_0_1_get_interface_list (
XrlAtomList& interfaces)
| olsr4_0_1_get_interface_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the list of interfaces currently configured for OLSR. Return a list of u32 type values. Each value is an internal ID that can be used with the get_interface_info XRL.
| XrlCmdError olsr4_0_1_get_interface_info (
const uint32_t& faceid,
string& ifname,
string& vifname,
IPv4& local_addr,
uint32_t& local_port,
IPv4& all_nodes_addr,
uint32_t& all_nodes_port)
| olsr4_0_1_get_interface_info |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the per-interface information for the given interface.
Parameters:
| faceid | interface ID returned by get_interface_list. |
| ifname | the name of the interface. |
| vifname | the name of the vif. |
| local_addr | the IPv4 address where OLSR is listening. |
| local_port | the UDP port where OLSR is listening. |
| all_nodes_addr | the IPv4 address where OLSR sends packets. |
| all_nodes_port | the UDP port where OLSR sends packets. |
| XrlCmdError olsr4_0_1_set_interface_cost (
const string& ifname,
const string& vifname,
const uint32_t& cost)
| olsr4_0_1_set_interface_cost |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the edge cost of an interface/vif.
Parameters:
| ifname | the name of the interface. |
| vifname | the name of the vif. |
| cost | the new edge cost of the interface. |
| XrlCmdError olsr4_0_1_get_interface_stats (
const string& ifname,
const string& vifname,
uint32_t& bad_packets,
uint32_t& bad_messages,
uint32_t& messages_from_self,
uint32_t& unknown_messages,
uint32_t& duplicates,
uint32_t& forwarded)
| olsr4_0_1_get_interface_stats |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the per-interface statistics for the given interface.
Parameters:
| ifname | the interface to query. |
| vifname | the vif to qurery |
| bad_packets | the number of bad packets received. |
| bad_messages | the number of bad messages received. |
| messages_from_self | the number of messages which appeared to be from our own main address. |
| unknown_messages | the number of messages which could not be decoded. |
| duplicates | the number of messages which appeared to be duplicates, according to histogram based duplicate detection. |
| forwarded | the number of messages which have been forwarded to the rest of the OLSR topology on this interface. |
| XrlCmdError olsr4_0_1_get_link_list (
XrlAtomList& links)
| olsr4_0_1_get_link_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the list of one-hop links. Return a list of u32 type values. Each value is an internal ID that can be used with the get_link_info XRL.
| XrlCmdError olsr4_0_1_get_link_info (
const uint32_t& linkid,
IPv4& local_addr,
IPv4& remote_addr,
IPv4& main_addr,
uint32_t& link_type,
uint32_t& sym_time,
uint32_t& asym_time,
uint32_t& hold_time)
| olsr4_0_1_get_link_info |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the information for a one-hop link. TODO: Add ETX support.
Parameters:
| linkid | Link entry ID returned by get_link_list. |
| local_addr | the interface address of the local end of this link. |
| remote_addr | the interface address of the remote end of this link. |
| main_addr | the main address of the neighbor at the remote end of this link. |
| link_type | the type of this link. |
| sym_time | the time in seconds for which this link will be considered symmetric. |
| asym_time | the time in seconds for which this link will be considered asymmetric. |
| hold_time | the time in seconds until this link expires. |
| XrlCmdError olsr4_0_1_get_neighbor_list (
XrlAtomList& neighbors)
| olsr4_0_1_get_neighbor_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the list of one-hop neighbors. Return a list of u32 type values. Each value is an internal ID that can be used with the get_neighbor_info XRL.
| XrlCmdError olsr4_0_1_get_neighbor_info (
const uint32_t& nid,
IPv4& main_addr,
uint32_t& willingness,
uint32_t& degree,
uint32_t& link_count,
uint32_t& twohop_link_count,
bool& is_advertised,
bool& is_sym,
bool& is_mpr,
bool& is_mpr_selector)
| olsr4_0_1_get_neighbor_info |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the information for a one-hop neighbor.
Parameters:
| nid | Neighbor entry ID returned by get_neighbor_list. |
| main_addr | the main address of this neighbor. |
| willingness | the willingness of this neighbor to forward. |
| degree | the number of symmetric strict neighbors of this neighbor, excluding one-hop neighbors and this node. |
| link_count | the number of links to this neighbor. |
| twohop_link_count | the number of two-hop links which transit this neighbor as next-hop. |
| is_advertised | true if this neighbor is in the Advertised Neighbor Set of this node. |
| is_sym | true if this neighbor is symmetric. |
| is_mpr | true if this neighbor is selected as an MPR by this node. |
| is_mpr_selector | true if this neighbor chooses this node as an MPR. |
| XrlCmdError olsr4_0_1_get_twohop_link_list (
XrlAtomList& twohop_links)
| olsr4_0_1_get_twohop_link_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the list of two-hop links. Return a list of u32 type values. Each value is an internal ID that can be used with the get_twohop_link_info XRL.
| XrlCmdError olsr4_0_1_get_twohop_link_info (
const uint32_t& tlid,
uint32_t& last_face_id,
IPv4& nexthop_addr,
IPv4& dest_addr,
uint32_t& hold_time)
| olsr4_0_1_get_twohop_link_info |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the information for a two-hop link. TODO: Add ETX support.
Parameters:
| tlid | two-hop link ID returned by get_twohop_link_list. |
| last_face_id | the internal interface ID where advertisement of this two-hop link was last seen. |
| nexthop_addr | the main address of the one-hop neighbor where this two-hop link exists. |
| dest_addr | the main address of the two-hop neighbor at the remote end of this link. |
| hold_time | the time in seconds until this two-hop link expires. |
| XrlCmdError olsr4_0_1_get_twohop_neighbor_list (
XrlAtomList& twohop_neighbors)
| olsr4_0_1_get_twohop_neighbor_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the list of two-hop neighbors. Return a list of u32 type values. Each value is an internal ID that can be used with the get_twohop_neighbor_info XRL.
| XrlCmdError olsr4_0_1_get_twohop_neighbor_info (
const uint32_t& tnid,
IPv4& main_addr,
bool& is_strict,
uint32_t& link_count,
uint32_t& reachability,
uint32_t& coverage)
| olsr4_0_1_get_twohop_neighbor_info |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the information for a two-hop neighbor.
Parameters:
| tnid | two-hop neighbor ID returned by get_twohop_neighbor_list. |
| main_addr | the main address of this two-hop neighbor. |
| is_strict | true if this two-hop neighbor is not also a two-hop neighbor. |
| link_count | the number of two-hop links that exist to this two-hop neighbor. |
| reachability | the number of MPR candidates which cover this two-hop neighbor. |
| coverage | the number of selected MPRs which cover this two-hop neighbor. |
| XrlCmdError olsr4_0_1_get_mid_entry_list (
XrlAtomList& mid_entries)
| olsr4_0_1_get_mid_entry_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the list of learned Multiple Interface Declaration (MID) entries. Return a list of u32 type values. Each value is an internal ID that can be used with the get_mid_entry XRL.
| XrlCmdError olsr4_0_1_get_mid_entry (
const uint32_t& midid,
IPv4& main_addr,
IPv4& iface_addr,
uint32_t& distance,
uint32_t& hold_time)
| olsr4_0_1_get_mid_entry |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the information contained in a MID entry.
Parameters:
| midid | MID entry ID returned by get_mid_entry_list. |
| main_addr | the main address of the OLSR node |
| iface_addr | the interface address being advertised. |
| distance | the distance measured between this node and the origin of the MID packet containing this entry. |
| hold_time | the time in seconds until this entry expires. |
| XrlCmdError olsr4_0_1_get_tc_entry_list (
XrlAtomList& tc_entries)
| olsr4_0_1_get_tc_entry_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the list of learned Topology Control (TC) entries. Return a list of u32 type values. Each value is an internal ID that can be used with the get_tc_entry XRL.
| XrlCmdError olsr4_0_1_get_tc_entry (
const uint32_t& tcid,
IPv4& destination,
IPv4& lasthop,
uint32_t& distance,
uint32_t& seqno,
uint32_t& hold_time)
| olsr4_0_1_get_tc_entry |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the information contained in a TC entry.
Parameters:
| tcid | TC entry ID returned by get_tc_entry_list. |
| destination | the main address of the advertised destination. |
| lasthop | the main address of the node advertising this entry. |
| distance | the distance measured between this node and the origin of the TC packet containing this entry. |
| seqno | the advertised sequence number of this entry. |
| hold_time | the time in seconds until this entry expires. |
| XrlCmdError olsr4_0_1_get_hna_entry_list (
XrlAtomList& hna_entries)
| olsr4_0_1_get_hna_entry_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the list of learned external route (HNA) entries. Return a list of u32 type values. Each value is an internal ID that can be used with the get_hna_entry XRL.
| XrlCmdError olsr4_0_1_get_hna_entry (
const uint32_t& hnaid,
IPv4Net& destination,
IPv4& lasthop,
uint32_t& distance,
uint32_t& hold_time)
| olsr4_0_1_get_hna_entry |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the information contained in a HNA entry.
Parameters:
| hnaid | HNA entry ID returned by get_hna_entry_list. |
| destination | the main address of the advertised destination. |
| lasthop | the main address of the node advertising this entry. |
| distance | the distance measured between this node and the origin of the TC packet containing this entry. |
| hold_time | the time in seconds until this entry expires. |
