Package org.opendaylight.openflowplugin.api.openflow.device.handlers

Interface MultiMsgCollector<T extends OfHeader>

All Known Implementing Classes:
MultiMsgCollectorImpl
public interface MultiMsgCollector<T extends OfHeader>
Collects multipart msgs from device by provided XID and returns them to the caller as request/collection response one-to-one contract.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMultipartMsg(@NonNull T reply, boolean reqMore, @Nullable EventIdentifier eventIdentifier)
    Method adds a reply multipart message to the collection and if the message has marker "I'M A LAST" method set whole Collection to Future object and remove from cache.
    void
    endCollecting(@Nullable EventIdentifier eventIdentifier)
    Null response could be a valid end multipart collecting event for barrier response scenario.

  • Method Details

    • addMultipartMsg

      void addMultipartMsg(@NonNull T reply, boolean reqMore, @Nullable EventIdentifier eventIdentifier)
      Method adds a reply multipart message to the collection and if the message has marker "I'M A LAST" method set whole Collection to Future object and remove from cache.
      Parameters:
      reply - reply
      reqMore - request more replies
      eventIdentifier - event identifier

    • endCollecting

      void endCollecting(@Nullable EventIdentifier eventIdentifier)
      Null response could be a valid end multipart collecting event for barrier response scenario. We are not able to resolve an issue (it is or it isn't barrier scenario) so we have to finish collecting multipart messages successfully.
      Parameters:
      eventIdentifier - event identifier