## Uses of Class
com.h3c.of.lib.instr.Instruction

- Packages that use Instruction
  Package | Description
  --- | ---
  com.h3c.of.json | JSON factory and codecs for Openflow structures.
  com.h3c.of.lib.instr | Representations of OpenFlow Protocol Instructions and Actions.
  com.h3c.of.lib.mp | Representations of OpenFlow Protocol Multipart Message bodies.
  com.h3c.of.lib.msg | Representations of OpenFlow Protocol Messages.
  com.h3c.sdn.flowmgr | Definitions of the services provided by the Flow Manager Application.

- - ### Uses of Instruction in com.h3c.of.json

    Methods in com.h3c.of.json that return Instruction
    Modifier and Type | Method and Description
    --- | ---
    `Instruction` | InstructionCodec.`decode(com.fasterxml.jackson.databind.node.ObjectNode node)`

    Methods in com.h3c.of.json with parameters of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `com.fasterxml.jackson.databind.node.ObjectNode` | InstructionCodec.`encode(Instruction ins)`

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

    Subclasses of Instruction in com.h3c.of.lib.instr
    Modifier and Type | Class and Description
    --- | ---
    `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` | `InstrWriteActions` Flow Instruction `WRITE_ACTIONS`.
    `class` | `InstrWriteMetadata` Flow Instruction `WRITE_METADATA`.

    Methods in com.h3c.of.lib.instr that return Instruction
    Modifier and Type | Method and Description
    --- | ---
    `static Instruction` | InstructionFactory.`createInstruction(ProtocolVersion pv, InstructionType type)` Creates a CLEAR_ACTIONS instruction.
    `static Instruction` | InstructionFactory.`createInstruction(ProtocolVersion pv, InstructionType type, ExperimenterId eid, byte[] data)` Creates an EXPERIMENTER instruction.
    `static Instruction` | InstructionFactory.`createInstruction(ProtocolVersion pv, InstructionType type, int id, byte[] data)` Creates an EXPERIMENTER instruction.
    `static Instruction` | InstructionFactory.`createInstruction(ProtocolVersion pv, InstructionType type, long metadata, long mask)` Creates a WRITE_METADATA instruction.
    `static Instruction` | InstructionFactory.`createInstruction(ProtocolVersion pv, InstructionType type, MeterId mid)` Creates a METER instruction.
    `static Instruction` | InstructionFactory.`createInstruction(ProtocolVersion pv, InstructionType type, TableId tid)` Creates a GOTO_TABLE instruction.
    `static Instruction` | InstructionFactory.`parseInstruction(OfPacketReader pkt, ProtocolVersion pv)` Parses an Instruction structure from the supplied buffer.

    Methods in com.h3c.of.lib.instr that return types with arguments of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `static List<Instruction>` | InstructionFactory.`createInstructionHeaders(ProtocolVersion pv, Set<InstructionType> types)` Creates instruction headers to be used in encoding a table features instructions property.
    `static List<Instruction>` | InstructionFactory.`parseInstructionHeaders(int targetRi, OfPacketReader pkt, ProtocolVersion pv)` Parses a list of instruction header structures from the supplied buffer.
    `static List<Instruction>` | InstructionFactory.`parseInstructionList(int targetRi, OfPacketReader pkt, ProtocolVersion pv)` Parses a list of instruction structures from the supplied buffer.

    Methods in com.h3c.of.lib.instr with parameters of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `static void` | InstructionFactory.`encodeInstruction(Instruction ins, OfPacketWriter pkt)` Encodes an instruction, writing it into the supplied buffer.
    `static void` | InstructionFactory.`validateInstruction(ProtocolVersion pv, Instruction ins, String msgType)` Ensures that the specified instruction is appropriate to add to a message of the specified version.

    Method parameters in com.h3c.of.lib.instr with type arguments of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `static void` | InstructionFactory.`encodeInstructionList(List<Instruction> instrs, OfPacketWriter pkt)` Encodes a list of instructions, writing them into the supplied buffer.
    `static String` | InstructionFactory.`toDebugString(int indent, List<Instruction> ins)` Outputs a list of instructions in debug string format.

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

    Methods in com.h3c.of.lib.mp that return types with arguments of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `List<Instruction>` | MBodyFlowStats.`getInstructions()` Returns the list of instructions for this flow; Since 1.1.

    Method parameters in com.h3c.of.lib.mp with type arguments of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `MBodyMutableFlowStats` | MBodyMutableFlowStats.`instructions(List<Instruction> ins)` Sets the instructions; Since 1.1.

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

    Methods in com.h3c.of.lib.msg that return types with arguments of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `List<Instruction>` | OfmFlowMod.`getInstructions()` Returns the list of instructions; Since 1.1. For 1.0 messages, this method will always return null.

    Methods in com.h3c.of.lib.msg with parameters of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `OfmMutableFlowMod` | OfmMutableFlowMod.`addInstruction(Instruction ins)` Adds an instruction to the instruction list; Since 1.1.

  - ### Uses of Instruction in com.h3c.sdn.flowmgr

    Methods in com.h3c.sdn.flowmgr that return types with arguments of type Instruction
    Modifier and Type | Method and Description
    --- | ---
    `List<Instruction>` | FlowRule.`instructions(TableId tableId)` Returns the list of effective instructions for the given table.

Copyright © 2014. All Rights Reserved.