class XrlPimV0p1Client


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Types

Public Methods

Protected Members


Detailed Description

 XrlPimV0p1Client (XrlSender* s)

XrlPimV0p1Client

 ~XrlPimV0p1Client ()

~XrlPimV0p1Client

[virtual]

typedef XorpCallback1<void, const XrlError&>::RefPtr EnableVifCB

EnableVifCB

bool  send_enable_vif ( const char* dst_xrl_target_name, const string& vif_name, const bool& enable, const EnableVifCB& cb )

send_enable_vif

Send Xrl intended to:

Enable/disable/start/stop a PIM vif interface.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
vif_namethe name of the vif to enable/disable/start/stop.
enableif true, then enable the vif, otherwise disable it.
typedef XorpCallback1<void, const XrlError&>::RefPtr StartVifCB

StartVifCB

bool  send_start_vif ( const char* dst_xrl_target_name, const string& vif_name, const StartVifCB& cb )

send_start_vif

typedef XorpCallback1<void, const XrlError&>::RefPtr StopVifCB

StopVifCB

bool  send_stop_vif ( const char* dst_xrl_target_name, const string& vif_name, const StopVifCB& cb )

send_stop_vif

typedef XorpCallback1<void, const XrlError&>::RefPtr EnableAllVifsCB

EnableAllVifsCB

bool  send_enable_all_vifs ( const char* dst_xrl_target_name, const bool& enable, const EnableAllVifsCB& cb )

send_enable_all_vifs

Send Xrl intended to:

Enable/disable/start/stop all PIM vif interfaces.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
enableif true, then enable the vifs, otherwise disable them.
typedef XorpCallback1<void, const XrlError&>::RefPtr StartAllVifsCB

StartAllVifsCB

bool  send_start_all_vifs ( const char* dst_xrl_target_name, const StartAllVifsCB& cb )

send_start_all_vifs

typedef XorpCallback1<void, const XrlError&>::RefPtr StopAllVifsCB

StopAllVifsCB

bool  send_stop_all_vifs ( const char* dst_xrl_target_name, const StopAllVifsCB& cb )

send_stop_all_vifs

typedef XorpCallback1<void, const XrlError&>::RefPtr EnablePimCB

EnablePimCB

bool  send_enable_pim ( const char* dst_xrl_target_name, const bool& enable, const EnablePimCB& cb )

send_enable_pim

Send Xrl intended to:

Enable/disable/start/stop the PIM protocol.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
enableif true, then enable the PIM protocol, otherwise disable it.
typedef XorpCallback1<void, const XrlError&>::RefPtr StartPimCB

StartPimCB

bool  send_start_pim ( const char* dst_xrl_target_name, const StartPimCB& cb )

send_start_pim

typedef XorpCallback1<void, const XrlError&>::RefPtr StopPimCB

StopPimCB

bool  send_stop_pim ( const char* dst_xrl_target_name, const StopPimCB& cb )

send_stop_pim

typedef XorpCallback1<void, const XrlError&>::RefPtr EnableCliCB

EnableCliCB

bool  send_enable_cli ( const char* dst_xrl_target_name, const bool& enable, const EnableCliCB& cb )

send_enable_cli

Send Xrl intended to:

Enable/disable/start/stop the PIM CLI access.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
enableif true, then enable the PIM CLI access, otherwise disable it.
typedef XorpCallback1<void, const XrlError&>::RefPtr StartCliCB

StartCliCB

bool  send_start_cli ( const char* dst_xrl_target_name, const StartCliCB& cb )

send_start_cli

typedef XorpCallback1<void, const XrlError&>::RefPtr StopCliCB

StopCliCB

bool  send_stop_cli ( const char* dst_xrl_target_name, const StopCliCB& cb )

send_stop_cli

typedef XorpCallback1<void, const XrlError&>::RefPtr EnableBsrCB

EnableBsrCB

bool  send_enable_bsr ( const char* dst_xrl_target_name, const bool& enable, const EnableBsrCB& cb )

send_enable_bsr

