Simple Module PIMInterfaceTable

Package: inet.routing.pim.tables
File: src/inet/routing/pim/tables/PIMInterfaceTable.ned

The PIMInterfaceTable module contains the PIM specific configuration parameters and state of the interfaces on which PIM is enabled.

PIM routers must contain an instance of this module.

The configuration file must contain <interface> elements under the document root with the following attributes:

@mode: optional attribute, possible values are "dense" and "sparse". If missing then PIM is not used on that interface, otherwise it operates in the specified mode.
@state-refresh: optional boolean attribute, default is "false". If it is "true", then the router will send SR messages on this interface.

Additionally each <interface> element may contain @hosts, @names, @towards, @among attributes to select the interfaces which the PIM parameters are applied to (see IPv4NetworkConfigurator).

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Used in compound modules:

Name	Type	Description
PIMRouting	compound module	(no description)

Parameters:

Name	Type	Default value	Description
interfaceTableModule	string
pimConfig	xml	xml("")

Properties:

Name	Value	Description
display	i=block/table

Source code:

//
// The PIMInterfaceTable module contains the PIM specific configuration
// parameters and state of the interfaces on which PIM is enabled.
//
// PIM routers must contain an instance of this module.
//
// The configuration file must contain <interface> elements under
// the document root with the following attributes:
//
// - @mode:          optional attribute, possible values are "dense" and "sparse".
//                   If missing then PIM is not used on that interface, otherwise
//                   it operates in the specified mode.
// - @state-refresh: optional boolean attribute, default is "false".
//                   If it is "true", then the router will send SR messages
//                   on this interface.
//
// Additionally each <interface> element may contain
// @hosts, @names, @towards, @among attributes to select the
// interfaces which the PIM parameters are applied to (see ~IPv4NetworkConfigurator).
//
simple PIMInterfaceTable
{
    parameters:
        @display("i=block/table");
        string interfaceTableModule;
        xml pimConfig = default(xml("<config/>"));
}