rtrmgr Globals

Annotated List  Files  Globals  Hierarchy  Index  Top

cli.hh

• enum CliModeType { CLI_MODE_NONE = 0, CLI_MODE_OPERATIONAL = 1, CLI_MODE_CONFIGURE = 2, CLI_MODE_TEXTENTRY = 3 }

config_operators.hh

• enum ConfigOperator { OP_NONE = 0, OP_EQ = 1, OP_NE = 2, OP_LT = 3, OP_LTE = 4, OP_GT = 5, OP_GTE = 6, OP_IPNET_EQ = 7, OP_IPNET_NE = 8, OP_IPNET_LT = 9, OP_IPNET_GT = 10, OP_IPNET_LE = 11, OP_IPNET_GE = 12, MAX_COMPARATOR = OP_IPNET_GE, OP_ASSIGN = 101, OP_ADD = 102, OP_SUB = 103, OP_DEL = 104, MAX_MODIFIER = OP_DEL }
• extern string  operator_to_str (ConfigOperator op)
• extern ConfigOperator  lookup_operator (const string& s)

glob_win32.h

• typedef struct --
• int  glob ( char const *pattern , int flags , int (*errfunc)(char const *, int) , glob_t *pglob)
• void  globfree (glob_t *pglob)

template_tree_node.hh

• enum TTNodeType { NODE_VOID = 0, NODE_TEXT = 1, NODE_UINT = 2, NODE_INT = 3, NODE_BOOL = 4, NODE_TOGGLE = 4, NODE_IPV4 = 5, NODE_IPV4NET = 6, NODE_IPV6 = 7, NODE_IPV6NET = 8, NODE_MACADDR = 9, NODE_URL_FILE = 10, NODE_URL_FTP = 11, NODE_URL_HTTP = 12, NODE_URL_TFTP = 13, NODE_ARITH = 14, NODE_UINTRANGE = 15, NODE_IPV4RANGE = 16, NODE_IPV6RANGE = 17 }
• enum TTSortOrder { ORDER_UNSORTED, ORDER_SORTED_NUMERIC, ORDER_SORTED_ALPHABETIC }

util.hh

• void  xorp_path_init (const char* argv0)
• const string&  xorp_binary_root_dir ()
• const string&  xorp_config_root_dir ()
• string  xorp_template_dir ()
• string  xorp_xrl_targets_dir ()
• string  xorp_boot_file ()
• string&  unquote (string& s)
• string  unquote (const string& s)
• bool  is_quotable_string (const string& s)
• string  find_executable_filename (const string& program_filename)
• void  find_executable_filename_and_arguments (const string& program_request, string& executable_filename, string& program_arguments)

xrldb.hh

• enum XRLMatchType { MATCH_FAIL = 0x0, MATCH_XRL = 0x1, MATCH_RSPEC = 0x2, MATCH_ALL = MATCH_XRL | MATCH_RSPEC }

Global member Documentation

#include <cli.hh>

#include <config_operators.hh>

#include <config_operators.hh>

#include <config_operators.hh>

#include <glob_win32.h>

\brief Result structure for glob()

This structure is used by glob() to return the results of the search.

#include <glob_win32.h>

\brief Generates pathnames matching a pattern

This function is a pathname generator that implements the rules for file name pattern matching used by the UNIX shell.

\param pattern The pattern controlling the search \param flags A combination of the <b>GLOB_*</b> flags \param errfunc [Not currently supported. Must be NULL] \param pglob Pointer to a glob_t structure to receive the search results \return 0 on success, otherwise one of the <b>GLOB_*</b> error codes

#include <glob_win32.h>

\brief Frees the results of a call to glob

This function releases any memory allocated in a call to glob. It must always be called for a successful call to glob.

\param pglob Pointer to a glob_t structure to receive the search results

#include <template_tree_node.hh>

#include <template_tree_node.hh>

#include <util.hh>

Initialize paths.

This method attempts to determine where XORP is being run from and initialize paths accordingly. If the environment variable XORP_ROOT is set, this overrides the path determination algorithm.

This method should be called before any of the following methods:

• xorp_binary_root_dir()
• xorp_config_root_dir()
• xorp_template_dir()
• xorp_xrl_targets_dir()
• xorp_boot_file()

Parameters:

#include <util.hh>

Return top-level directory of xorp binaries.

xorp_path_init() must be called before this method will return a sane value.

#include <util.hh>

Return top-level directory of xorp configuration files.

xorp_path_init() must be called before this method will return a sane value.

#include <util.hh>

Return the path of the xorp templates directory given the xorp_root path.

xorp_path_init() must be called before this method will return a sane value.

#include <util.hh>

Return the path of the xrl targets directory given the xorp_root path.

xorp_path_init() must be called before this method will return a sane value.

#include <util.hh>

Return path of boot config file to be used given the xorp_root path.

xorp_path_init() must be called before this method will return a sane value.

#include <util.hh>

Remove enclosing quotes from string.

Parameters:

Returns: string with quotes removed.

#include <util.hh>

Remove enclosing quotes from string value.

Parameters:

Returns: copy of string with quotes removed.

#include <util.hh>

Test if a string should be in quotes. A string should be in quotes if it contains a character that is not a letter or a digit.

Parameters:

Returns: true if the string should be in quotes, otherwise false.

#include <util.hh>

Find the name (including the path) of an executable program.

If the filename contains an absolute pathname, then we return the program filename or an error if the program is not executable. If the pathname is relative, then first we consider the XORP binary root directory, and then the directories in the user's PATH environment.

Parameters:

Returns: the name of the executable program on success, empty string on failure.

#include <util.hh>

Find the name (including the path) and the arguments of an executable program and return them by reference.

If the filename contains an absolute pathname, then we return-by-reference the program filename or an error if the program is not executable. If the pathname is relative, then first we consider the XORP binary root directory, and then the directories in the user's PATH environment.

Parameters:

#include <xrldb.hh>