Send Xrl intended to:

Enable/disable/start/stop BSR.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
enableif true, then enable the BSR, otherwise disable it.
typedef XorpCallback1<void, const XrlError&>::RefPtr StartBsrCB

StartBsrCB

bool  send_start_bsr ( const char* dst_xrl_target_name, const StartBsrCB& cb )

send_start_bsr

typedef XorpCallback1<void, const XrlError&>::RefPtr StopBsrCB

StopBsrCB

bool  send_stop_bsr ( const char* dst_xrl_target_name, const StopBsrCB& cb )

send_stop_bsr

typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigScopeZoneByVifName4CB

AddConfigScopeZoneByVifName4CB

bool  send_add_config_scope_zone_by_vif_name4 ( const char* dst_xrl_target_name, const IPv4Net& scope_zone_id, const string& vif_name, const AddConfigScopeZoneByVifName4CB& cb )

send_add_config_scope_zone_by_vif_name4

Send Xrl intended to:

Add/delete scope zone.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
scope_zone_idthe ID of the configured zone.
vif_namethe name of the vif to use as a bondary of the scope zone.
typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigScopeZoneByVifName6CB

AddConfigScopeZoneByVifName6CB

bool  send_add_config_scope_zone_by_vif_name6 ( const char* dst_xrl_target_name, const IPv6Net& scope_zone_id, const string& vif_name, const AddConfigScopeZoneByVifName6CB& cb )

send_add_config_scope_zone_by_vif_name6

typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigScopeZoneByVifAddr4CB

AddConfigScopeZoneByVifAddr4CB

bool  send_add_config_scope_zone_by_vif_addr4 ( const char* dst_xrl_target_name, const IPv4Net& scope_zone_id, const IPv4& vif_addr, const AddConfigScopeZoneByVifAddr4CB& cb )

send_add_config_scope_zone_by_vif_addr4

typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigScopeZoneByVifAddr6CB

AddConfigScopeZoneByVifAddr6CB

bool  send_add_config_scope_zone_by_vif_addr6 ( const char* dst_xrl_target_name, const IPv6Net& scope_zone_id, const IPv6& vif_addr, const AddConfigScopeZoneByVifAddr6CB& cb )

send_add_config_scope_zone_by_vif_addr6

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigScopeZoneByVifName4CB

DeleteConfigScopeZoneByVifName4CB

bool  send_delete_config_scope_zone_by_vif_name4 ( const char* dst_xrl_target_name, const IPv4Net& scope_zone_id, const string& vif_name, const DeleteConfigScopeZoneByVifName4CB& cb )

send_delete_config_scope_zone_by_vif_name4

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigScopeZoneByVifName6CB

DeleteConfigScopeZoneByVifName6CB

bool  send_delete_config_scope_zone_by_vif_name6 ( const char* dst_xrl_target_name, const IPv6Net& scope_zone_id, const string& vif_name, const DeleteConfigScopeZoneByVifName6CB& cb )

send_delete_config_scope_zone_by_vif_name6

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigScopeZoneByVifAddr4CB

DeleteConfigScopeZoneByVifAddr4CB

bool  send_delete_config_scope_zone_by_vif_addr4 ( const char* dst_xrl_target_name, const IPv4Net& scope_zone_id, const IPv4& vif_addr, const DeleteConfigScopeZoneByVifAddr4CB& cb )

send_delete_config_scope_zone_by_vif_addr4

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigScopeZoneByVifAddr6CB

DeleteConfigScopeZoneByVifAddr6CB

bool  send_delete_config_scope_zone_by_vif_addr6 ( const char* dst_xrl_target_name, const IPv6Net& scope_zone_id, const IPv6& vif_addr, const DeleteConfigScopeZoneByVifAddr6CB& cb )

send_delete_config_scope_zone_by_vif_addr6

typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigCandBsr4CB

AddConfigCandBsr4CB

