package frenetic

  1. Overview
  2. Docs
package frenetic
Legend:
Library
Module
Module type
Parameter
Class
Class type

The first fields of every OpenFlow message, no matter what the version, have the same shape. This is unlikely to change in subsequent OpenFlow versions because there needs to be some standard way to determine the version of each message. So we define that here.

Types and exceptions
type xid = Core.Int32.t
val sexp_of_xid : xid -> Ppx_sexp_conv_lib.Sexp.t
val xid_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> xid
type t = {
  1. version : int;
  2. type_code : int;
  3. length : int;
  4. xid : xid;
}
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
Accessors
val size : int

size returns size of standard OpenFlow header in bytes

Conversion
val parse : Cstruct.t -> t

parse pkt takes a message buffer and returns a OpenFlow_Header.t. The message buffer can be a complete OpenFlow raw message yanked from the wire - not just the header.

val marshal : Cstruct.t -> t -> unit

marshal pkt hdr fills a message buffer with the header fields of a OpenFlow_Header.t. The message buffer can be a complete OpenFlow raw message, with the other stuff possibly filled in.

val to_string : t -> string

to_string hdr gives a human-readable, printable rep of a OpenFlow_Header.t