# Package com.h3c.of.lib

OpenFlow Protocol Library.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  MutableObject | Implemented by OpenFlow classes that provide mutators for setting state.
  MutableStructure | Implemented by OpenFlow structure classes that provide mutators for setting the state of the structure.
  OfpBitmapEnum | Implemented by enums that represent OpenFlow Protocol bitmap fields.
  OfpCodeBasedEnum | Implemented by enums that represent OpenFlow protocol coded values.
  OfpEnum | Tag interface for code-based or bitmapped enumerations.
  Structure | Provides access to the attributes common to all `OpenflowStructure`s.

- Class Summary
  Class | Description
  --- | ---
  AbstractBitCodec<E extends OfpEnum> | Provides a common base for the two bitmap codec classes.
  AbstractFactory | Provides a base implementation for all the factory classes out there.
  CommonUtils | Provides common constants and utility methods.
  FlowUtils | Provides useful utilities regarding flow messages.
  MatchUtils | Provides useful utilities regarding matches.
  Mutable | Encapsulates the common state and behavior of mutable objects.
  OfPacketReader | Extends the functionality of `PacketReader` to include the OpenFlow datatypes from `com.h3c.of.lib.dt`.
  OfPacketWriter | Extends the functionality of `PacketWriter` to include the OpenFlow datatypes from `com.h3c.of.lib.dt`.
  OfpBitmapCodec<E extends OfpBitmapEnum> | Provides a default implementation of a bitmap to enum-set coder/decoder (codec), which can handle differences across OpenFlow versions.
  OfpCodeBasedCodec<E extends OfpCodeBasedEnum> | Provides an implementation of an integer based bitmap to enum-set coder/decoder (codec) which can handle differences across OpenFlow versions.
  OpenflowStructure | Base class for all OpenFlow structures.

- Enum Summary
  Enum | Description
  --- | ---
  ExperimenterId | Denotes the documented experimenter IDs of the ONF members.
  ProtocolVersion | Denotes the published OpenFlow Protocol versions.

- Exception Summary
  Exception | Description
  --- | ---
  DecodeException | Exception thrown when an attempt to decode an encoded value fails.
  HeaderParseException | Exception thrown when the header of an OpenFlow message (or other structure) fails to parse correctly.
  IncompleteMessageException | Exception thrown when an attempt is made to encode an `OpenFlow message` which is incomplete.
  IncompleteStructureException | Exception thrown when an attempt is made to encode an `OpenFlow structure` which is incomplete.
  InvalidMutableException | Runtime exception thrown when an operation is attempted on a `MutableMessage` that has already had `MutableMessage.toImmutable()` invoked on it.
  MessageParseException | Exception thrown when an OpenFlow message fails to parse correctly.
  OpenflowException | Generic OpenFlow exception.
  VersionMismatchException | Runtime exception thrown when an OpenFlow version mismatch is detected.
  VersionNotSupportedException | Runtime exception thrown if the requested protocol version is not supported by the message library.

## Package com.h3c.of.lib Description

OpenFlow Protocol Library.

Copyright © 2014. All Rights Reserved.