libproto Globals


Annotated List
Files
Globals
Hierarchy
Index

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 x_module_id { X_MODULE_MIN = 0, X_MODULE_NULL = 0, X_MODULE_FEA = 1, X_MODULE_MFEA = 2, X_MODULE_MLD6IGMP = 3, X_MODULE_PIMSM = 4, X_MODULE_PIMDM = 5, X_MODULE_BGMP = 6, X_MODULE_BGP = 7, X_MODULE_OSPF = 8, X_MODULE_RIP = 9, X_MODULE_CLI = 10, X_MODULE_MAX }

x_module_id

#include <proto_unit.hh>

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

const char * x_module_name (int family, x_module_id module_id)

x_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 "_x_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 (x_module_id).

Returns: C-style string with the module name.

x_module_id  x_module_name2id (const char *module_name)

x_module_name2id

#include <proto_unit.hh>

Convert from module name to module ID.

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

Parameters:
module_namethe module name.

Returns: the module ID (x_module_id) if module_name is valid, otherwise X_MODULE_NULL.

bool  is_valid_module_id (x_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 [X_MODULE_MIN, X_MODULE_MAX).

Parameters:
module_idthe module ID to test (x_module_id).

Returns: true if module_id is valid, otherwise false.


Generated by: pavlin on possum.icir.org on Mon Mar 10 19:34:51 2003, using kdoc 2.0a54+XORP.