Package org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709

Interface PacketIn

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, RawPacket
All Known Subinterfaces:
PacketInMessage, PacketReceived
@Generated("mdsal-binding-generator") public interface PacketIn extends org.opendaylight.yangtools.yang.binding.DataObject, RawPacket

This class represents the following YANG schema fragment defined in module packet-processing 

 grouping packet-in {
   leaf connection-cookie {
     type connection-cookie;
   }
   leaf flow-cookie {
     type flow-type:flow-cookie;
   }
   leaf table-id {
     type table-type:table-id;
   }
   leaf packet-in-reason {
     type identityref {
       base packet-in-reason;
     }
   }
   uses raw-packet;
 }

  • Field Details

    • QNAME

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

  • Method Details

    • implementedInterface

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

    • getConnectionCookie

      ConnectionCookie getConnectionCookie()
      Return connectionCookie, or null if it is not present.
      Returns:
      ConnectionCookie connectionCookie, or null if it is not present.

    • requireConnectionCookie

      default @NonNull ConnectionCookie requireConnectionCookie()
      Return connectionCookie, guaranteed to be non-null.
      Returns:
      ConnectionCookie connectionCookie, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if connectionCookie is not present

    • getFlowCookie

      FlowCookie getFlowCookie()
      Return flowCookie, or null if it is not present.
      Returns:
      FlowCookie flowCookie, or null if it is not present.

    • requireFlowCookie

      default @NonNull FlowCookie requireFlowCookie()
      Return flowCookie, guaranteed to be non-null.
      Returns:
      FlowCookie flowCookie, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if flowCookie 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

    • getPacketInReason

      PacketInReason getPacketInReason()
      Return packetInReason, or null if it is not present.
      Returns:
      PacketInReason packetInReason, or null if it is not present.

    • requirePacketInReason

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