# Package com.h3c.of.lib.msg

Representations of OpenFlow Protocol Messages.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  Message | Provides access to the attributes common to all `OpenflowMessage`s.
  MessageFuture | The result of an asynchronous OpenFlow message request/reply interaction.
  MutableMessage | Implemented by OpenFlow message classes that provide mutators for setting the state of the message.

- Class Summary
  Class | Description
  --- | ---
  Bucket | Represents a bucket used in `groups`; Since 1.1.
  BucketFactory | Provides facilities for parsing, creating and encoding `Bucket` instances.
  DataPathMessageFuture | A `DefaultMessageFuture` that is associated with a datapath.
  DefaultMessageFuture | Default implementation of a `MessageFuture`.
  HelloElement | Represents a Hello element.
  HelloElementFactory | Provides facilities for parsing, creating and encoding `HelloElement` instances.
  HelloElemVersionBitmap | Hello element `VERSION_BITMAP`.
  MessageFactory | Provides facilities for parsing, creating, copying and encoding OpenFlow messages.
  MessageFutureBag | A message future aggregate, allowing the consumer to wait for completion of a number of message futures.
  MessageUtils | Provides utility methods for working with OpenFlow messages.
  MeterBand | Represents a meter band, used in `OfmMeterMod` messages; Since 1.3.
  MeterBandDrop | Represents a `MeterBand` of type `DROP`.
  MeterBandDscpRemark | Represents a `MeterBand` of type `DSCP_REMARK`.
  MeterBandExperimenter | Represents a `MeterBand` of type `EXPERIMENTER`.
  MeterBandFactory | Provides facilities for parsing, creating and encoding `MeterBand` instances.
  MutableBucket | Mutable subclass of `Bucket`.
  MutablePort | Mutable subclass of `Port`.
  MutableQueue | Mutable subclass of `Queue`.
  OfmBarrierReply | Represents an OpenFlow BARRIER_REPLY message; Since 1.0.
  OfmBarrierRequest | Represents an OpenFlow BARRIER_REQUEST message; Since 1.0.
  OfmEchoReply | Represents an OpenFlow ECHO REPLY message; Since 1.0.
  OfmEchoRequest | Represents an OpenFlow ECHO REQUEST message; Since 1.0.
  OfmError | Represents an OpenFlow ERROR message; Since 1.0.
  OfmErrorExper | Represents an OpenFlow EXPERIMENTER ERROR message; Since 1.2.
  OfmExperimenter | Represents an OpenFlow EXPERIMENTER message; since 1.0.
  OfmFeaturesReply | Represents an OpenFlow FEATURES_REPLY message; Since 1.0.
  OfmFeaturesRequest | Represents an OpenFlow FEATURES_REQUEST message; Since 1.0.
  OfmFlowMod | Represents an OpenFlow FLOW_MOD message; Since 1.0.
  OfmFlowRemoved | Represents an Openflow FLOW_REMOVED message; Since 1.0.
  OfmGetAsyncReply | Represents an OpenFlow GET_ASYNC_REPLY message; Since 1.3.
  OfmGetAsyncRequest | Represents an OpenFlow GET_ASYNC_REQUEST message; Since 1.3.
  OfmGetConfigReply | Represents an OpenFlow GET_CONFIG_REPLY message; Since 1.0.
  OfmGetConfigRequest | Represents an OpenFlow GET_CONFIG_REQUEST message; Since 1.0.
  OfmGroupMod | Represents an OpenFlow GROUP_MOD message; Since 1.1.
  OfmHello | Represents an OpenFlow HELLO message; Since 1.0.
  OfmMeterMod | Represents an OpenFlow METER_MOD message; Since 1.3.
  OfmMultipartReply | Represents an OpenFlow MULTIPART_REPLY message; Since 1.3 (but see note).
  OfmMultipartRequest | Represents an OpenFlow MULTIPART_REQUEST message; Since 1.3 (but see note).
  OfmMutableBarrierReply | Mutable subclass of `OfmBarrierReply`.
  OfmMutableBarrierRequest | Mutable subclass of `OfmBarrierRequest`.
  OfmMutableEchoReply | Mutable subclass of `OfmEchoReply`.
  OfmMutableEchoRequest | Mutable subclass of `OfmEchoRequest`.
  OfmMutableError | Mutable subclass of `OfmError`.
  OfmMutableErrorExper | Mutable subclass of `OfmErrorExper`.
  OfmMutableExperimenter | Mutable subclass of `OfmExperimenter`.
  OfmMutableFeaturesReply | Mutable subclass of `OfmFeaturesReply`.
  OfmMutableFeaturesRequest | Mutable subclass of `OfmFeaturesRequest`.
  OfmMutableFlowMod | Mutable subclass of `OfmFlowMod`.
  OfmMutableFlowRemoved | Mutable subclass of `OfmFlowRemoved`.
  OfmMutableGetAsyncReply | Mutable subclass of `OfmGetAsyncReply`.
  OfmMutableGetAsyncRequest | Mutable subclass of `OfmGetAsyncRequest`.
  OfmMutableGetConfigReply | Mutable subclass of `OfmGetConfigReply`.
  OfmMutableGetConfigRequest | Mutable subclass of `OfmGetConfigRequest`.
  OfmMutableGroupMod | Mutable subclass of `OfmGroupMod`.
  OfmMutableHello | Mutable subclass of `OfmHello`.
  OfmMutableMeterMod | Mutable subclass of `OfmMeterMod`.
  OfmMutableMultipartReply | Mutable subclass of `OfmMultipartReply`.
  OfmMutableMultipartRequest | Mutable subclass of `OfmMultipartRequest`.
  OfmMutablePacketIn | Mutable subclass of `OfmPacketIn`.
  OfmMutablePacketOut | Mutable subclass of `OfmPacketOut`.
  OfmMutablePortMod | Mutable subclass of `OfmPortMod`.
  OfmMutablePortStatus | Mutable subclass of `OfmPortStatus`.
  OfmMutableQueueGetConfigReply | Mutable subclass of `OfmQueueGetConfigReply`.
  OfmMutableQueueGetConfigRequest | Mutable subclass of `OfmQueueGetConfigRequest`.
  OfmMutableRoleReply | Mutable subclass of `OfmRoleReply`.
  OfmMutableRoleRequest | Mutable subclass of `OfmRoleRequest`.
  OfmMutableSetAsync | Mutable subclass of `OfmSetAsync`.
  OfmMutableSetConfig | Mutable subclass of `OfmSetConfig`.
  OfmMutableTableMod | Mutable subclass of `OfmTableMod`.
  OfmPacketIn | Represents an OpenFlow PACKET_IN message; Since 1.0.
  OfmPacketOut | Represents an OpenFlow PACKET_OUT message; Since 1.0.
  OfmPortMod | Represents an OpenFlow PORT_MOD message; Since 1.0.
  OfmPortStatus | Represents an OpenFlow PORT_STATUS message; Since 1.0.
  OfmQueueGetConfigReply | Represents an OpenFlow QUEUE_GET_CONFIG_REPLY message; since 1.0.
  OfmQueueGetConfigRequest | Represents an OpenFlow QUEUE_GET_CONFIG_REQUEST message; since 1.0.
  OfmRoleReply | Represents an OpenFlow ROLE_REPLY message; Since 1.2.
  OfmRoleRequest | Represents an OpenFlow ROLE_REQUEST message; Since 1.2.
  OfmSetAsync | Represents an OpenFlow SET_ASYNC message; Since 1.3.
  OfmSetConfig | Represents an OpenFlow SET_CONFIG message; Since 1.0.
  OfmTableMod | Represents an OpenFlow TABLE_MOD message; Since 1.1; Deprecated in 1.3.
  OpenflowMessage | Base class for all OpenFlow messages.
  OpenflowMessage.Header | Represents the header common to all OpenFlow messages.
  Port | Represents physical ports, switch-defined logical ports, and OpenFlow specified reserved ports.
  PortFactory | Provides facilities for parsing, creating, and encoding `Port` instances.
  QPropExperimenter | Represents an experimenter property of a `Queue`.
  QPropMaxRate | Represents a MAX_RATE property of a `Queue`.
  QPropMinRate | Represents a MIN_RATE property of a `Queue`.
  QPropRate | Abstract superclass of the `QPropMinRate` and `QPropMaxRate` properties.
  Queue | Represents a queue that can attach to a port.
  QueueFactory | Provides facilities for parsing, creating, and encoding `Queue` instances.
  QueueProperty | Represents a property of a `Queue`.
  Role | Base class for OfmRoleRequest and OfmRoleReply.
  TableFeatureFactory | A factory for `table feature properties`.
  TableFeatureProp | The abstract superclass of instances representing table feature properties.
  TableFeaturePropAction | Represents an "actions" table feature property.
  TableFeaturePropExper | Represents an experimenter table feature property.
  TableFeaturePropInstr | Represents an "Instructions" table feature property.
  TableFeaturePropNextTable | Represents a "Next-Table" table feature property.
  TableFeaturePropOxm | Represents an "OXM" table feature property.