bool  send_add_config_cand_bsr4 ( const char* dst_xrl_target_name, const IPv4Net& scope_zone_id, const bool& is_scope_zone, const string& vif_name, const IPv4& vif_addr, const uint32_t& bsr_priority, const uint32_t& hash_mask_len, const AddConfigCandBsr4CB& cb )

send_add_config_cand_bsr4

Send Xrl intended to:

Add/delete candidate-BSR configuration.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
scope_zone_idthe ID of the configured zone.
is_scope_zonetrue if configuring administratively scoped zone.
vif_namethe name of the vif to use its address as a candidate-BSR.
vif_addrthe address of the vif to use as a candidate-BSR.
bsr_prioritythe BSR priority (larger is better).
hash_mask_lenthe hash mask length.
typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigCandBsr6CB

AddConfigCandBsr6CB

bool  send_add_config_cand_bsr6 ( const char* dst_xrl_target_name, const IPv6Net& scope_zone_id, const bool& is_scope_zone, const string& vif_name, const IPv6& vif_addr, const uint32_t& bsr_priority, const uint32_t& hash_mask_len, const AddConfigCandBsr6CB& cb )

send_add_config_cand_bsr6

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigCandBsr4CB

DeleteConfigCandBsr4CB

bool  send_delete_config_cand_bsr4 ( const char* dst_xrl_target_name, const IPv4Net& scope_zone_id, const bool& is_scope_zone, const DeleteConfigCandBsr4CB& cb )

send_delete_config_cand_bsr4

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigCandBsr6CB

DeleteConfigCandBsr6CB

bool  send_delete_config_cand_bsr6 ( const char* dst_xrl_target_name, const IPv6Net& scope_zone_id, const bool& is_scope_zone, const DeleteConfigCandBsr6CB& cb )

send_delete_config_cand_bsr6

typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigCandRp4CB

AddConfigCandRp4CB

bool  send_add_config_cand_rp4 ( const char* dst_xrl_target_name, const IPv4Net& group_prefix, const bool& is_scope_zone, const string& vif_name, const IPv4& vif_addr, const uint32_t& rp_priority, const uint32_t& rp_holdtime, const AddConfigCandRp4CB& cb )

send_add_config_cand_rp4

Send Xrl intended to:

Add/delete Candidate-RP configuration.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
group_prefixthe group prefix of the configured zone.
is_scope_zonetrue if configuring administratively scoped zone.
vif_namethe name of the vif to use its address as a candidate-RP.
vif_addrthe address of the vif to use as a candidate-RP.
rp_prioritythe Cand-RP priority (smaller is better).
rp_holdtimethe Cand-RP holdtime (in seconds).
typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigCandRp6CB

AddConfigCandRp6CB

bool  send_add_config_cand_rp6 ( const char* dst_xrl_target_name, const IPv6Net& group_prefix, const bool& is_scope_zone, const string& vif_name, const IPv6& vif_addr, const uint32_t& rp_priority, const uint32_t& rp_holdtime, const AddConfigCandRp6CB& cb )

send_add_config_cand_rp6

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigCandRp4CB

DeleteConfigCandRp4CB

bool  send_delete_config_cand_rp4 ( const char* dst_xrl_target_name, const IPv4Net& group_prefix, const bool& is_scope_zone, const string& vif_name, const IPv4& vif_addr, const DeleteConfigCandRp4CB& cb )

send_delete_config_cand_rp4

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigCandRp6CB

DeleteConfigCandRp6CB

bool  send_delete_config_cand_rp6 ( const char* dst_xrl_target_name, const IPv6Net& group_prefix, const bool& is_scope_zone, const string& vif_name, const IPv6& vif_addr, const DeleteConfigCandRp6CB& cb )

send_delete_config_cand_rp6

typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigStaticRp4CB

AddConfigStaticRp4CB

bool  send_add_config_static_rp4 ( const char* dst_xrl_target_name, const IPv4Net& group_prefix, const IPv4& rp_addr, const uint32_t& rp_priority, const uint32_t& hash_mask_len, const AddConfigStaticRp4CB& cb )

send_add_config_static_rp4

