Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Interface PacketIn

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, MatchGrouping, OfHeader
    All Known Subinterfaces:
    PacketInMessage
    @Generated("mdsal-binding-generator")
public interface PacketIn
extends org.opendaylight.yangtools.yang.binding.DataObject, OfHeader, MatchGrouping

    This class represents the following YANG schema fragment defined in module openflow-protocol 

     grouping packet-in {
   uses ofHeader;
   leaf buffer-id {
     type uint32;
   }
   leaf total-len {
     type uint16;
   }
   leaf reason {
     type oft:packet-in-reason;
   }
   leaf table-id {
     type oft:table-id;
   }
   leaf cookie {
     type uint64;
   }
   uses oxm:match-grouping;
   leaf data {
     type binary;
   }
   leaf in-port {
     type uint16;
   }
 }

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
      Return bufferId, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint64 getCookie()
      Return cookie, or null if it is not present.
      byte[] getData()
      Return data, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint16 getInPort()
      Return inPort, or null if it is not present.
      PacketInReason getReason()
      Return reason, or null if it is not present.
      TableId getTableId()
      Return tableId, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint16 getTotalLen()
      Return totalLen, or null if it is not present.
      Class<? extends PacketIn> implementedInterface()  
      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireBufferId()
      Return bufferId, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireCookie()
      Return cookie, guaranteed to be non-null.
      default byte @NonNull [] requireData()
      Return data, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireInPort()
      Return inPort, guaranteed to be non-null.
      default @NonNull PacketInReason requireReason()
      Return reason, guaranteed to be non-null.
      default @NonNull TableId requireTableId()
      Return tableId, guaranteed to be non-null.
      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireTotalLen()
      Return totalLen, guaranteed to be non-null.

      • Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchGrouping

        getMatch

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.

    • Method Detail

      • implementedInterface

        Class<? extends PacketIn> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface MatchGrouping
        Specified by:
        implementedInterface in interface OfHeader

      • getBufferId

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

      • requireBufferId

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireBufferId()
        Return bufferId, guaranteed to be non-null.
        Returns:
        Uint32 bufferId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if bufferId is not present

      • getTotalLen

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

      • requireTotalLen

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireTotalLen()
        Return totalLen, guaranteed to be non-null.
        Returns:
        Uint16 totalLen, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if totalLen is not present

      • getReason

        PacketInReason getReason()
        Return reason, or null if it is not present.
        Returns:
        PacketInReason reason, or null if it is not present.

      • requireReason

        default @NonNull PacketInReason requireReason()
        Return reason, guaranteed to be non-null.
        Returns:
        PacketInReason reason, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if reason is not present

      • getTableId

        TableId getTableId()
        Return tableId, or null if it is not present.
        Returns:
        TableId tableId, or null if it is not present.

      • requireTableId

        default @NonNull TableId requireTableId()
        Return tableId, guaranteed to be non-null.
        Returns:
        TableId tableId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if tableId is not present

      • getCookie

        org.opendaylight.yangtools.yang.common.Uint64 getCookie()
        Return cookie, or null if it is not present.
        Returns:
        Uint64 cookie, or null if it is not present.

      • requireCookie

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireCookie()
        Return cookie, guaranteed to be non-null.
        Returns:
        Uint64 cookie, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if cookie is not present

      • getData

        byte[] getData()
        Return data, or null if it is not present.
        Returns:
        byte[] data, or null if it is not present.

      • requireData

        default byte @NonNull [] requireData()
        Return data, guaranteed to be non-null.
        Returns:
        byte[] data, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if data is not present

      • getInPort

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

      • requireInPort

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireInPort()
        Return inPort, guaranteed to be non-null.
        Returns:
        Uint16 inPort, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inPort is not present