com.h3c.of.lib.mp

## Class MBodyExperimenter

- java.lang.Object
- - com.h3c.of.lib.OpenflowStructure
  - - com.h3c.of.lib.mp.MBodyExperimenter

- All Implemented Interfaces:
    MultipartBody, Structure
  Direct Known Subclasses:
    MBodyMutableExperimenter

      public class MBodyExperimenter
      extends OpenflowStructure
      implements MultipartBody

  Represents an Experimenter extension to a multipart request or reply message; since 1.0.

  This class also represents the Vendor extension to a stats request or reply message that was introduced at version 1.0, and then replaced with this Experimenter extension starting with version 1.1. The Vender ID from the OpenFlow 1.0 specification is mapped to the Experimenter ID, which was introduced in the 1.1 specification.

  The experimenter ID uniquely identifies the experimenter. If the most significant byte is zero, the next three bytes are the experimenter's IEEE OUI. If the most significant byte is not zero, it is a value allocated by the Open Networking Foundation.

  The rest of the experimenter request/reply body is uninterpreted by standard OpenFlow processing and is arbitrarily defined by the corresponding experimenter.

- - ### Field Summary

    - ### Fields inherited from class com.h3c.of.lib.OpenflowStructure

      `version`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MBodyExperimenter(ProtocolVersion pv)` Constructs a multipart body EXPERIMENTER extension type.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `byte[]` | `getData()` Returns a copy of the experimenter-defined additional data.
    `ExperimenterId` | `getExpId()` Returns the experimenter ID (if we know it); null otherwise; Since 1.0.
    `int` | `getExpType()` Returns the experimenter-defined type; Since 1.3.
    `int` | `getId()` Returns the experimenter ID encoded as an int; Since 1.0.
    `int` | `getTotalLength()` Returns the total length of the body, in bytes.
    `String` | `toDebugString()` Returns a string representation useful for debugging.
    `String` | `toString()`

    - ### Methods inherited from class com.h3c.of.lib.OpenflowStructure

      `getVersion, hex, hex, validate`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface com.h3c.of.lib.mp.MultipartBody

      `validate`

    - ### Methods inherited from interface com.h3c.of.lib.Structure

      `getVersion`

- - ### Constructor Detail

    - #### MBodyExperimenter

          public MBodyExperimenter(ProtocolVersion pv)

      Constructs a multipart body EXPERIMENTER extension type.
      Parameters:
        `pv` - the protocol version

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `OpenflowStructure`

    - #### toDebugString

          public String toDebugString()

      Description copied from class: `OpenflowStructure`
      Returns a string representation useful for debugging. This default implementation delegates to `OpenflowStructure.toString()`, but subclasses are free to override this behavior.
      Specified by:
        `toDebugString` in interface `Structure`
      Overrides:
        `toDebugString` in class `OpenflowStructure`
      Returns:
        a (possibly multi-line) string representation of this message

    - #### getTotalLength

          public int getTotalLength()

      Description copied from interface: `MultipartBody`
      Returns the total length of the body, in bytes.
      Specified by:
        `getTotalLength` in interface `MultipartBody`
      Returns:
        the total length of the body

    - #### getId

          public int getId()

      Returns the experimenter ID encoded as an int; Since 1.0.
      Returns:
        the experimenter ID (encoded)

    - #### getExpId

          public ExperimenterId getExpId()

      Returns the experimenter ID (if we know it); null otherwise; Since 1.0.
      Returns:
        the experimenter ID

    - #### getExpType

          public int getExpType()

      Returns the experimenter-defined type; Since 1.3.

      For 1.0 messages, the value returned is 0. For 1.1 messages, the value returned is undetermined (but assumed to be 0).

      Returns:
        the experimenter-defined type

    - #### getData

          public byte[] getData()

      Returns a copy of the experimenter-defined additional data.
      Returns:
        the data

Copyright © 2014. All Rights Reserved.