Module `Frenetic_kernel.OpenFlow0x01`Source

Sourceexception Unparsable of string

Unparsable msg signals an error in parsing, such as when a bit sequence has been corrupted.

Sourceexception Ignored of string

Ignored msg signals the arrival of a valid OpenFlow message that the parser is not yet equipped to handle.

Sourcetype 'a mask = {

m_value : 'a;
m_mask : 'a option;

}

val sexp_of_mask : 
  ('a -> Ppx_sexp_conv_lib.Sexp.t) ->
  'a mask ->
  Ppx_sexp_conv_lib.Sexp.t

Source

val mask_of_sexp : 
  (Ppx_sexp_conv_lib.Sexp.t -> 'a) ->
  Ppx_sexp_conv_lib.Sexp.t ->
  'a mask

Sourcetype switchId = int64

Sourceval sexp_of_switchId : switchId -> Ppx_sexp_conv_lib.Sexp.t

Sourceval switchId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> switchId

Sourcetype portId = Packet.int16

Sourceval sexp_of_portId : portId -> Ppx_sexp_conv_lib.Sexp.t

Sourceval portId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portId

Sourcetype queueId = int32

Sourceval sexp_of_queueId : queueId -> Ppx_sexp_conv_lib.Sexp.t

Sourceval queueId_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> queueId

Sourcetype xid = OpenFlow_Header.xid

Sourcetype 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;

}

Sourceval sexp_of_pattern : pattern -> Ppx_sexp_conv_lib.Sexp.t

Sourceval pattern_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> pattern

Sourcetype pseudoPort =

| PhysicalPort of portId
| InPort
| Table
| Normal
| Flood
| AllPorts
| Controller of int
| Local

Sourceval sexp_of_pseudoPort : pseudoPort -> Ppx_sexp_conv_lib.Sexp.t

Sourceval pseudoPort_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> pseudoPort

Sourcetype 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

Sourceval sexp_of_action : action -> Ppx_sexp_conv_lib.Sexp.t

Sourceval action_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> action

Sourcetype timeout =

| Permanent
| ExpiresAfter of Packet.int16

Sourceval sexp_of_timeout : timeout -> Ppx_sexp_conv_lib.Sexp.t

Sourceval timeout_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> timeout

Sourcetype flowModCommand =

| AddFlow
| ModFlow
| ModStrictFlow
| DeleteFlow
| DeleteStrictFlow

Sourceval sexp_of_flowModCommand : flowModCommand -> Ppx_sexp_conv_lib.Sexp.t

Sourceval flowModCommand_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> flowModCommand

Sourcetype 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;

}

Sourceval sexp_of_flowMod : flowMod -> Ppx_sexp_conv_lib.Sexp.t

Sourceval flowMod_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> flowMod

Sourcetype payload =

| Buffered of int32 * Cstruct.t
| NotBuffered of Cstruct.t

Sourceval sexp_of_payload : payload -> Ppx_sexp_conv_lib.Sexp.t

Sourceval payload_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> payload

Sourcetype packetInReason =

| NoMatch
| ExplicitSend

Sourceval sexp_of_packetInReason : packetInReason -> Ppx_sexp_conv_lib.Sexp.t

Sourceval packetInReason_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> packetInReason

Sourcetype packetIn = {

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

}

Sourceval sexp_of_packetIn : packetIn -> Ppx_sexp_conv_lib.Sexp.t

Sourceval packetIn_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> packetIn

Sourcetype flowRemovedReason =

| IdleTimeout
| HardTimeout
| Delete

Sourceval sexp_of_flowRemovedReason : flowRemovedReason -> Ppx_sexp_conv_lib.Sexp.t

Sourceval flowRemovedReason_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> flowRemovedReason

Sourcetype 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;

}

Sourceval sexp_of_flowRemoved : flowRemoved -> Ppx_sexp_conv_lib.Sexp.t

Sourceval flowRemoved_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> flowRemoved

