class XrlPolicyTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlPolicyTargetBase (XrlCmdMap* cmds = 0)

XrlPolicyTargetBase

Constructor.

Parameters:

cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
 ~XrlPolicyTargetBase ()

~XrlPolicyTargetBase

[virtual]

Destructor.

Dissociates instance commands from command map.

bool  set_command_map (XrlCmdMap* cmds)

set_command_map

Set command map.

Parameters:

cmdspointer 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:

Get name of Xrl Target

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:

Get status of Xrl Target

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_classthe target class name.
target_instancethe 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_classthe target class name.
target_instancethe target instance name.
XrlCmdError  policy_0_1_create_term ( const string& policy, const string& order, const string& term)

policy_0_1_create_term

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Create a term in a policy. The term will be the last term in the policy statement.

Parameters:

policythe name of the policy.
orderposition of term.
termthe name of the term.
XrlCmdError  policy_0_1_delete_term ( const string& policy, const string& term)

policy_0_1_delete_term

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a term in a policy.

Parameters:

policythe name of the policy.
termthe name of the term.
XrlCmdError  policy_0_1_update_term_block ( const string& policy, const string& term, const uint32_t& block, const string& order, const string& statement)

policy_0_1_update_term_block

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Update the source/dest/action block of a term in a policy. Note: if statement is empty, the previous one in that position will be deleted.

Parameters:

policythe name of the policy.
termthe name of the term.
blockthe block to update (0:source, 1:dest, 2:action).
ordernumerical position (local) of statement.
statementthe statement to insert or delete.
XrlCmdError  policy_0_1_create_policy ( const string& policy)

policy_0_1_create_policy

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Create a policy.

Parameters:

policyname of the policy.
XrlCmdError  policy_0_1_delete_policy ( const string& policy)

policy_0_1_delete_policy

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a policy.

Parameters:

policyname of the policy.
XrlCmdError  policy_0_1_create_set ( const string& set)

policy_0_1_create_set

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Create a set.

Parameters:

setname of the set.
XrlCmdError  policy_0_1_update_set ( const string& type, const string& set, const string& elements)

policy_0_1_update_set

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Replace elements in a set.

Parameters:

typethe type of the set.
setname of the set.
elementscomma delimited list of set elements.
XrlCmdError  policy_0_1_delete_set ( const string& set)

policy_0_1_delete_set

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a set.

Parameters:

setname of the set.
XrlCmdError  policy_0_1_add_to_set ( const string& type, const string& set, const string& element)

policy_0_1_add_to_set

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add an element to a set.

Parameters:

typethe type of the set.
setname of the set.
elementthe element to add.
XrlCmdError  policy_0_1_delete_from_set ( const string& type, const string& set, const string& element)

policy_0_1_delete_from_set

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete an element from a set.

Parameters:

typethe type of the set.
setname of the set.
elementthe element to delete.
XrlCmdError  policy_0_1_done_global_policy_conf ()

policy_0_1_done_global_policy_conf

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Commit the configuration.

XrlCmdError  policy_0_1_import ( const string& protocol, const string& policies, const string& modifier)

policy_0_1_import

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Replace import/export policies for a protocol. Will normally cause a delayed commit.

Parameters:

protocolprotocol for which policies must be replaced.
policiescomma separated list of policies.
modifiera match statement to insert in each policy.
XrlCmdError  policy_0_1_export ( const string& protocol, const string& policies, const string& modifier)

policy_0_1_export

[protected pure virtual]

XrlCmdError  policy_0_1_add_varmap ( const string& protocol, const string& variable, const string& type, const string& access, const uint32_t& id)

policy_0_1_add_varmap

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add a variable to the varmap configuration.

Parameters:

protocolthe protocol this variable is available to.
variablename of the variable.
typethe type of the variable.
accessthe permissions on the variable (r/rw).
idunique id for this var. Scoped by protocol.
XrlCmdError  policy_0_1_dump_state ( const uint32_t& id, string& state)

policy_0_1_dump_state

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Dump state of policy manager. To be used ONLY for debugging.

Parameters:

idwhich aspect of the internal state to dump.
XrlCmdError  policy_0_1_set_proto_target ( const string& protocol, const string& target)

policy_0_1_set_proto_target

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Update the mapping from protocols to their XRL target name.

Parameters:

protocolprotocol to update.
targetXRL target for the protocol.
XrlCmdError  cli_processor_0_1_process_command ( const string& processor_name, const string& cli_term_name, const uint32_t& cli_session_id, const string& command_name, const string& command_args, string& ret_processor_name, string& ret_cli_term_name, uint32_t& ret_cli_session_id, string& ret_command_output)

cli_processor_0_1_process_command

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Process a CLI command.

Parameters:

processor_namethe processor name for this command.
cli_term_namethe terminal name the command was entered from.
cli_session_idthe CLI session ID the command was entered from.
command_namethe command name to process.
command_argsthe command arguments to process.
ret_processor_namethe processor name to return back to the CLI.
ret_cli_term_namethe terminal name to return back.
ret_cli_session_idthe CLI session ID to return back.
ret_command_outputthe command output to return back.

Generated by: pavlin on kobe.xorp.net on Wed Jan 7 19:10:51 2009, using kdoc 2.0a54+XORP.