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;
       }
     }
     
    The schema path to identify an instance is openflow-protocol/packet-in
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Instance Methods Abstract 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()  
      • Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchGrouping

        getMatch
      • Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader

        getVersion, getXid
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • 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:
        org.opendaylight.yangtools.yang.common.Uint32 bufferId, or null if it is not present.
      • getTotalLen

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

        PacketInReason getReason()
        Return reason, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PacketInReason reason, or null if it is not present.
      • getTableId

        TableId getTableId()
        Return tableId, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.TableId tableId, or null if it is not present.
      • getCookie

        org.opendaylight.yangtools.yang.common.Uint64 getCookie()
        Return cookie, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 cookie, or null if it 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.
      • getInPort

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