org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev180313.routing.state.control.plane.protocols

Interface ControlPlaneProtocol

All Superinterfaces:

Augmentable<ControlPlaneProtocol>, BindingObject, ChildOf<ControlPlaneProtocols>, DataContainer, DataObject, Identifiable<ControlPlaneProtocolKey>

public interface ControlPlaneProtocol
extends ChildOf<ControlPlaneProtocols>, Augmentable<ControlPlaneProtocol>, Identifiable<ControlPlaneProtocolKey>

State data of a control-plane protocol instance. An implementation MUST provide exactly one system-controlled instance of the 'direct' pseudo-protocol. Instances of other control-plane protocols MAY be created by configuration.

This class represents the following YANG schema fragment defined in module ietf-routing

 list control-plane-protocol {
   key "type name";
   status obsolete;
   leaf type {
     type identityref {
       base control-plane-protocol;
     }
     status obsolete;
   }
   leaf name {
     type string;
     status obsolete;
   }
 }
 

The schema path to identify an instance is ietf-routing/routing-state/control-plane-protocols/control-plane-protocol

To create instances of this class use ControlPlaneProtocolBuilder.

See Also:

ControlPlaneProtocolBuilder, ControlPlaneProtocolKey

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method and Description
@Nullable String	getName() The name of the control-plane protocol instance.For system-controlled instances, this name ispersistent, i.e., it SHOULD NOT change acrossreboots.
@Nullable Class<? extends ControlPlaneProtocol>	getType() Type of the control-plane protocol.
ControlPlaneProtocolKey	key() Returns an unique key for the object.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation

Field Detail

QNAME

static final org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

getType

@Nullable Class<? extends ControlPlaneProtocol> getType()

Type of the control-plane protocol.

Returns:

java.lang.Class type, or null if not present

getName

@Nullable String getName()

The name of the control-plane protocol instance.For system-controlled instances, this name ispersistent, i.e., it SHOULD NOT change acrossreboots.

Returns:

java.lang.String name, or null if not present

key

ControlPlaneProtocolKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<ControlPlaneProtocolKey>

Returns:

Key for the object