Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.packet.rev160620

Interface RouterAdvertisementPacket

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<RouterAdvertisementPacket>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Ipv6NeighborDiscoveryData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, EthernetHeader, Icmp6Header, Ipv6Header
    @Generated("mdsal-binding-generator")
public interface RouterAdvertisementPacket
extends org.opendaylight.yangtools.yang.binding.ChildOf<Ipv6NeighborDiscoveryData>, org.opendaylight.yangtools.yang.binding.Augmentable<RouterAdvertisementPacket>, EthernetHeader, Ipv6Header, Icmp6Header

    This class represents the following YANG schema fragment defined in module ipv6-neighbor-discovery 

     container router-advertisement-packet {
   uses ethernet-header;
   uses ipv6-header;
   uses icmp6-header;
   leaf cur-hop-limit {
     type uint8;
   }
   leaf flags {
     type uint8;
   }
   leaf router-lifetime {
     type uint16;
   }
   leaf reachable-time {
     type uint32;
   }
   leaf retrans-time {
     type uint32;
   }
   leaf option-source-addr {
     type uint8;
   }
   leaf source-addr-length {
     type uint8;
   }
   leaf source-ll-address {
     type yang:mac-address;
   }
   leaf option-mtu {
     type uint8;
   }
   leaf option-mtu-length {
     type uint8;
   }
   leaf mtu {
     type uint32;
   }
   list prefix-list {
     key prefix;
     leaf option-type {
       type uint8;
     }
     leaf option-length {
       type uint8;
     }
     leaf prefix-length {
       type uint8;
     }
     leaf flags {
       type uint8;
     }
     leaf valid-lifetime {
       type uint32;
     }
     leaf preferred-lifetime {
       type uint32;
     }
     leaf reserved {
       type uint32;
     }
     leaf prefix {
       type inet:ipv6-prefix;
     }
   }
 }
    The schema path to identify an instance is ipv6-neighbor-discovery/router-advertisement-packet

    To create instances of this class use RouterAdvertisementPacketBuilder.

    See Also:
    RouterAdvertisementPacketBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • bindingHashCode

        static int bindingHashCode​(@NonNull RouterAdvertisementPacket obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull RouterAdvertisementPacket thisObj,
                             java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull RouterAdvertisementPacket obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • getCurHopLimit

        org.opendaylight.yangtools.yang.common.Uint8 getCurHopLimit()
        Return curHopLimit, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 curHopLimit, or null if it is not present.

      • getFlags

        org.opendaylight.yangtools.yang.common.Uint8 getFlags()
        Return flags, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 flags, or null if it is not present.

      • getRouterLifetime

        org.opendaylight.yangtools.yang.common.Uint16 getRouterLifetime()
        Return routerLifetime, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 routerLifetime, or null if it is not present.

      • getReachableTime

        org.opendaylight.yangtools.yang.common.Uint32 getReachableTime()
        Return reachableTime, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 reachableTime, or null if it is not present.

      • getRetransTime

        org.opendaylight.yangtools.yang.common.Uint32 getRetransTime()
        Return retransTime, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 retransTime, or null if it is not present.

      • getOptionSourceAddr

        org.opendaylight.yangtools.yang.common.Uint8 getOptionSourceAddr()
        Return optionSourceAddr, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 optionSourceAddr, or null if it is not present.

      • getSourceAddrLength

        org.opendaylight.yangtools.yang.common.Uint8 getSourceAddrLength()
        Return sourceAddrLength, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 sourceAddrLength, or null if it is not present.

      • getSourceLlAddress

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getSourceLlAddress()
        Return sourceLlAddress, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress sourceLlAddress, or null if it is not present.

      • getOptionMtu

        org.opendaylight.yangtools.yang.common.Uint8 getOptionMtu()
        Return optionMtu, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 optionMtu, or null if it is not present.

      • getOptionMtuLength

        org.opendaylight.yangtools.yang.common.Uint8 getOptionMtuLength()
        Return optionMtuLength, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 optionMtuLength, or null if it is not present.

      • getMtu

        org.opendaylight.yangtools.yang.common.Uint32 getMtu()
        Return mtu, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 mtu, or null if it is not present.

      • getPrefixList

        @Nullable java.util.Map<PrefixListKey,​PrefixList> getPrefixList()
        Return prefixList, or null if it is not present.
        Returns:
        java.util.Map prefixList, or null if it is not present.

      • nonnullPrefixList

        default @NonNull java.util.Map<PrefixListKey,​PrefixList> nonnullPrefixList()
        Return prefixList, or an empty list if it is not present.
        Returns:
        java.util.Map prefixList, or an empty list if it is not present.