OpenFlow version independent classes and functions¶

This is a base class for OpenFlow message classes.

An instance of this class has at least the following attributes.

_TYPE¶

_TYPE class attribute is used to annotate types of attributes.

This type information is used to find an appropriate conversion for a JSON style dictionary.

Currently the following types are implemented.

Type	Descrption
ascii	US-ASCII
utf-8	UTF-8

Example:

_TYPE = {
    'ascii': [
        'hw_addr',
    ],
    'utf-8': [
        'name',
    ]
}

classmethod from_jsondict(dict_, decode_string=<function b64decode>, **additional_args)¶

Create an instance from a JSON style dict.

Instantiate this class with parameters specified by the dict.

This method takes the following arguments.

Argument	Descrpition
dict_	A dictionary which describes the parameters. For example, {"Param1": 100, "Param2": 200}
decode_string	(Optional) specify how to decode strings. The default is base64. This argument is used only for attributes which don't have explicit type annotations in _TYPE class attribute.
additional_args	(Optional) Additional kwargs for constructor.

to_jsondict(encode_string=<function b64encode>)¶

This method returns a JSON style dict to describe this object.

The returned dict is compatible with json.dumps() and json.loads().

Suppose ClassName object inherits StringifyMixin. For an object like the following:

ClassName(Param1=100, Param2=200)

this method would produce:

{ "ClassName": {"Param1": 100, "Param2": 200} }

This method takes the following arguments.

Argument	Description
encode_string	(Optional) specify how to encode attributes which has python 'str' type. The default is base64. This argument is used only for attributes which don't have explicit type annotations in _TYPE class attribute.