gui Package

gui Package

entities Module

Host, switch and link GUI entities that belong to the QGraphicsScene in TopologyView

class sts.gui.entities.GuiHost(graphics_scene, _id)

Bases: sts.gui.entities.GuiNode

Interactive Host

mouseReleaseEvent(event)

paint(painter, option, widget)

class sts.gui.entities.GuiLink(graphics_scene, source_node, dest_node)

Bases: PyQt4.QtGui.QGraphicsItem

Interactive Link

__init__(graphics_scene, source_node, dest_node)

adjust()

boundingRect()

paint(painter, option, widget)

class sts.gui.entities.GuiNode(graphics_scene, _id)

Bases: PyQt4.QtGui.QGraphicsItem

Abstract Interactive Node

If switch, id = switch.dpid If host, id = host.hid

__init__(graphics_scene, _id)

addLink(link)

boundingRect()

hoverLeaveEvent(event)

itemChange(change, value)

links()

mouseDoubleClickEvent(event)

mousePressEvent(event)

popupnode_detailsMenu()

shape()

class sts.gui.entities.GuiSwitch(graphics_scene, _id)

Bases: sts.gui.entities.GuiNode

Interactive Switch

mouseReleaseEvent(event)

Popup menu contains:

Add Link To – Remove Link To – Attach Host Remove Host – Remove Switch

paint(painter, option, widget)

launcher Module

This file creates the GUI application window in a separate thread

class sts.gui.launcher.GuiWindow(sts_topology, syncPeriod=2.0, debugging=False)

Bases: PyQt4.QtGui.QMainWindow

QMainWindow container for TopologyWidget

__init__(sts_topology, syncPeriod=2.0, debugging=False)

center()

class sts.gui.launcher.TopologyGui(sts_topology, syncPeriod=2.0, debugging=False)

Invoked directly by the STS Topology class to launch a new GUI instance

__init__(sts_topology, syncPeriod=2.0, debugging=False)

launch()

class sts.gui.launcher.TopologyWidget(sts_topology, parent=None, syncPeriod=2.0, debugging=False)

Bases: PyQt4.QtGui.QWidget

QWidget container for TopologyView

__init__(sts_topology, parent=None, syncPeriod=2.0, debugging=False)

view Module

Graphical representation of STS topology switch, host and link entities

class sts.gui.view.STSSyncer(sts_topology, topology_view, sync_period=2.0, debugging=True)

Container of Node and Link objects in GUI that periodically syncs with STS Topology

__init__(sts_topology, topology_view, sync_period=2.0, debugging=True)

add_access_link(hid, dpid)

Add and register an access link in GUI

add_host(hid, position=None)

Add and register a host in GUI with the given hid and position

add_network_link(from_dpid, to_dpid)

Add and register a unidirectional network link in GUI

add_switch(dpid, position=None)

Add and register a switch in GUI with the given dpid and position

attach_host_to_switch(dpid)

Create a host and attach it to the switch with the given dpid in both STS and GUI

create_network_link(from_dpid, to_dpid)

Create a unidirectional network link in both STS and GUI

create_switch(dpid=None)

Create a switch with the given dpid in both STS and GUI

debug(msg)

deserialize_host(s)

Format Example:

{“ingress_switch_dpids”:[1,3],

“position”:(-60.0,20.0)}

deserialize_network_link(s)

Format Example:

{“from_switch_dpid”:5,

“to_switch_dpid”:3}

deserialize_switch(s)

Format Example:

{“dpid”:5,

“numports”:3 “position”:(-10.0,80.0)}

dpids

get_sts_host(gui_host)

Given a host in GUI, return the corresponding host in STS by hid

get_sts_switch(gui_switch)

Given a switch in GUI, return the corresponding switch in STS by dpid

hids

hosts

links

load_state()

Load all JSON serialized entities of both the STS and GUI topologies from a file Each line is in the format (type, serialized_entity):

“s” = switch “h” = host “l” = network link

Switches must be loaded first

remove_host(hid)

Remove a host and all associated access links in both STS and GUI

remove_network_link(from_dpid, to_dpid)

Remove a unidirectional network link in both STS and GUI

remove_switch(dpid)

Remove a switch in both STS and GUI, along with all associated links and any dangling hosts previously attached

reset()

Reset GUI topology

save_state()

Save all JSON serialized entities of both the STS and GUI topologies to a file Each line is in the format (<entity type>, <serialized form>):

“s” = switch “h” = host “l” = network link

Access links need not be saved, because there is a one to one correspondence between hosts and access links

serialize_host(gui_host, sts_host)

Format Example:

{“ingress_switch_dpids”:[1,3],

“position”:(-60.0,20.0)}

serialize_network_link(sts_link)

Format Example:

{“from_switch_dpid”:5,

“to_switch_dpid”:3}

serialize_switch(gui_switch, sts_switch)

Format Example:

{“dpid”:5,

“numports”:3 “position”:(-10.0,80.0)}

switches

sync_with_sts()

Resync all network elements if STS and GUI are persistently desynchronized

synced_with_sts()

Return True if GUI and STS share the same map of nodes and links

toggle_debug_messages()

class sts.gui.view.TopologyView(sts_topology, parent=None, sync_period=2.0, debugging=False)

Bases: PyQt4.QtGui.QGraphicsView

QGraphicsView that provides a graphical representation of STS topology

__init__(sts_topology, parent=None, sync_period=2.0, debugging=False)

mouseReleaseEvent(event)

Show context menu when right-clicking on empty space on the scene.