Sourcetype packetOut = {

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

}

Sourceval sexp_of_packetOut : packetOut -> Ppx_sexp_conv_lib.Sexp.t

Sourceval packetOut_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> packetOut

Sourcetype statsReq = {

sr_of_match : pattern;
sr_table_id : Packet.int8;
sr_out_port : pseudoPort option;

}

Sourceval sexp_of_statsReq : statsReq -> Ppx_sexp_conv_lib.Sexp.t

Sourceval statsReq_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> statsReq

Sourcetype request =

| DescriptionRequest
| FlowTableStatsRequest
| IndividualRequest of statsReq
| AggregateRequest of statsReq
| PortRequest of pseudoPort option

Sourceval sexp_of_request : request -> Ppx_sexp_conv_lib.Sexp.t

Sourceval request_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> request

Sourcetype descriptionStats = {

manufacturer : string;
hardware : string;
software : string;
serial_number : string;
datapath : string;

}

Sourceval sexp_of_descriptionStats : descriptionStats -> Ppx_sexp_conv_lib.Sexp.t

Sourceval descriptionStats_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> descriptionStats

Sourcetype individualStats = {

table_id : Packet.int8;
of_match : pattern;
duration_sec : int32;
duration_nsec : int32;
priority : Packet.int16;
idle_timeout : Packet.int16;
hard_timeout : Packet.int16;
cookie : int64;
packet_count : int64;
byte_count : int64;
actions : action list;

}

Sourceval sexp_of_individualStats : individualStats -> Ppx_sexp_conv_lib.Sexp.t

Sourceval individualStats_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> individualStats

Sourcetype aggregateStats = {

total_packet_count : int64;
total_byte_count : int64;
flow_count : int32;

}

Sourceval sexp_of_aggregateStats : aggregateStats -> Ppx_sexp_conv_lib.Sexp.t

Sourceval aggregateStats_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> aggregateStats

Sourcetype portStats = {

port_no : Packet.int16;
rx_packets : int64;
tx_packets : int64;
rx_bytes : int64;
tx_bytes : int64;
rx_dropped : int64;
tx_dropped : int64;
rx_errors : int64;
tx_errors : int64;
rx_frame_err : int64;
rx_over_err : int64;
rx_crc_err : int64;
collisions : int64;

}

Sourceval sexp_of_portStats : portStats -> Ppx_sexp_conv_lib.Sexp.t

Sourceval portStats_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portStats

Sourcetype reply =

| DescriptionRep of descriptionStats
| IndividualFlowRep of individualStats list
| AggregateFlowRep of aggregateStats
| PortRep of portStats list

Sourceval sexp_of_reply : reply -> Ppx_sexp_conv_lib.Sexp.t

Sourceval reply_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> reply

Sourcetype wildcards = {

in_port : bool;
dl_vlan : bool;
dl_src : bool;
dl_dst : bool;
dl_type : bool;
nw_proto : bool;
tp_src : bool;
tp_dst : bool;
nw_src : int;
nw_dst : int;
dl_vlan_pcp : bool;
nw_tos : bool;

}

Sourceval sexp_of_wildcards : wildcards -> Ppx_sexp_conv_lib.Sexp.t

Sourceval wildcards_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> wildcards

Sourcetype portConfig = {

down : bool;
no_stp : bool;
no_recv : bool;
no_recv_stp : bool;
no_flood : bool;
no_fwd : bool;
no_packet_in : bool;

}

Sourceval sexp_of_portConfig : portConfig -> Ppx_sexp_conv_lib.Sexp.t

Sourceval portConfig_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portConfig

Sourcetype stpState =

| Listen
| Learn
| Forward
| Block

Sourceval sexp_of_stpState : stpState -> Ppx_sexp_conv_lib.Sexp.t

Sourceval stpState_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> stpState

Sourcetype portState = {

down : bool;
stp_state : stpState;

}

Sourceval sexp_of_portState : portState -> Ppx_sexp_conv_lib.Sexp.t

