libproto Globals


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

proto_node_cli.hh

proto_unit.hh

Global member Documentation

typedef XorpCallback1<int, const vector<string>& >::RefPtr CLIProcessCallback

CLIProcessCallback

#include <proto_node_cli.hh>


enum xorp_module_id { XORP_MODULE_MIN = 0, XORP_MODULE_NULL = 0, XORP_MODULE_FEA = 1, XORP_MODULE_MFEA = 2, XORP_MODULE_MLD6IGMP = 3, XORP_MODULE_PIMSM = 4, XORP_MODULE_PIMDM = 5, XORP_MODULE_BGMP = 6, XORP_MODULE_BGP = 7, XORP_MODULE_OSPF = 8, XORP_MODULE_RIP = 9, XORP_MODULE_CLI = 10, XORP_MODULE_RIB = 11, XORP_MODULE_RTRMGR = 12, XORP_MODULE_STATIC_ROUTES = 13, XORP_MODULE_FIB2MRIB = 14, XORP_MODULE_MAX }

xorp_module_id

#include <proto_unit.hh>


Note: the module IDs must be consistent with the _xorp_module_name definition in file proto_unit.cc (TODO: a temporary solution).

const char * xorp_module_name (int family, xorp_module_id module_id)

xorp_module_name

#include <proto_unit.hh>


Get the module name for a given address family and module ID.

TODO: temporary, all names are listed in "_xorp_module_name[][]" in proto_unit.cc.

Parameters:

familythe address family (e.g., AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
module_idthe module ID (xorp_module_id).

Returns: C-style string with the module name.

xorp_module_id  xorp_module_name2id (const char *module_name)

xorp_module_name2id

#include <proto_unit.hh>


Convert from module name to module ID.

The module name must be a valid name returned by xorp_module_name().

Parameters:

module_namethe module name.

Returns: the module ID (xorp_module_id) if module_name is valid, otherwise XORP_MODULE_NULL.

bool  is_valid_module_id (xorp_module_id module_id)

is_valid_module_id

#include <proto_unit.hh>


Test if a module ID is valid.

A valid module ID is defined as valid if it is in the interval [XORP_MODULE_MIN, XORP_MODULE_MAX).

Parameters:

module_idthe module ID to test (xorp_module_id).

Returns: true if module_id is valid, otherwise false.


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