class PolicyTarget

The XORP Policy target. More...

 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Public Members


Detailed Description

This is the class that will be called to perform operation from the xrl target.

static string policy_target_name

policy_target_name

 PolicyTarget (XrlStdRouter& rtr)

PolicyTarget

Parameters:

rtrXrl router used by this XORP process.
bool  running ()

running

Returns: true if process is running.

void  shutdown ()

shutdown

Shutdown the process.

void  create_term (const string& policy, const string& term)

create_term

Attempts to create a term. Terms are appended in existing policies [currently no way of inserting a term in a specific position].

Exception is thrown on error.

Parameters:

policypolicy in which term should be created.
termname of term to create.
void  delete_term (const string& policy, const string& term)

delete_term

Attempts to delete a term.

Exception is thrown on error.

Parameters:

policypolicy in which term should be deleted.
termname of the term.
void  update_term_source (const string& policy, const string& term, const string& source)

update_term_source

Updates the source block of a term.

Exception is thrown on error.

Parameters:

policypolicy in which term should be updated.
termterm which should be updated.
sourceun-parsed source configuration block of term.
void  update_term_dest (const string& policy, const string& term, const string& dest)

update_term_dest

Updates the source block of a term.

Exception is thrown on error.

Parameters:

policypolicy in which term should be updated.
termterm which should be updated.
destun-parsed dest configuration block of term.
void  update_term_action (const string& policy, const string& term, const string& action)

update_term_action

Updates the source block of a term.

Exception is thrown on error.

Parameters:

policypolicy in which term should be updated.
termterm which should be updated.
actionun-parsed action configuration block of term.
void  create_policy (const string& policy)

create_policy

Attempts to create a policy.

Exception is thrown on error.

Parameters:

policyname of policy to create.
void  delete_policy (const string& policy)

delete_policy

Attempts to delete a policy.

Exception is thrown on error.

Parameters:

policyname of policy to delete.
void  create_set (const string& name)

create_set

Attempts to create a policy.

Exception is thrown on error.

Parameters:

namename of set to create.
void  update_set (const string& name, const string& elements)

update_set

Attempts to update set elements.

Exception is thrown on error.

Parameters:

namename of set to update.
elementsthe elements of a set comma separated.
void  delete_set (const string& name)

delete_set

Attempts to delete a set.

Exception is thrown on error.

Parameters:

namename of set to create.
void  update_import (const string& protocol, const string& policies)

update_import

Updates the import policy list for a protocol and triggers a delayed commit.

Parameters:

protocolprotocol for which to update imports.
policiescomma separated policy list.
void  update_export (const string& protocol, const string& policies)

update_export

Updates the export policy list for a protocol and triggers a delayed commit.

Parameters:

protocolprotocol for which to update imports.
policiescomma separated policy list.
void  commit (uint32_t msec)

commit

Commit all configuration changes, but trigger a delayed update to the actual policy filters.

Parameters:

msecmilliseconds after which policy filters should be updated.
string  get_conf ()

get_conf

Returns: string representation of configuration.

void  birth (const string& tclass, const string& tinstance)

birth

Announce birth of a XORP process.

Parameters:

tclasstarget class.
tinstancetarget instance of class.
void  death (const string& tclass, const string& tinstance)

death

Announce death of a XORP process.

Parameters:

tclasstarget class.
tinstancetarget instance of class.
void  configure_varmap (const string& conf)

configure_varmap

Configure the variable map used for semantic checking. This should be initialized only once at startup.

Dynamic configuration may easily be implemented by invalidiating policies in the configuration class.

Dynamic addition of variables should be safe. It is the removal and update which needs to trigger a policy to be flagged as modified.

Parameters:

confun-parsed configuration of variable map.

Generated by: pavlin on possum.icir.org on Wed Apr 13 21:53:13 2005, using kdoc $.