Sourceval portState_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portState

Sourcetype portFeatures = {

f_10MBHD : bool;
f_10MBFD : bool;
f_100MBHD : bool;
f_100MBFD : bool;
f_1GBHD : bool;
f_1GBFD : bool;
f_10GBFD : bool;
copper : bool;
fiber : bool;
autoneg : bool;
pause : bool;
pause_asym : bool;

}

Sourceval sexp_of_portFeatures : portFeatures -> Ppx_sexp_conv_lib.Sexp.t

Sourceval portFeatures_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portFeatures

Sourcetype portDescription = {

port_no : portId;
hw_addr : Packet.dlAddr;
name : string;
config : portConfig;
state : portState;
curr : portFeatures;
advertised : portFeatures;
supported : portFeatures;
peer : portFeatures;

}

Sourceval sexp_of_portDescription : portDescription -> Ppx_sexp_conv_lib.Sexp.t

Sourceval portDescription_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> portDescription

Sourcemodule Wildcards : sig ... end

Sourcemodule Match : sig ... end

Sourcemodule PseudoPort : sig ... end

Sourcemodule Timeout : sig ... end

Sourcemodule Action : sig ... end

Sourcemodule FlowMod : sig ... end

Sourcemodule FlowRemoved : sig ... end

Sourcemodule PacketOut : sig ... end

Sourcemodule PortDescription : sig ... end

Sourcemodule PortStatus : sig ... end

Sourcemodule SwitchFeatures : sig ... end

Switch features data structure. See Section 5.3.1 of the OpenFlow 1.0 specification.

Sourcemodule SwitchConfig : sig ... end

Sourcemodule StatsRequest : sig ... end

Sourcemodule StatsReply : sig ... end

Sourcemodule Error : sig ... end

An error message. See Section 5.4.4 of the OpenFlow 1.0 specification.

Sourcemodule Vendor : sig ... end

A VENDOR message. See Section 5.5.4 of the OpenFlow 1.0 specification.

Sourcemodule Message : sig ... end

A subset of the OpenFlow 1.0 messages defined in Section 5.1 of the specification.

Pretty printing

In general, each submodule contains pretty-printing functions for the types defined therein. This section defines pretty printers for top-level types.

Sourceval string_of_switchId : switchId -> string

string_of_switchId sw pretty-prints sw in hex.

Sourceval string_of_portId : portId -> string

string_of_portId p pretty-prints p.

Sourceval string_of_queueId : queueId -> string

string_of_queueId q pretty-prints q.

Parsing exceptions

These exceptions may occur when parsing OpenFlow messages.

Convenient Functions

Sourceval parse_payload : payload -> Packet.packet

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

marshal_payload buf pkt serializes pkt, where buf is an optional buffer ID.

Sourceval match_all : pattern

A pattern that matches all packets. (All fields wildcarded.)

Source

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

add_flow priority pattern action_sequence creates a FlowMod.t instruction that adds a new flow table entry with the specified priority, pattern, and action_sequence.

The entry is permanent (i.e., does not timeout), its cookie is zero, etc.

Source

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

Sourceval delete_all_flows : flowMod

Printing and Debugging

Sourceval packetIn_to_string : packetIn -> string

Sourceval reply_to_string : reply -> string

Install

Dune Dependency

Authors

Maintainers

Sources

doc/frenetic.kernel/Frenetic_kernel/OpenFlow0x01/index.html

Module `Frenetic_kernel.OpenFlow0x01`Source

Pretty printing

Parsing exceptions

Convenient Functions

Printing and Debugging

package frenetic

Install

Dune Dependency

Authors

Maintainers

Sources

doc/frenetic.kernel/Frenetic_kernel/OpenFlow0x01/index.html

Module Frenetic_kernel.OpenFlow0x01Source

Pretty printing

Parsing exceptions

Convenient Functions

Printing and Debugging

Module `Frenetic_kernel.OpenFlow0x01`Source