package openflow

You can search for identifiers within the package.

in-package search v0.2.0

package openflow

openflow
- OpenFlow0x01
  - Action
  - ConfigReply
    
    FragFlags
  - Error
    
    BadAction
    
    BadRequest
    
    FlowModFailed
    
    HelloFailed
    
    PortModFailed
    
    QueueOpFailed
  - FlowMod
    
    Command
  - FlowRemoved
    
    Reason
  - Match
  - Message
    
    Header
  - PacketIn
    
    Reason
  - PacketOut
  - Payload
  - PortDescription
    
    PortConfig
    
    PortFeatures
    
    PortState
  - PortStatus
    
    ChangeReason
  - PseudoPort
  - StatsReply
  - StatsRequest
  - SwitchConfig
    
    FragFlags
  - SwitchFeatures
    
    Capabilities
    
    SupportedActions
  - Timeout
  - Vendor
  - Wildcards
- OpenFlow0x01_Core
- OpenFlow0x01_Stats
- OpenFlow0x04
  - Action
  - Bucket
  - Capabilities
  - Error
  - FlowMod
  - FlowModCommand
  - GroupMod
  - GroupType
  - Instruction
  - Instructions
  - Message
    
    Header
  - MultipartReply
  - MultipartReq
  - OfpMatch
  - Oxm
  - PacketIn
  - PacketOut
  - PortDesc
  - PortReason
  - PortState
  - PortStatus
  - PortsDescriptionReply
  - SwitchFeatures
- OpenFlow0x04_Core
- SDN_Types
  - FieldMap
- VInt

Legend:
Library
Module
Module type
Parameter
Class
Class type

type !'a mask = {

m_value : 'a;
m_mask : 'a option;

}

type switchId = int64

type portId = Packet.int16

type queueId = int32

type xid = int32

type pattern = {

dlSrc : Packet.dlAddr option;
dlDst : Packet.dlAddr option;
dlTyp : Packet.dlTyp option;
dlVlan : Packet.dlVlan option;
dlVlanPcp : Packet.dlVlanPcp option;
nwSrc : Packet.nwAddr mask option;
nwDst : Packet.nwAddr mask option;
nwProto : Packet.nwProto option;
nwTos : Packet.nwTos option;
tpSrc : Packet.tpPort option;
tpDst : Packet.tpPort option;
inPort : portId option;

}

type pseudoPort =

| PhysicalPort of portId
| AllPorts
| InPort
| Flood
| Controller of int

type action =

| Output of pseudoPort
| SetDlVlan of Packet.dlVlan
| SetDlVlanPcp of Packet.dlVlanPcp
| SetDlSrc of Packet.dlAddr
| SetDlDst of Packet.dlAddr
| SetNwSrc of Packet.nwAddr
| SetNwDst of Packet.nwAddr
| SetNwTos of Packet.nwTos
| SetTpSrc of Packet.tpPort
| SetTpDst of Packet.tpPort
| Enqueue of pseudoPort * queueId

type timeout =

| Permanent
| ExpiresAfter of Packet.int16

type flowModCommand =

| AddFlow
| ModFlow
| ModStrictFlow
| DeleteFlow
| DeleteStrictFlow

type flowMod = {

command : flowModCommand;
pattern : pattern;
priority : Packet.int16;
actions : action list;
cookie : int64;
idle_timeout : timeout;
hard_timeout : timeout;
notify_when_removed : bool;
apply_to_packet : int32 option;
out_port : pseudoPort option;
check_overlap : bool;

}

type payload =

| Buffered of int32 * Packet.bytes
| NotBuffered of Packet.bytes

type packetInReason =

| NoMatch
| ExplicitSend

type packetIn = {

input_payload : payload;
total_len : Packet.int16;
port : portId;
reason : packetInReason;

}

type flowRemovedReason =

| IdleTimeout
| HardTimeout
| Delete

type flowRemoved = {

pattern : pattern;
cookie : int64;
priority : Packet.int16;
reason : flowRemovedReason;
duration_sec : int32;
duration_nsec : int32;
idle_timeout : timeout;
packet_count : int64;
byte_count : int64;

}

type packetOut = {

output_payload : payload;
port_id : portId option;
apply_actions : action list;

}

val parse_payload : payload -> Packet.packet

val marshal_payload : int32 option -> Packet.packet -> payload

val match_all : pattern

val add_flow : 
  Packet.int16 ->
  pattern ->
  ?idle_to:timeout ->
  ?notify_removed:bool ->
  action list ->
  flowMod

val delete_flow_strict : 
  Packet.int16 ->
  pattern ->
  pseudoPort option ->
  flowMod

val delete_all_flows : flowMod

val packetIn_to_string : packetIn -> string