## Uses of Class
com.h3c.of.lib.OpenflowStructure

- Packages that use OpenflowStructure
  Package | Description
  --- | ---
  com.h3c.of.lib | OpenFlow Protocol Library.
  com.h3c.of.lib.instr | Representations of OpenFlow Protocol Instructions and Actions.
  com.h3c.of.lib.match | Representations of OpenFlow Protocol Match Structures.
  com.h3c.of.lib.mp | Representations of OpenFlow Protocol Multipart Message bodies.
  com.h3c.of.lib.msg | Representations of OpenFlow Protocol Messages.

- - ### Uses of OpenflowStructure in com.h3c.of.lib

    Methods in com.h3c.of.lib that return OpenflowStructure
    Modifier and Type | Method and Description
    --- | ---
    `OpenflowStructure` | MutableStructure.`toImmutable()` Returns an immutable instance of this structure.

    Methods in com.h3c.of.lib with parameters of type OpenflowStructure
    Modifier and Type | Method and Description
    --- | ---
    `static void` | CommonUtils.`notMutable(OpenflowStructure struct)` Verifies that the argument is not mutable.

  - ### Uses of OpenflowStructure in com.h3c.of.lib.instr

    Subclasses of OpenflowStructure in com.h3c.of.lib.instr
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ActCopyTtlIn` Flow action `COPY_TTL_IN`.
    `class` | `ActCopyTtlOut` Flow action `COPY_TTL_OUT`.
    `class` | `ActDecMplsTtl` Flow action `DEC_MPLS_TTL`.
    `class` | `ActDecNwTtl` Flow action `DEC_NW_TTL`.
    `class` | `ActExperimenter` Flow action `EXPERIMENTER`.
    `class` | `ActGroup` Flow action `GROUP`.
    `class` | `ActHeader` Denotes an action, holding just the header information.
    `class` | `Action` Represents a Flow action.
    `class` | `ActOutput` Flow action `OUTPUT`.
    `class` | `ActPopMpls` Flow action `POP_MPLS`.
    `class` | `ActPopPbb` Flow action `POP_PBB`.
    `class` | `ActPopVlan` Flow action `POP_VLAN`.
    `class` | `ActPushMpls` Flow action `PUSH_MPLS`.
    `class` | `ActPushPbb` Flow action `PUSH_PBB`.
    `class` | `ActPushVlan` Flow action `PUSH_VLAN`.
    `class` | `ActSetField` Flow action `SET_FIELD`.
    `class` | `ActSetMplsTtl` Flow action `SET_MPLS_TTL`.
    `class` | `ActSetNwTtl` Flow action `SET_NW_TTL`.
    `class` | `ActSetQueue` Flow action `SET_QUEUE`.
    `class` | `InstrApplyActions` Flow Instruction `APPLY_ACTIONS`.
    `class` | `InstrClearActions` Flow Instruction `CLEAR_ACTIONS`.
    `class` | `InstrExperimenter` Flow Instruction `EXPERIMENTER`.
    `class` | `InstrGotoTable` Flow Instruction `GOTO_TABLE`.
    `class` | `InstrHeader` Denotes an instruction, holding just the header information.
    `class` | `InstrMeter` Flow Instruction `METER`.
    `class` | `InstrMutableAction` Mutable subclass of `InstrAction`.
    `class` | `InstrMutableApplyActions` Mutable version of `InstrApplyActions`.
    `class` | `InstrMutableWriteActions` Mutable version of `InstrWriteActions`.
    `class` | `Instruction` Represents a Flow instruction.
    `class` | `InstrWriteActions` Flow Instruction `WRITE_ACTIONS`.
    `class` | `InstrWriteMetadata` Flow Instruction `WRITE_METADATA`.

    Methods in com.h3c.of.lib.instr that return OpenflowStructure
    Modifier and Type | Method and Description
    --- | ---
    `OpenflowStructure` | InstrMutableApplyActions.`toImmutable()`
    `OpenflowStructure` | InstrMutableWriteActions.`toImmutable()`

  - ### Uses of OpenflowStructure in com.h3c.of.lib.match

    Subclasses of OpenflowStructure in com.h3c.of.lib.match
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Match` Represents an OpenFlow Match.
    `class` | `MatchField` Represents an OXM TLV Match field.
    `class` | `MfbArpOp` OXM Basic match field for `ARP_OP`.
    `class` | `MfbArpSha` OXM Basic match field for `ARP_SHA`.
    `class` | `MfbArpSpa` OXM Basic match field for `ARP_SPA`.
    `class` | `MfbArpTha` OXM Basic match field for `ARP_THA`.
    `class` | `MfbArpTpa` OXM Basic match field for `ARP_TPA`.
    `class` | `MfbEthDst` OXM Basic match field for `ETH_DST`.
    `class` | `MfbEthSrc` OXM Basic match field for `ETH_SRC`.
    `class` | `MfbEthType` OXM Basic match field for `ETH_TYPE`.
    `class` | `MfbIcmpv4Code` OXM Basic match field for `ICMPV4_CODE`.
    `class` | `MfbIcmpv4Type` OXM Basic match field for `ICMPV4_TYPE`.
    `class` | `MfbIcmpv6Code` OXM Basic match field for `ICMPV6_CODE`.
    `class` | `MfbIcmpv6Type` OXM Basic match field for `ICMPV6_TYPE`.
    `class` | `MfbInPhyPort` OXM Basic match field for `IN_PHY_PORT`.
    `class` | `MfbInPort` OXM Basic match field for `IN_PORT`.
    `class` | `MfbIpDscp` OXM Basic match field for `IP_DSCP`.
    `class` | `MfbIpEcn` OXM Basic match field for `IP_ECN`.
    `class` | `MfbIpProto` OXM Basic match field for `IP_PROTO`.
    `class` | `MfbIpv4Dst` OXM Basic match field for `IPV4_DST`.
    `class` | `MfbIpv4Src` OXM Basic match field for `IPV4_SRC`.
    `class` | `MfbIpv6Dst` OXM Basic match field for `IPV6_DST`.
    `class` | `MfbIpv6Exthdr` OXM Basic match field for `IPV6_EXTHDR`.
    `class` | `MfbIpv6Flabel` OXM Basic match field for `IPV6_FLABEL`.
    `class` | `MfbIpv6NdSll` OXM Basic match field for `IPV6_ND_SLL`.
    `class` | `MfbIpv6NdTarget` OXM Basic match field for `IPV6_ND_TARGET`.
    `class` | `MfbIpv6NdTll` OXM Basic match field for `IPV6_ND_TLL`.
    `class` | `MfbIpv6Src` OXM Basic match field for `IPV6_SRC`.
    `class` | `MfbMetadata` OXM Basic match field for `METADATA`.
    `class` | `MfbMplsBos` OXM Basic match field for `MPLS_BOS`.
    `class` | `MfbMplsLabel` OXM Basic match field for `MPLS_LABEL`.
    `class` | `MfbMplsTc` OXM Basic match field for `MPLS_TC`.
    `class` | `MfbPbbIsid` OXM Basic match field for `PBB_ISID`.
    `class` | `MfbSctpDst` OXM Basic match field for `SCTP_DST`.
    `class` | `MfbSctpSrc` OXM Basic match field for `SCTP_SRC`.
    `class` | `MfbTcpDst` OXM Basic match field for `TCP_DST`.
    `class` | `MfbTcpSrc` OXM Basic match field for `TCP_SRC`.
    `class` | `MfbTunnelId` OXM Basic match field for `TUNNEL_ID`.
    `class` | `MfbUdpDst` OXM Basic match field for `UDP_DST`.
    `class` | `MfbUdpSrc` OXM Basic match field for `UDP_SRC`.
    `class` | `MfbVlanPcp` OXM Basic match field for `VLAN_PCP`.
    `class` | `MfbVlanVid` OXM Basic match field for `VLAN_VID`.
    `class` | `MFieldBasic` Represents a Basic OXM TLV Match field.
    `class` | `MFieldBasicBigPort` Abstract OXM Basic match field superclass for `IN_PORT` and `IN_PHY_PORT`.
    `class` | `MFieldBasicHeader` Denotes an OXM Basic match field, holding just the header information.
    `class` | `MFieldBasicInt` Abstract OXM Basic match field superclass, holding an integer payload.
    `class` | `MFieldBasicIp` Abstract OXM Basic match field superclass for IP address payloads.
    `class` | `MFieldBasicLong` Abstract OXM Basic match field superclass, holding a long payload.
    `class` | `MFieldBasicMac` Abstract OXM Basic match field superclass for MAC address payloads.
    `class` | `MFieldBasicPort` Abstract OXM Basic match field superclass for `TCP_SRC/DST` etc.
    `class` | `MFieldExperimenter` Experimenter OpenFlow match field descriptor.
    `class` | `MFieldMinimal` A minimal OpenFlow match field descriptor.
    `class` | `MutableMatch` Mutable subclass of `Match`.

    Methods in com.h3c.of.lib.match that return OpenflowStructure
    Modifier and Type | Method and Description
    --- | ---
    `OpenflowStructure` | MutableMatch.`toImmutable()` Returns an immutable instance of this structure.

  - ### Uses of OpenflowStructure in com.h3c.of.lib.mp

    Subclasses of OpenflowStructure in com.h3c.of.lib.mp
    Modifier and Type | Class and Description
    --- | ---
    `class` | `MBodyDesc` Represents the description of an openflow datapath; Since 1.3.
    `class` | `MBodyExperimenter` Represents an Experimenter extension to a multipart request or reply message; since 1.0.
    `class` | `MBodyFlowStats` Represents a flow stats element; part of a reply to a flow-stats request multipart message; Since 1.0.
    `static class` | `MBodyFlowStats.Array` Represents an array of flow stats elements.
    `static class` | `MBodyFlowStats.MutableArray` A mutable array of flow stats elements.
    `class` | `MBodyFlowStatsRequest` Represents a flow stats request (multipart body); Since 1.0.
    `class` | `MBodyGroupDescStats` Represents a group description; part of a reply to a group-description request multipart message; since 1.1.
    `static class` | `MBodyGroupDescStats.Array` Represents an array of group description elements.
    `static class` | `MBodyGroupDescStats.MutableArray` A mutable array of group description elements.
    `class` | `MBodyGroupFeatures` Represents a group features element; part of a reply to a group features request multipart message; since 1.2.
    `class` | `MBodyGroupStats` Represents a group stats element; part of a reply to a group-stats request multipart message; Since 1.1.
    `static class` | `MBodyGroupStats.Array` Represents an array of group stats elements.
    `static class` | `MBodyGroupStats.MutableArray` A mutable array of group stats elements.
    `class` | `MBodyGroupStatsRequest` Represents a group stats request (multipart body); Since 1.1.
    `class` | `MBodyList<T extends MultipartBody>` An abstract base class for `MultipartBody` instances that are composed of a list (array) of elements.
    `class` | `MBodyMeterConfig` Represents a meter config element; part of a reply to a meter configuration request multipart message; Since 1.3.
    `static class` | `MBodyMeterConfig.Array` Represents an array of meter config elements.
    `static class` | `MBodyMeterConfig.MutableArray` A mutable array of meter config elements.
    `class` | `MBodyMeterConfigRequest` Represents a meter config request (multipart body); Since 1.3.
    `class` | `MBodyMeterFeatures` Represents a meter features element; part of a reply to a meter features request multipart message; Since 1.3.
    `class` | `MBodyMeterRequest` Base class for meter request (multipart body); Since 1.3.
    `class` | `MBodyMeterStats` Represents a meter stats element; part of a reply to a meter stats request multipart message; Since 1.3.
    `static class` | `MBodyMeterStats.Array` Represents an array of meter stats elements.
    `static class` | `MBodyMeterStats.MutableArray` A mutable array of meter stats elements.
    `class` | `MBodyMeterStatsRequest` Represents a meter stats request (multipart body); Since 1.3.
    `class` | `MBodyMutableDesc` Mutable subclass of `MBodyDesc`.
    `class` | `MBodyMutableExperimenter` Mutable subclass of `MBodyExperimenter`.
    `class` | `MBodyMutableFlowStats` Mutable subclass of `MBodyFlowStats`.
    `class` | `MBodyMutableFlowStatsRequest` Mutable subclass of `MBodyFlowStatsRequest`.
    `class` | `MBodyMutableGroupDescStats` Mutable subclass of `MBodyGroupDescStats`.
    `class` | `MBodyMutableGroupFeatures` Mutable subclass of `MBodyGroupFeatures`.
    `class` | `MBodyMutableGroupStats` Mutable subclass of `MBodyGroupStats`.
    `class` | `MBodyMutableGroupStatsRequest` Mutable subclass of `MBodyGroupStatsRequest`.
    `class` | `MBodyMutableMeterConfig` Mutable subclass of `MBodyMeterConfig`.
    `class` | `MBodyMutableMeterConfigRequest` Mutable subclass of `MBodyMeterConfigRequest`.
    `class` | `MBodyMutableMeterFeatures` Mutable subclass of `MBodyMeterFeatures`.
    `class` | `MBodyMutableMeterRequest` Base class for mutable subclass of `MBodyMeterRequest`.
    `class` | `MBodyMutableMeterStats` Mutable subclass of `MBodyMeterStats`.
    `class` | `MBodyMutableMeterStatsRequest` Mutable subclass of `MBodyMeterStatsRequest`.
    `class` | `MBodyMutablePortStats` Mutable subclass of `MBodyPortStats`.
    `class` | `MBodyMutablePortStatsRequest` Mutable subclass of `MBodyPortStatsRequest`.
    `class` | `MBodyMutableQueueStats` Mutable subclass of `MBodyQueueStats`.
    `class` | `MBodyMutableQueueStatsRequest` Mutable subclass of `MBodyQueueStatsRequest`.
    `class` | `MBodyMutableTableFeatures` Mutable subclass of `MBodyTableFeatures`.
    `class` | `MBodyMutableTableStats` Mutable subclass of `MBodyTableStats`.
    `class` | `MBodyPortDesc` Represents a port description; part of a reply to a port-description request multipart message; since 1.3.
    `static class` | `MBodyPortDesc.Array` Represents an array of port descriptions.
    `static class` | `MBodyPortDesc.MutableArray` A mutable array of port descriptions.
    `class` | `MBodyPortStats` Represents a port stats element; part of a reply to a port-stats request multipart message; Since 1.0.
    `static class` | `MBodyPortStats.Array` Represents an array of port stats elements.
    `static class` | `MBodyPortStats.MutableArray` A mutable array of port stats elements.
    `class` | `MBodyPortStatsRequest` Represents a port stats request (multipart body); Since 1.0.
    `class` | `MBodyQueueStats` Represents queue statistics; part of a reply to a queue-statistics request multipart message; since 1.0.
    `static class` | `MBodyQueueStats.Array` Represents an array of port descriptions.
    `static class` | `MBodyQueueStats.MutableArray` A mutable array of queue statistics.
    `class` | `MBodyQueueStatsRequest` Represents a Queue stats request (multipart body);Since 1.0.
    `class` | `MBodyTableFeatures` Represents a table features element; part of a reply to a table-features request multipart message; Since 1.3.
    `static class` | `MBodyTableFeatures.Array` Represents an array of table features elements.
    `static class` | `MBodyTableFeatures.MutableArray` A mutable array of table features elements.
    `class` | `MBodyTableStats` Represents a table stats element; part of a reply to a table-stats request multipart message; Since 1.0.
    `static class` | `MBodyTableStats.Array` Represents an array of table stats elements.
    `static class` | `MBodyTableStats.MutableArray` A mutable array of table stats elements.

    Methods in com.h3c.of.lib.mp that return OpenflowStructure
    Modifier and Type | Method and Description
    --- | ---
    `OpenflowStructure` | MBodyMutableQueueStats.`toImmutable()`
    `OpenflowStructure` | MBodyTableFeatures.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyGroupDescStats.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyPortDesc.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyMutableGroupDescStats.`toImmutable()`
    `OpenflowStructure` | MBodyPortStats.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyFlowStats.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyMutableFlowStats.`toImmutable()`
    `OpenflowStructure` | MBodyGroupStats.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyTableStats.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyMutableExperimenter.`toImmutable()`
    `OpenflowStructure` | MBodyMutableMeterStats.`toImmutable()`
    `OpenflowStructure` | MBodyMutableQueueStatsRequest.`toImmutable()`
    `OpenflowStructure` | MBodyMutableMeterConfigRequest.`toImmutable()`
    `OpenflowStructure` | MBodyMutableGroupStats.`toImmutable()`
    `OpenflowStructure` | MBodyMutableFlowStatsRequest.`toImmutable()`
    `OpenflowStructure` | MBodyMutableMeterConfig.`toImmutable()`
    `OpenflowStructure` | MBodyMutableMeterStatsRequest.`toImmutable()`
    `OpenflowStructure` | MBodyMutableGroupFeatures.`toImmutable()`
    `OpenflowStructure` | MBodyQueueStats.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyMutablePortStats.`toImmutable()`
    `OpenflowStructure` | MBodyMutableTableFeatures.`toImmutable()`
    `OpenflowStructure` | MBodyMutableGroupStatsRequest.`toImmutable()`
    `OpenflowStructure` | MBodyMutableTableStats.`toImmutable()`
    `OpenflowStructure` | MBodyMutablePortStatsRequest.`toImmutable()`
    `OpenflowStructure` | MBodyMutableMeterFeatures.`toImmutable()`
    `OpenflowStructure` | MBodyMeterStats.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyMeterConfig.MutableArray.`toImmutable()`
    `OpenflowStructure` | MBodyMutableDesc.`toImmutable()`

  - ### Uses of OpenflowStructure in com.h3c.of.lib.msg

    Subclasses of OpenflowStructure in com.h3c.of.lib.msg
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Bucket` Represents a bucket used in `groups`; Since 1.1.
    `class` | `HelloElement` Represents a Hello element.
    `class` | `HelloElemVersionBitmap` Hello element `VERSION_BITMAP`.
    `class` | `MeterBand` Represents a meter band, used in `OfmMeterMod` messages; Since 1.3.
    `class` | `MeterBandDrop` Represents a `MeterBand` of type `DROP`.
    `class` | `MeterBandDscpRemark` Represents a `MeterBand` of type `DSCP_REMARK`.
    `class` | `MeterBandExperimenter` Represents a `MeterBand` of type `EXPERIMENTER`.
    `class` | `MutableBucket` Mutable subclass of `Bucket`.
    `class` | `MutablePort` Mutable subclass of `Port`.
    `class` | `MutableQueue` Mutable subclass of `Queue`.
    `class` | `Port` Represents physical ports, switch-defined logical ports, and OpenFlow specified reserved ports.
    `class` | `Queue` Represents a queue that can attach to a port.

    Methods in com.h3c.of.lib.msg that return OpenflowStructure
    Modifier and Type | Method and Description
    --- | ---
    `OpenflowStructure` | MutablePort.`toImmutable()`
    `OpenflowStructure` | MutableBucket.`toImmutable()`
    `OpenflowStructure` | MutableQueue.`toImmutable()`

Copyright © 2014. All Rights Reserved.