Reference

Classes

class zof.Application(name, *, controller=None, exception_fatal=False, precedence=100, arg_parser=None, has_datapath_id=True)

The zof.Application class represents a controller app.

Your app’s code registers handlers for events via an Application instance.

Parameters:

• name (str) – Name of the app.
• precedence (int) – Precedence for app event dispatch.
• exception_fatal (bool|str) – If true, abort app when a handler raises an exception. When the value is a string, it’s treated as the name of the exception logger zof.<exc_log>.
• arg_parser (argparse.ArgumentParser) – App’s argument parser.

name

str – App name.

logger

Logger – App’s logger.

args

event(subtype, **kwds)

Event decorator.

handlers

message(subtype, **kwds)

Message decorator.

oftr_connection

phase

precedence

class zof.api_compile.CompiledMessage

Abstract class representing a compiled OpenFlow message.

_controller

Controller – Controller object.

request(**kwds)

Send an OpenFlow request and receive a response.

Parameters:kwds (dict) – Template argument values.

request_all(*, parallelism=1, **kwds)

Send multiple OpenFlow requests and receive responses.

Parameters:kwds (dict) – Template argument values.

send(**kwds)

Send an OpenFlow message (fire and forget).

Parameters:kwds (dict) – Template argument values.

class zof.api_compile.CompiledObject(controller, obj)

Concrete class representing a compiled OpenFlow object template.

Functions

zof.run(*, args=None)

Run event loop for zof.

Parameters:args (Optional[argparse.Namespace]) – Arguments derived from ArgumentParser. If None, use common_args parser. If args is a list, pass these to parse_args.

zof.compile(msg)

Compile an OpenFlow message template.

zof.common_args(*, under_test=False, include_x_modules=False)

Construct default ArgumentParser parent.

Parameters:

• under_test (Boolean) – When true, create an argument parser subclass that raises an exception instead of calling exit.
• include_x_modules (Boolean) – When true, include “–x-modules” argument.