- Enum Summary
  Enum | Description
  --- | ---
  Capability | Designates OpenFlow switch capabilities.
  ConfigFlag | Designates switch configuration flags.
  ControllerRole | Designates the role of a controller; Since 1.2.
  FlowModCommand | Designates flow mod commands; Since 1.0.
  FlowModFlag | Designates flow mod flags; Since 1.0.
  FlowRemovedReason | Designates the reason a flow was removed; Since 1.0.
  GroupCapability | Designates the capabilities of a group; Since 1.2.
  GroupModCommand | Designates group mod commands; Since 1.1.
  GroupType | Designates group types; Since 1.1.
  HelloElementType | Designates hello message elements; Since 1.3.
  MessageFactory.TestReset | Denotes things that can be reset, during unit tests.
  MessageFuture.Result | Denotes the different states that a message future can be in.
  MessageFutureBag.BagResult | Denotes the different states that a message future bag can be in.
  MessageType | Denotes OpenFlow message types.
  MeterBandType | Designates meter band types; Since 1.3.
  MeterFlag | Designates meter flags; Since 1.3.
  MeterModCommand | Designates meter mod commands; Since 1.3.
  MultipartReplyFlag | Designates multipart reply flags; Since 1.0.
  MultipartRequestFlag | Designates multipart request flags; Since 1.3.
  PacketInReason | Designates the reason for the packet-in message; Since 1.0.
  PortConfig | Indicates a port's behavior.
  PortFeature | Designates port features.
  PortReason | Designates the reason for port status asynchronous message; Since 1.0.
  PortState | Describes a port's internal state.
  QueuePropType | Denotes different queue properties.
  SupportedAction | Designates supported action flags for Features-Reply; Since 1.0; Removed at 1.1.
  TableConfig | Indicates behavior of a flow table for unmatched packets; Since 1.1; Removed at 1.3.
  TableFeaturePropType | Designates feature properties of a table; Since 1.3.

## Package com.h3c.of.lib.msg Description

Representations of OpenFlow Protocol Messages.

Copyright © 2014. All Rights Reserved.