Send Xrl intended to:

Add/delete/complete static RP configuration.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
group_prefixthe group prefix for the RP.
rp_addrthe RP address.
rp_prioritythe RP priority (smaller is better).
hash_mask_lenthe hash mask length used in computing an RP for a group. It should be same across all RPs. If set to zero, the default one will be used.
typedef XorpCallback1<void, const XrlError&>::RefPtr AddConfigStaticRp6CB

AddConfigStaticRp6CB

bool  send_add_config_static_rp6 ( const char* dst_xrl_target_name, const IPv6Net& group_prefix, const IPv6& rp_addr, const uint32_t& rp_priority, const uint32_t& hash_mask_len, const AddConfigStaticRp6CB& cb )

send_add_config_static_rp6

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigStaticRp4CB

DeleteConfigStaticRp4CB

bool  send_delete_config_static_rp4 ( const char* dst_xrl_target_name, const IPv4Net& group_prefix, const IPv4& rp_addr, const DeleteConfigStaticRp4CB& cb )

send_delete_config_static_rp4

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigStaticRp6CB

DeleteConfigStaticRp6CB

bool  send_delete_config_static_rp6 ( const char* dst_xrl_target_name, const IPv6Net& group_prefix, const IPv6& rp_addr, const DeleteConfigStaticRp6CB& cb )

send_delete_config_static_rp6

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigAllStaticGroupPrefixesRp4CB

DeleteConfigAllStaticGroupPrefixesRp4CB

bool  send_delete_config_all_static_group_prefixes_rp4 ( const char* dst_xrl_target_name, const IPv4& rp_addr, const DeleteConfigAllStaticGroupPrefixesRp4CB& cb )

send_delete_config_all_static_group_prefixes_rp4

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigAllStaticGroupPrefixesRp6CB

DeleteConfigAllStaticGroupPrefixesRp6CB

bool  send_delete_config_all_static_group_prefixes_rp6 ( const char* dst_xrl_target_name, const IPv6& rp_addr, const DeleteConfigAllStaticGroupPrefixesRp6CB& cb )

send_delete_config_all_static_group_prefixes_rp6

typedef XorpCallback1<void, const XrlError&>::RefPtr DeleteConfigAllStaticRpsCB

DeleteConfigAllStaticRpsCB

bool  send_delete_config_all_static_rps ( const char* dst_xrl_target_name, const DeleteConfigAllStaticRpsCB& cb )

send_delete_config_all_static_rps

typedef XorpCallback1<void, const XrlError&>::RefPtr ConfigStaticRpDoneCB

ConfigStaticRpDoneCB

bool  send_config_static_rp_done ( const char* dst_xrl_target_name, const ConfigStaticRpDoneCB& cb )

send_config_static_rp_done

typedef XorpCallback2<void, const XrlError&, const uint32_t*>::RefPtr GetVifProtoVersionCB

GetVifProtoVersionCB

bool  send_get_vif_proto_version ( const char* dst_xrl_target_name, const string& vif_name, const GetVifProtoVersionCB& cb )

send_get_vif_proto_version

Send Xrl intended to:

Get the configured protocol version per interface.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
vif_namethe name of the vif to apply to.
typedef XorpCallback1<void, const XrlError&>::RefPtr SetVifProtoVersionCB

SetVifProtoVersionCB

bool  send_set_vif_proto_version ( const char* dst_xrl_target_name, const string& vif_name, const uint32_t& proto_version, const SetVifProtoVersionCB& cb )

send_set_vif_proto_version

Send Xrl intended to:

Set the protocol version per interface.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
vif_namethe name of the vif to apply to.
proto_versionthe protocol version.
typedef XorpCallback1<void, const XrlError&>::RefPtr ResetVifProtoVersionCB

ResetVifProtoVersionCB

bool  send_reset_vif_proto_version ( const char* dst_xrl_target_name, const string& vif_name, const ResetVifProtoVersionCB& cb )

send_reset_vif_proto_version

Send Xrl intended to:

