## Uses of Class
com.h3c.of.lib.msg.OpenflowMessage

- Packages that use OpenflowMessage
  Package | Description
  --- | ---
  com.h3c.of.common | Code shared by the OpenFlow Controller and Mock OpenFlow Switch implementations.
  com.h3c.of.ctl | Public API for the OpenFlow Controller.
  com.h3c.of.lib | OpenFlow Protocol Library.
  com.h3c.of.lib.msg | Representations of OpenFlow Protocol Messages.
  com.h3c.of.sw | Provides mock implementations of OpenFlow switches.
  com.h3c.sdn.api | Definitions of services for driving outbound external communications for interacting with peers and integrating with other external applications, e.g.
  com.h3c.sdn.teamcs | ...

- - ### Uses of OpenflowMessage in com.h3c.of.common

    Methods in com.h3c.of.common with parameters of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `void` | ProgrammableSink.`msgRx(OpenflowMessage msg, DataPathId dpid, int auxId, ProtocolVersion negotiated)` Incoming OpenFlow messages are routed through this API method.
    `void` | MessageSink.`msgRx(OpenflowMessage msg, DataPathId dpid, int auxId, ProtocolVersion negotiated)` OpenFlow message received from the specified datapath on the given auxiliary channel.
    `protected abstract void` | AbstractMsgAssertor.`runAssertions(OpenflowMessage msg)` Concrete subclasses run assertions against a message.

  - ### Uses of OpenflowMessage in com.h3c.of.ctl

    Methods in com.h3c.of.ctl that return OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `OpenflowMessage` | MessageEvent.`msg()` Returns the OpenFlow message associated with this event.

    Methods in com.h3c.of.ctl with parameters of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `MessageContext` | ControllerService.`createMsgContext(OpenflowEventType type, OpenflowMessage msg, DataPathId dpid, int auxId, ProtocolVersion pv)`
    `MessageContext` | ControllerServiceAdapter.`createMsgContext(OpenflowEventType type, OpenflowMessage msg, DataPathId dpid, int auxId, ProtocolVersion pv)`
    `void` | SubComponentService.`send(OpenflowMessage msg, DataPathId dpid)` Sends the specified message to the specified datapath, via the sub-component.
    `MessageFuture` | ControllerService.`send(OpenflowMessage msg, DataPathId dpid)` Instructs the controller to send the specified message to the specified datapath.
    `MessageFuture` | MessageSender.`send(OpenflowMessage msg, DataPathId dpid)` Sends the specified message to the specified datapath.
    `MessageFuture` | ControllerServiceAdapter.`send(OpenflowMessage msg, DataPathId dpid)`

    Method parameters in com.h3c.of.ctl with type arguments of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `List<MessageFuture>` | ControllerService.`send(List<OpenflowMessage> msgs, DataPathId dpid)` Instructs the controller to send the specified list of messages (in order) to the specified datapath.
    `List<MessageFuture>` | MessageSender.`send(List<OpenflowMessage> msgs, DataPathId dpid)` Sends the specified list of messages (in order) to the specified datapath.
    `List<MessageFuture>` | ControllerServiceAdapter.`send(List<OpenflowMessage> msgs, DataPathId dpid)`

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

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

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

    Subclasses of OpenflowMessage in com.h3c.of.lib.msg
    Modifier and Type | Class and Description
    --- | ---
    `class` | `OfmBarrierReply` Represents an OpenFlow BARRIER_REPLY message; Since 1.0.
    `class` | `OfmBarrierRequest` Represents an OpenFlow BARRIER_REQUEST message; Since 1.0.
    `class` | `OfmEchoReply` Represents an OpenFlow ECHO REPLY message; Since 1.0.
    `class` | `OfmEchoRequest` Represents an OpenFlow ECHO REQUEST message; Since 1.0.
    `class` | `OfmError` Represents an OpenFlow ERROR message; Since 1.0.
    `class` | `OfmErrorExper` Represents an OpenFlow EXPERIMENTER ERROR message; Since 1.2.
    `class` | `OfmExperimenter` Represents an OpenFlow EXPERIMENTER message; since 1.0.
    `class` | `OfmFeaturesReply` Represents an OpenFlow FEATURES_REPLY message; Since 1.0.
    `class` | `OfmFeaturesRequest` Represents an OpenFlow FEATURES_REQUEST message; Since 1.0.
    `class` | `OfmFlowMod` Represents an OpenFlow FLOW_MOD message; Since 1.0.
    `class` | `OfmFlowRemoved` Represents an Openflow FLOW_REMOVED message; Since 1.0.
    `class` | `OfmGetAsyncReply` Represents an OpenFlow GET_ASYNC_REPLY message; Since 1.3.
    `class` | `OfmGetAsyncRequest` Represents an OpenFlow GET_ASYNC_REQUEST message; Since 1.3.
    `class` | `OfmGetConfigReply` Represents an OpenFlow GET_CONFIG_REPLY message; Since 1.0.
    `class` | `OfmGetConfigRequest` Represents an OpenFlow GET_CONFIG_REQUEST message; Since 1.0.
    `class` | `OfmGroupMod` Represents an OpenFlow GROUP_MOD message; Since 1.1.
    `class` | `OfmHello` Represents an OpenFlow HELLO message; Since 1.0.
    `class` | `OfmMeterMod` Represents an OpenFlow METER_MOD message; Since 1.3.
    `class` | `OfmMultipartReply` Represents an OpenFlow MULTIPART_REPLY message; Since 1.3 (but see note).
    `class` | `OfmMultipartRequest` Represents an OpenFlow MULTIPART_REQUEST message; Since 1.3 (but see note).
    `class` | `OfmMutableBarrierReply` Mutable subclass of `OfmBarrierReply`.
    `class` | `OfmMutableBarrierRequest` Mutable subclass of `OfmBarrierRequest`.
    `class` | `OfmMutableEchoReply` Mutable subclass of `OfmEchoReply`.
    `class` | `OfmMutableEchoRequest` Mutable subclass of `OfmEchoRequest`.
    `class` | `OfmMutableError` Mutable subclass of `OfmError`.
    `class` | `OfmMutableErrorExper` Mutable subclass of `OfmErrorExper`.
    `class` | `OfmMutableExperimenter` Mutable subclass of `OfmExperimenter`.
    `class` | `OfmMutableFeaturesReply` Mutable subclass of `OfmFeaturesReply`.
    `class` | `OfmMutableFeaturesRequest` Mutable subclass of `OfmFeaturesRequest`.
    `class` | `OfmMutableFlowMod` Mutable subclass of `OfmFlowMod`.
    `class` | `OfmMutableFlowRemoved` Mutable subclass of `OfmFlowRemoved`.
    `class` | `OfmMutableGetAsyncReply` Mutable subclass of `OfmGetAsyncReply`.
    `class` | `OfmMutableGetAsyncRequest` Mutable subclass of `OfmGetAsyncRequest`.
    `class` | `OfmMutableGetConfigReply` Mutable subclass of `OfmGetConfigReply`.
    `class` | `OfmMutableGetConfigRequest` Mutable subclass of `OfmGetConfigRequest`.
    `class` | `OfmMutableGroupMod` Mutable subclass of `OfmGroupMod`.
    `class` | `OfmMutableHello` Mutable subclass of `OfmHello`.
    `class` | `OfmMutableMeterMod` Mutable subclass of `OfmMeterMod`.
    `class` | `OfmMutableMultipartReply` Mutable subclass of `OfmMultipartReply`.
    `class` | `OfmMutableMultipartRequest` Mutable subclass of `OfmMultipartRequest`.
    `class` | `OfmMutablePacketIn` Mutable subclass of `OfmPacketIn`.
    `class` | `OfmMutablePacketOut` Mutable subclass of `OfmPacketOut`.
    `class` | `OfmMutablePortMod` Mutable subclass of `OfmPortMod`.
    `class` | `OfmMutablePortStatus` Mutable subclass of `OfmPortStatus`.
    `class` | `OfmMutableQueueGetConfigReply` Mutable subclass of `OfmQueueGetConfigReply`.
    `class` | `OfmMutableQueueGetConfigRequest` Mutable subclass of `OfmQueueGetConfigRequest`.
    `class` | `OfmMutableRoleReply` Mutable subclass of `OfmRoleReply`.
    `class` | `OfmMutableRoleRequest` Mutable subclass of `OfmRoleRequest`.
    `class` | `OfmMutableSetAsync` Mutable subclass of `OfmSetAsync`.
    `class` | `OfmMutableSetConfig` Mutable subclass of `OfmSetConfig`.
    `class` | `OfmMutableTableMod` Mutable subclass of `OfmTableMod`.
    `class` | `OfmPacketIn` Represents an OpenFlow PACKET_IN message; Since 1.0.
    `class` | `OfmPacketOut` Represents an OpenFlow PACKET_OUT message; Since 1.0.
    `class` | `OfmPortMod` Represents an OpenFlow PORT_MOD message; Since 1.0.
    `class` | `OfmPortStatus` Represents an OpenFlow PORT_STATUS message; Since 1.0.
    `class` | `OfmQueueGetConfigReply` Represents an OpenFlow QUEUE_GET_CONFIG_REPLY message; since 1.0.
    `class` | `OfmQueueGetConfigRequest` Represents an OpenFlow QUEUE_GET_CONFIG_REQUEST message; since 1.0.
    `class` | `OfmRoleReply` Represents an OpenFlow ROLE_REPLY message; Since 1.2.
    `class` | `OfmRoleRequest` Represents an OpenFlow ROLE_REQUEST message; Since 1.2.
    `class` | `OfmSetAsync` Represents an OpenFlow SET_ASYNC message; Since 1.3.
    `class` | `OfmSetConfig` Represents an OpenFlow SET_CONFIG message; Since 1.0.
    `class` | `OfmTableMod` Represents an OpenFlow TABLE_MOD message; Since 1.1; Deprecated in 1.3.
    `class` | `Role` Base class for OfmRoleRequest and OfmRoleReply.

    Methods in com.h3c.of.lib.msg that return OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `static OpenflowMessage` | MessageFactory.`copy(OpenflowMessage msg)` Creates an immutable (deep) copy of the specified OpenFlow message.
    `static OpenflowMessage` | MessageFactory.`parseMessage(ByteBuffer buffer)` Parses a single OpenFlow message from the supplied byte buffer consuming the bytes in the process.
    `static OpenflowMessage` | MessageFactory.`parseMessage(OfPacketReader pkt)` Parses the supplied packet reader as a single OpenFlow message.
    `static OpenflowMessage` | MessageFactory.`parseMessage(OfPacketReader pkt, OpenflowMessage msg)` Parses the supplied packet reader as a single OpenFlow message, but patches in the XID of the specified message.
    `OpenflowMessage` | DefaultMessageFuture.`reply()`
    `OpenflowMessage` | MessageFuture.`reply()` Returns the reply resulting from the asynchronous request.
    `OpenflowMessage` | DefaultMessageFuture.`request()`
    `OpenflowMessage` | MessageFuture.`request()` Returns the original request message.
    `OpenflowMessage` | OfmMutableGroupMod.`toImmutable()`
    `OpenflowMessage` | OfmMutableRoleRequest.`toImmutable()`
    `OpenflowMessage` | OfmMutablePacketOut.`toImmutable()`
    `OpenflowMessage` | OfmMutableFeaturesRequest.`toImmutable()`
    `OpenflowMessage` | OfmMutableError.`toImmutable()`
    `OpenflowMessage` | OfmMutablePacketIn.`toImmutable()`
    `OpenflowMessage` | OfmMutableGetConfigReply.`toImmutable()`
    `OpenflowMessage` | OfmMutableGetConfigRequest.`toImmutable()`
    `OpenflowMessage` | OfmMutableQueueGetConfigReply.`toImmutable()`
    `OpenflowMessage` | OfmMutableMeterMod.`toImmutable()`
    `OpenflowMessage` | OfmMutableFeaturesReply.`toImmutable()`
    `OpenflowMessage` | OfmMutablePortMod.`toImmutable()`
    `OpenflowMessage` | MutableMessage.`toImmutable()` Returns an immutable instance of this message.
    `OpenflowMessage` | OfmMutableSetAsync.`toImmutable()`
    `OpenflowMessage` | OfmMutableFlowMod.`toImmutable()`
    `OpenflowMessage` | OfmMutableSetConfig.`toImmutable()`
    `OpenflowMessage` | OfmMutableErrorExper.`toImmutable()`
    `OpenflowMessage` | OfmMutableEchoReply.`toImmutable()`
    `OpenflowMessage` | OfmMutableBarrierRequest.`toImmutable()`
    `OpenflowMessage` | OfmMutableHello.`toImmutable()`
    `OpenflowMessage` | OfmMutableRoleReply.`toImmutable()`
    `OpenflowMessage` | OfmMutableGetAsyncReply.`toImmutable()`
    `OpenflowMessage` | OfmMutableTableMod.`toImmutable()`
    `OpenflowMessage` | OfmMutableBarrierReply.`toImmutable()`
    `OpenflowMessage` | OfmMutableMultipartReply.`toImmutable()`
    `OpenflowMessage` | OfmMutableMultipartRequest.`toImmutable()`
    `OpenflowMessage` | OfmMutableEchoRequest.`toImmutable()`
    `OpenflowMessage` | OfmMutableQueueGetConfigRequest.`toImmutable()`
    `OpenflowMessage` | OfmMutableExperimenter.`toImmutable()`
    `OpenflowMessage` | OfmMutableGetAsyncRequest.`toImmutable()`
    `OpenflowMessage` | OfmMutableFlowRemoved.`toImmutable()`
    `OpenflowMessage` | OfmMutablePortStatus.`toImmutable()`

    Methods in com.h3c.of.lib.msg with parameters of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `static OpenflowMessage` | MessageFactory.`copy(OpenflowMessage msg)` Creates an immutable (deep) copy of the specified OpenFlow message.
    `static void` | MessageFactory.`copyXid(OpenflowMessage src, MutableMessage dst)` Copies the transaction ID from given source message to the specified destination message.
    `static byte[]` | MessageFactory.`encodeMessage(OpenflowMessage msg)` Encodes the specified OpenFlow message, returning the result in a newly allocated byte array.
    `static void` | MessageFactory.`encodeMessage(OpenflowMessage msg, ByteBuffer buffer)` Encodes the specified OpenFlow message into the supplied byte buffer.
    `static MutableMessage` | MessageFactory.`mutableCopy(OpenflowMessage msg)` Creates a mutable (deep) copy of the specified OpenFlow message.
    `static OpenflowMessage` | MessageFactory.`parseMessage(OfPacketReader pkt, OpenflowMessage msg)` Parses the supplied packet reader as a single OpenFlow message, but patches in the XID of the specified message.
    `boolean` | DefaultMessageFuture.`setSuccess(OpenflowMessage msg)`
    `boolean` | MessageFuture.`setSuccess(OpenflowMessage msg)` Marks this future as a success, attaching the specified reply message, and notifies all listeners.

    Constructors in com.h3c.of.lib.msg with parameters of type OpenflowMessage
    Constructor and Description
    `DataPathMessageFuture(OpenflowMessage request, DataPathId dpid)`
    `DefaultMessageFuture(OpenflowMessage request)` Constructs a default message future for the given request.

  - ### Uses of OpenflowMessage in com.h3c.of.sw

    Methods in com.h3c.of.sw that return OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `OpenflowMessage` | CfgDesc.`createMpDescReply(OpenflowMessage request)` Creates a multipart DESC reply from the configured data.
    `OpenflowMessage` | MockOpenflowSwitch.`createMpPortDescReply(OpenflowMessage request)` Creates a multipart PORT_DESC reply from the configured data.

    Methods in com.h3c.of.sw with parameters of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `void` | MockOpenflowSwitch.`cache(MessageType messageType, OpenflowMessage msg)` The command processor has asked us to cache this outgoing message for validation later.
    `OpenflowMessage` | CfgDesc.`createMpDescReply(OpenflowMessage request)` Creates a multipart DESC reply from the configured data.
    `OpenflowMessage` | MockOpenflowSwitch.`createMpPortDescReply(OpenflowMessage request)` Creates a multipart PORT_DESC reply from the configured data.
    `protected void` | MockOpenflowSwitch.`msgRx(OpenflowMessage msg)` Invoked when a message is received from the controller.
    `protected void` | MockOpenflowSwitch.`send(OpenflowMessage msg)` Sends the specified openflow message to the controller.
    `protected void` | MockOpenflowSwitch.`sendError(ErrorType et, ErrorCode ec, OpenflowMessage m)` Send an error message back to the controller.

  - ### Uses of OpenflowMessage in com.h3c.sdn.api

    Methods in com.h3c.sdn.api with parameters of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `MessageFuture` | RemoteControllerService.`send(SystemInformation system, OpenflowMessage msg, DataPathId dpId)` Instructs a particular member controller to send the specified message to the specified datapath.

    Method parameters in com.h3c.sdn.api with type arguments of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `List<MessageFuture>` | RemoteControllerService.`send(SystemInformation system, List<OpenflowMessage> msgs, DataPathId dpId)` Instructs a particular member controller to send the specified list of messages (in order) to the specified datapath.

  - ### Uses of OpenflowMessage in com.h3c.sdn.teamcs

    Methods in com.h3c.sdn.teamcs with parameters of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `MessageFuture` | TeamControllerService.`send(OpenflowMessage msg, DataPathId dpid)` Instructs the controller to send the specified message to the specified datapath.

    Method parameters in com.h3c.sdn.teamcs with type arguments of type OpenflowMessage
    Modifier and Type | Method and Description
    --- | ---
    `List<MessageFuture>` | TeamControllerService.`send(List<OpenflowMessage> msgs, DataPathId dpid)` Instructs the controller to send the specified list of messages (in order) to the specified datapath.

Copyright © 2014. All Rights Reserved.