class ProtoRegister Base class for protocol registration. More... Definition #include <proto_register.hh> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

• int  add_protocol (const string& module_instance_name, x_module_id module_id)
• int  delete_protocol (const string& module_instance_name, x_module_id module_id)
• bool  is_registered (x_module_id module_id) const
• bool  is_registered (const string& module_instance_name, x_module_id module_id) const
• const list<string>&  module_instance_name_list (x_module_id module_id) const

Detailed Description

Add/register a protocol instance.

Parameters:

module_instance_name	the module instance name of the protocol to add/register.
module_id	the module ID (x_module_id) of the protocol to add/register.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Delete/deregister a protocol instance.

Parameters:

module_instance_name	the module instance name of the protocol to delete/deregister.
module_id	the module ID (x_module_id) of the protocol to delete/deregister.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[const]

Test if any instance of a given protocol is registered.

Parameters:

module_id

the module ID (x_module_id) of the protocol to test.

Returns: true if any instance of the given protocol is registered, otherwise false.

[const]

Test if a protocol module instance is registered.

Parameters:

module_instance_name	the module instance name of the protocol to test.
module_id	the module ID (x_module_id) of the protocol to test.

Returns: true if the module is registered, otherwise false.

[const]

Get the list of all registered protocol instances for a given protocol.

Parameters:

module_id

the module ID (x_module_id) of the protocol.

Returns: the list of all registered protocol instances for the given protocol.