Reset the protocol version per interface to its default value.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
vif_namethe name of the vif to apply to.
typedef XorpCallback2<void, const XrlError&, const bool*>::RefPtr GetVifIpRouterAlertOptionCheckCB

GetVifIpRouterAlertOptionCheckCB

bool  send_get_vif_ip_router_alert_option_check ( const char* dst_xrl_target_name, const string& vif_name, const GetVifIpRouterAlertOptionCheckCB& cb )

send_get_vif_ip_router_alert_option_check

Send Xrl intended to:

Get the IP Router Alert option check per interface for received packets.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
vif_namethe name of the vif to apply to.
typedef XorpCallback1<void, const XrlError&>::RefPtr SetVifIpRouterAlertOptionCheckCB

SetVifIpRouterAlertOptionCheckCB

bool  send_set_vif_ip_router_alert_option_check ( const char* dst_xrl_target_name, const string& vif_name, const bool& enable, const SetVifIpRouterAlertOptionCheckCB& cb )

send_set_vif_ip_router_alert_option_check

Send Xrl intended to:

Set the IP Router Alert option check per interface for received packets.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
vif_namethe name of the vif to apply to.
enableif true, then enable the IP Router Alert option check, otherwise disable it.
typedef XorpCallback1<void, const XrlError&>::RefPtr ResetVifIpRouterAlertOptionCheckCB

ResetVifIpRouterAlertOptionCheckCB

bool  send_reset_vif_ip_router_alert_option_check ( const char* dst_xrl_target_name, const string& vif_name, const ResetVifIpRouterAlertOptionCheckCB& cb )

send_reset_vif_ip_router_alert_option_check

Send Xrl intended to:

Reset the IP Router Alert option check per interface for received packets to its default value.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
vif_namethe name of the vif to apply to.
typedef XorpCallback2<void, const XrlError&, const uint32_t*>::RefPtr GetVifHelloTriggeredDelayCB

GetVifHelloTriggeredDelayCB

bool  send_get_vif_hello_triggered_delay ( const char* dst_xrl_target_name, const string& vif_name, const GetVifHelloTriggeredDelayCB& cb )

send_get_vif_hello_triggered_delay

Send Xrl intended to:

Configure PIM Hello-related metrics. The 'set_foo' XRLs set the particular values. The 'reset_foo' XRLs reset the metrics to their default values.

Parameters:

dst_xrl_target_namethe Xrl target name of the destination.
vif_namethe name of the vif to configure.
typedef XorpCallback1<void, const XrlError&>::RefPtr SetVifHelloTriggeredDelayCB

SetVifHelloTriggeredDelayCB

bool  send_set_vif_hello_triggered_delay ( const char* dst_xrl_target_name, const string& vif_name, const uint32_t& hello_triggered_delay, const SetVifHelloTriggeredDelayCB& cb )

send_set_vif_hello_triggered_delay

typedef XorpCallback1<void, const XrlError&>::RefPtr ResetVifHelloTriggeredDelayCB

ResetVifHelloTriggeredDelayCB

bool  send_reset_vif_hello_triggered_delay ( const char* dst_xrl_target_name, const string& vif_name, const ResetVifHelloTriggeredDelayCB& cb )

send_reset_vif_hello_triggered_delay

typedef XorpCallback2<void, const XrlError&, const uint32_t*>::RefPtr GetVifHelloPeriodCB

GetVifHelloPeriodCB

bool  send_get_vif_hello_period ( const char* dst_xrl_target_name, const string& vif_name, const GetVifHelloPeriodCB& cb )

send_get_vif_hello_period

typedef XorpCallback1<void, const XrlError&>::RefPtr SetVifHelloPeriodCB

SetVifHelloPeriodCB

bool  send_set_vif_hello_period ( const char* dst_xrl_target_name, const string& vif_name, const uint32_t& hello_period, const SetVifHelloPeriodCB& cb )

send_set_vif_hello_period

typedef XorpCallback1<void, const XrlError&>::RefPtr ResetVifHelloPeriodCB