Skip navigation links
A B C D E F G H I L M N O P R S T U V W X 

A

AbstractOpenFlowSwitch - Class in org.onosproject.openflow.controller.driver
An abstract representation of an OpenFlow switch.
AbstractOpenFlowSwitch() - Constructor for class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
activate(ComponentContext) - Method in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 
activateEqualSwitch() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
activateEqualSwitch() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Activate this EQUAL switch-controller relationship in the OF agent.
activateMasterSwitch() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
activateMasterSwitch() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Activate this MASTER switch-controller relationship in the OF agent.
addActivatedEqualSwitch(Dpid, OpenFlowSwitch) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Called when a switch is activated, with this controller's role as EQUAL.
addActivatedMasterSwitch(Dpid, OpenFlowSwitch) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Called when a switch is activated, with this controller's role as MASTER.
addConnectedSwitch(Dpid, OpenFlowSwitch) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Add a switch that has just connected to the system.
addEventListener(OpenFlowEventListener) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Register a listener for OF msg events.
addListener(OpenFlowSwitchListener) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Register a listener for meta events that occur to OF devices.
addMessageListener(OpenFlowMessageListener) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Register a listener for all OF msg types.
addOrUpdateFlows(FlowEntry...) - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Adds or updates typed flow entry from flow entry into the internal flow table.
addPacketListener(int, PacketListener) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Register a listener for packet events.
addWithFlowRule(FlowRule...) - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Adds typed flow entry from flow rule into the internal flow table.
applyFlowRule(FlowRule...) - Method in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 

B

block() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
block() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Blocks further responses (ie.
build(OFPort) - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
build(Ethernet, OFPort) - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
build(OFPort) - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Build the packet out in response to this packet in event.
build(Ethernet, OFPort) - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Build the packet out in response to this packet in event.
build(FlowEntry.FlowEntryState...) - Method in class org.onosproject.provider.of.flow.util.FlowEntryBuilder
 
builder(FlowRule, OFFactory, Optional<Long>, Optional<DriverService>) - Static method in class org.onosproject.provider.of.flow.impl.FlowModBuilder
Creates a new flow mod builder.
buildFlowAdd() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilder
Builds an ADD flow mod.
buildFlowAdd() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilderVer10
 
buildFlowAdd() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilderVer13
 
buildFlowDel() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilder
Builds a DELETE flow mod.
buildFlowDel() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilderVer10
 
buildFlowDel() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilderVer13
 
buildFlowMod() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilder
Builds a MODIFY flow mod.
buildFlowMod() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilderVer10
 
buildFlowMod() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilderVer13
 
buildMatch() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilder
Builds the match for the flow mod.

C

cfgService - Variable in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 
channelId - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
channelId() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
channelId() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Identifies the channel used to communicate with the switch.
configureTreatmentBuilder(List<OFAction>, TrafficTreatment.Builder, DriverHandler, DeviceId) - Static method in class org.onosproject.provider.of.flow.util.FlowEntryBuilder
Configures traffic treatment builder with a given collection of actions.
connectSwitch() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
connectSwitch() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Announce to the OpenFlow agent that this switch has connected.
controller - Variable in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 
cookie() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
cookie() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Provide the cookie in the packet in message.
createBuilder() - Method in class org.onosproject.openflow.controller.ThirdPartyMessage
 

D

datapathDescription() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
datapathDescription() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
fetch the datapath description.
deactivate(ComponentContext) - Method in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 
DefaultOpenFlowPacketContext - Class in org.onosproject.openflow.controller
Default implementation of an OpenFlowPacketContext.
deliverError(OFErrorMsg) - Method in interface org.onosproject.openflow.controller.driver.RoleHandler
Called if we receive an error message.
deliverRoleReply(RoleReplyInfo) - Method in interface org.onosproject.openflow.controller.driver.RoleHandler
Deliver a received role reply.
desc - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
deviceId - Variable in class org.onosproject.provider.of.flow.impl.FlowModBuilder
 
deviceType() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
deviceType() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Returns the switch device type.
disconnectSwitch() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
disconnectSwitch() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Disconnects the switch by closing the TCP connection.
dpid() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
Dpid - Class in org.onosproject.openflow.controller
The class representing a network switch DPID.
Dpid() - Constructor for class org.onosproject.openflow.controller.Dpid
Default constructor.
Dpid(long) - Constructor for class org.onosproject.openflow.controller.Dpid
Constructor from a long value.
Dpid(String) - Constructor for class org.onosproject.openflow.controller.Dpid
Constructor from a string.
dpid(URI) - Static method in class org.onosproject.openflow.controller.Dpid
Returns DPID created from the given device URI.
dpid() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Provide the dpid of the switch where the packet in arrived.
driverService - Variable in class org.onosproject.provider.of.flow.impl.FlowModBuilder
 
driverService - Variable in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 

E

equals(Object) - Method in class org.onosproject.openflow.controller.Dpid
 
executeBatch(FlowRuleBatchOperation) - Method in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 
ExtensionSelectorInterpreter - Interface in org.onosproject.openflow.controller
Interprets extension selectors and converts them to/from OpenFlow objects.
ExtensionTreatmentInterpreter - Interface in org.onosproject.openflow.controller
Interprets extension treatments and converts them to/from OpenFlow objects.
extractNiciraRoleReply(OFExperimenter) - Method in interface org.onosproject.openflow.controller.driver.RoleHandler
Extract the role from an OFVendor message.
extractOFRoleReply(OFRoleReply) - Method in interface org.onosproject.openflow.controller.driver.RoleHandler
Extract the role information from an OF1.3 Role Reply Message.

F

factory() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
factory() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Provides the factory for this OF version.
factory() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilder
Returns the factory used for building OpenFlow constructs.
features - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
FlowEntryBuilder - Class in org.onosproject.provider.of.flow.util
 
FlowEntryBuilder(DeviceId, OFFlowStatsEntry, DriverService) - Constructor for class org.onosproject.provider.of.flow.util.FlowEntryBuilder
 
FlowEntryBuilder(DeviceId, OFFlowRemoved, DriverService) - Constructor for class org.onosproject.provider.of.flow.util.FlowEntryBuilder
 
FlowEntryBuilder(DeviceId, OFFlowMod, DriverService) - Constructor for class org.onosproject.provider.of.flow.util.FlowEntryBuilder
 
FlowEntryBuilder.FlowType - Enum in org.onosproject.provider.of.flow.util
 
FlowModBuilder - Class in org.onosproject.provider.of.flow.impl
Builder for OpenFlow flow mods based on FlowRules.
FlowModBuilder(FlowRule, OFFactory, Optional<Long>, Optional<DriverService>) - Constructor for class org.onosproject.provider.of.flow.impl.FlowModBuilder
Constructs a flow mod builder.
FlowModBuilderVer10 - Class in org.onosproject.provider.of.flow.impl
Flow mod builder for OpenFlow 1.0.
FlowModBuilderVer10(FlowRule, OFFactory, Optional<Long>, Optional<DriverService>) - Constructor for class org.onosproject.provider.of.flow.impl.FlowModBuilderVer10
Constructor for a flow mod builder for OpenFlow 1.0.
FlowModBuilderVer13 - Class in org.onosproject.provider.of.flow.impl
Flow mod builder for OpenFlow 1.3+.
FlowModBuilderVer13(FlowRule, OFFactory, Optional<Long>, Optional<DriverService>) - Constructor for class org.onosproject.provider.of.flow.impl.FlowModBuilderVer13
Constructor for a flow mod builder for OpenFlow 1.3.
flowRemoved(FlowRule...) - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Removes typed flow entry from the internal flow table.
flowRule() - Method in class org.onosproject.provider.of.flow.impl.FlowModBuilder
Returns the flow rule for this builder.

G

getEqualSwitch(Dpid) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Returns the actual equal switch for the given Dpid, if one exists.
getEqualSwitches() - Method in interface org.onosproject.openflow.controller.OpenFlowController
Returns all equal switches known to this OF controller.
getFlowMissingXid() - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Returns flowMissingXid that indicates the execution of flowMissing process or not(NO_FLOW_MISSING_XID(-1)).
getGenId() - Method in class org.onosproject.openflow.controller.driver.RoleReplyInfo
 
getId() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
getId() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Gets the datapathId of the switch.
getMasterSwitch(Dpid) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Returns the actual master switch for the given Dpid, if one exists.
getMasterSwitches() - Method in interface org.onosproject.openflow.controller.OpenFlowController
Returns all master switches known to this OF controller.
getNextTransactionId() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
getNextTransactionId() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Gets the next transaction id to use.
getOFSwitchImpl(Dpid, OFDescStatsReply, OFVersion) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriverFactory
Constructs the real openflow switch representation.
getPorts() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
getPorts() - Method in interface org.onosproject.openflow.controller.OpenFlowOpticalSwitch
Returns a list of standard (Ethernet) ports.
getPorts() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Fetches the ports of this switch.
getPortsOf(PortDescPropertyType) - Method in interface org.onosproject.openflow.controller.WithTypedPorts
Return a list of interfaces (ports) of the type associated with this OpenFlow switch.
getPortTypes() - Method in interface org.onosproject.openflow.controller.WithTypedPorts
Returns the port property types supported by the driver implementing this interface.
getRole() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
getRole() - Method in class org.onosproject.openflow.controller.driver.RoleReplyInfo
 
getRole() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Fetch the role for this switch.
getStringId() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
getStringId() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Gets a string version of the ID for this switch.
getSwitch(Dpid) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Returns the actual switch for the given Dpid.
getSwitches() - Method in interface org.onosproject.openflow.controller.OpenFlowController
Returns all switches known to this OF controller.
getType() - Method in class org.onosproject.openflow.controller.ThirdPartyMessage
 
getVersion() - Method in class org.onosproject.openflow.controller.ThirdPartyMessage
 
getXid() - Method in class org.onosproject.openflow.controller.driver.RoleReplyInfo
 
getXid() - Method in class org.onosproject.openflow.controller.ThirdPartyMessage
 

H

handleIncomingMessage(Dpid, OFMessage) - Method in interface org.onosproject.openflow.controller.OpenFlowMessageListener
Handles all incoming OpenFlow messages.
handleMessage(OFMessage) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
Handle the message coming from the dataplane.
handleMessage(Dpid, OFMessage) - Method in interface org.onosproject.openflow.controller.OpenFlowEventListener
Handles the message event.
handleMessage(OFMessage) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Handle a message from the switch.
handleNiciraRole(OFMessage) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
handleNiciraRole(OFMessage) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
If this driver know of Nicira style role messages, these should be handled here.
handleOutgoingMessage(Dpid, List<OFMessage>) - Method in interface org.onosproject.openflow.controller.OpenFlowMessageListener
Handles all outgoing OpenFlow messages.
handlePacket(OpenFlowPacketContext) - Method in interface org.onosproject.openflow.controller.PacketListener
Handles the packet.
handleRole(OFMessage) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
handleRole(OFMessage) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Handle OF 1.x (where x > 0) role messages.
handleRoleError(OFErrorMsg) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
handleRoleError(OFErrorMsg) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Handle the situation where the role request triggers an error.
hardwareDescription() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
hardwareDescription() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
fetch the hardware description.
hashCode() - Method in class org.onosproject.openflow.controller.Dpid
 

I

init(Dpid, OFDescStatsReply, OFVersion) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
init(Dpid, OFDescStatsReply, OFVersion) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Initialises the behaviour.
inPort() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
inPort() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Provide the port on which the packet arrived.
isBuffered() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
isBuffered() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Indicates that this packet is buffered at the switch.
isConnected() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
isConnected() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Checks if the switch is still connected.
isDriverHandshakeComplete() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
isDriverHandshakeComplete() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Checks whether the driver specific handshake is complete.
isHandled() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
isHandled() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Checks whether the packet has been handled.

L

log - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
lookupChannelSpacing(ChannelSpacing) - Static method in class org.onosproject.provider.of.flow.util.OpenFlowValueMapper
Looks up the corresponding byte value for channel spacing defined in ONF "Optical Transport Protocol Extensions Version 1.0" from the specified ChannelSpacing instance.
lookupChannelSpacing(byte) - Static method in class org.onosproject.provider.of.flow.util.OpenFlowValueMapper
Looks up the corresponding ChannelSpacing instance from the specified byte value for channel spacing defined in ONF "Optical Transport Protocol Extensions Version 1.0".
lookupGridType(GridType) - Static method in class org.onosproject.provider.of.flow.util.OpenFlowValueMapper
Looks up the corresponding byte value defined in ONF "Optical Transport Protocol Extensions Version 1.0" from the specified GridType instance.
lookupGridType(byte) - Static method in class org.onosproject.provider.of.flow.util.OpenFlowValueMapper
Looks up the corresponding GridType instance from the specified byte value for grid type defined in ONF "Optical Transport Protocol Extensions Version 1.0".
lookupOchSignalType(OchSignalType) - Static method in class org.onosproject.provider.of.flow.util.OpenFlowValueMapper
Looks up the corresponding byte value for Och signal type defined in ONF "Optical Transport Protocol Extensions Version 1.0" from the specified OchSignalType instance.
lookupOchSignalType(byte) - Static method in class org.onosproject.provider.of.flow.util.OpenFlowValueMapper
Looks up the the corresponding OchSignalType instance from the specified byte value for Och signal type defined in ONF "Optical Transport Protocol Extensions Version 1.0".
lookupOduSignalType(OduSignalType) - Static method in class org.onosproject.provider.of.flow.util.OpenFlowValueMapper
Looks up the corresponding byte value for ODU signal type defined in ONF "Optical Transport Protocol Extensions Version 1.0" from the specified OchSignalType instance.
lookupOduSignalType(byte) - Static method in class org.onosproject.provider.of.flow.util.OpenFlowValueMapper
Looks up the the corresponding OchSignalType instance from the specified byte value for ODU signal type defined in ONF "Optical Transport Protocol Extensions Version 1.0".

M

manufacturerDescription() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
manufacturerDescription() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
fetch the manufacturer description.
mapAction(OFAction) - Method in interface org.onosproject.openflow.controller.ExtensionTreatmentInterpreter
Maps an OpenFlow action to an extension treatment.
mapInstruction(OFFactory, ExtensionTreatment) - Method in interface org.onosproject.openflow.controller.ExtensionTreatmentInterpreter
Maps an extension treatment to an OpenFlow action.
mapOxm(OFOxm<?>) - Method in interface org.onosproject.openflow.controller.ExtensionSelectorInterpreter
Maps an OpenFlow OXM to an extension selector.
mapSelector(OFFactory, ExtensionSelector) - Method in interface org.onosproject.openflow.controller.ExtensionSelectorInterpreter
Maps an extension selector to an OpenFlow OXM.
meterfeatures - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
modified(ComponentContext) - Method in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 

N

NewAdaptiveFlowStatsCollector - Class in org.onosproject.provider.of.flow.impl
Efficiently and adaptively collects flow statistics for the specified switch.
NO_FLOW_MISSING_XID - Static variable in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
 
NoMappingFoundException - Exception in org.onosproject.provider.of.flow.util
Thrown to indicate that no mapping for the input value is found.
NoMappingFoundException(Object, Class<?>) - Constructor for exception org.onosproject.provider.of.flow.util.NoMappingFoundException
Creates an instance with the specified values.

O

OpenFlowAgent - Interface in org.onosproject.openflow.controller.driver
Responsible for keeping track of the current set of switches connected to the system.
OpenFlowController - Interface in org.onosproject.openflow.controller
Abstraction of an OpenFlow controller.
OpenFlowEventListener - Interface in org.onosproject.openflow.controller
Notifies providers about openflow msg events.
OpenFlowMessageListener - Interface in org.onosproject.openflow.controller
Notifies providers about all OpenFlow messages.
OpenFlowOpticalSwitch - Interface in org.onosproject.openflow.controller
A marker interface for optical switches, which require the ability to pass port information to a Device provider.
OpenFlowPacketContext - Interface in org.onosproject.openflow.controller
A representation of a packet context which allows any provider to view a packet in event, but may block the response to the event if blocked has been called.
OpenFlowRuleProvider - Class in org.onosproject.provider.of.flow.impl
Provider which uses an OpenFlow controller to detect network end-station hosts.
OpenFlowRuleProvider() - Constructor for class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
Creates an OpenFlow host provider.
OpenFlowSwitch - Interface in org.onosproject.openflow.controller
Represents to provider facing side of a switch.
OpenFlowSwitchDriver - Interface in org.onosproject.openflow.controller.driver
Represents the driver side of an OpenFlow switch.
OpenFlowSwitchDriverFactory - Interface in org.onosproject.openflow.controller.driver
Switch factory which returns concrete switch objects for the physical openflow switch in use.
OpenFlowSwitchListener - Interface in org.onosproject.openflow.controller
Allows for providers interested in Switch events to be notified.
OpenFlowValueMapper - Class in org.onosproject.provider.of.flow.util
Collection of helper methods to convert protocol agnostic models to values used in OpenFlow spec.
org.onosproject.openflow.controller - package org.onosproject.openflow.controller
OpenFlow controller API.
org.onosproject.openflow.controller.driver - package org.onosproject.openflow.controller.driver
OpenFlow controller switch driver API.
org.onosproject.provider.of.flow.impl - package org.onosproject.provider.of.flow.impl
Provider that uses OpenFlow controller as a means of ending and receiving flow information.
org.onosproject.provider.of.flow.util - package org.onosproject.provider.of.flow.util
Shared utilities for OF flow rule and group providers.

P

packetContextFromPacketIn(OpenFlowSwitch, OFPacketIn) - Static method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
Creates an OpenFlow packet context based on a packet-in.
PacketListener - Interface in org.onosproject.openflow.controller
Notifies providers about Packet in events.
parsed() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
parsed() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Provided a handle onto the parsed payload.
payLoad() - Method in class org.onosproject.openflow.controller.ThirdPartyMessage
 
portChanged(Dpid, OFPortStatus) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitchListener
Notify that a port has changed.
PortDescPropertyType - Enum in org.onosproject.openflow.controller
Port description property types (OFPPDPT enums) in OF 1.3 <.
ports - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
processDownstreamMessage(Dpid, List<OFMessage>) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Notify OpenFlow message listeners on all outgoing message event.
processDriverHandshakeMessage(OFMessage) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
processDriverHandshakeMessage(OFMessage) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Process a message during the driver specific handshake.
processExpPortStats(OFMessage) - Method in interface org.onosproject.openflow.controller.OpenFlowOpticalSwitch
Returns updated PortDescriptions built from experimenter message received from device.
processMessage(Dpid, OFMessage) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Process a message coming from a switch.
processPacket(Dpid, OFMessage) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Process a message and notify the appropriate listeners.
providerRegistry - Variable in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 
pushFlowMetrics(List<FlowEntry>) - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Adds or updates typed flow entry from flow entry into the internal flow table.
putTo(PrimitiveSink) - Method in class org.onosproject.openflow.controller.ThirdPartyMessage
 

R

reassertRole() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
reassertRole() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Reasserts this controllers role to the switch.
receivedRoleReply(Dpid, RoleState, RoleState) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitchListener
Notify that a role imposed on a switch failed to take hold.
removeConnectedSwitch() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
removeConnectedSwitch(Dpid) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Clear all state in controller switch maps for a switch that has disconnected from the local controller.
removeConnectedSwitch() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Remove this switch from the openflow agent.
removeEventListener(OpenFlowEventListener) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Unregister a listener.
removeFlowRule(FlowRule...) - Method in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 
removeFlows(FlowRule...) - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Removes typed flow entry from the internal flow table.
removeListener(OpenFlowSwitchListener) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Unregister a listener.
removeMessageListener(OpenFlowMessageListener) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Unregister a listener for all OF msg types.
removePacketListener(PacketListener) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Unregister a listener.
removeRulesById(ApplicationId, FlowRule...) - Method in class org.onosproject.provider.of.flow.impl.OpenFlowRuleProvider
 
returnRoleReply(RoleState, RoleState) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
returnRoleReply(Dpid, RoleState, RoleState) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Notifies the controller that role assertion has failed.
returnRoleReply(RoleState, RoleState) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Notifies the controller that the device has responded to a set-role request.
role - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
RoleHandler - Interface in org.onosproject.openflow.controller.driver
Role handling.
RoleRecvStatus - Enum in org.onosproject.openflow.controller.driver
When we remove a pending role request we use this enum to indicate how we arrived at the decision.
RoleReplyInfo - Class in org.onosproject.openflow.controller.driver
Helper class returns role reply information in the format understood by the controller.
RoleReplyInfo(RoleState, U64, long) - Constructor for class org.onosproject.openflow.controller.driver.RoleReplyInfo
 
RoleState - Enum in org.onosproject.openflow.controller
The role of the controller as it pertains to a particular switch.

S

send() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
send() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Provided build has been called send the packet out the switch it came in on.
sendHandshakeMessage(OFMessage) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
sendHandshakeMessage(OFMessage) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Allows the handshaker behaviour to send messages during the handshake phase only.
sendMsg(OFMessage) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
sendMsg(List<OFMessage>) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
sendMsg(OFMessage) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Writes the message to the driver.
sendMsg(List<OFMessage>) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Writes the OFMessage list to the driver.
sendRoleRequest(OFMessage) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
sendRoleRequest(OFMessage) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sends only role request messages.
sendRoleRequest(RoleState, RoleRecvStatus) - Method in interface org.onosproject.openflow.controller.driver.RoleHandler
Send a role request with the given role to the switch and update the pending request and timestamp.
serialNumber() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
serialNumber() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
fetch the serial number.
setAgent(OpenFlowAgent) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setAgent(OpenFlowAgent) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the OpenFlow agent to be used.
setChannel(Channel) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setChannel(Channel) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the associated Netty channel for this switch.
setConnected(boolean) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setConnected(boolean) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets whether the switch is connected.
setFeaturesReply(OFFeaturesReply) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setFeaturesReply(OFFeaturesReply) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the features reply for this switch.
setFlowMissingXid(long) - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Sets flowMissingXid, namely OFFlowStatsRequest match any ALL message Id.
setMeterFeaturesReply(OFMeterFeaturesStatsReply) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setMeterFeaturesReply(OFMeterFeaturesStatsReply) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the meter features reply for this switch.
setOFVersion(OFVersion) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setOFVersion(OFVersion) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the OF version for this switch.
setPortDescReplies(List<OFPortDescStatsReply>) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setPortDescReplies(List<OFPortDescStatsReply>) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the ports on this switch.
setPortDescReply(OFPortDescStatsReply) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setPortDescReply(OFPortDescStatsReply) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the ports on this switch.
setRole(RoleState) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setRole(Dpid, RoleState) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Sets the role for a given switch.
setRole(RoleState) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
Sets the role for this switch.
setRoleHandler(RoleHandler) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setRoleHandler(RoleHandler) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the Role handler object.
setSwitchDescription(OFDescStatsReply) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setSwitchDescription(OFDescStatsReply) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets the switch description.
setTableFull(boolean) - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
setTableFull(boolean) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Sets this switch has having a full flowtable.
softwareDescription() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
softwareDescription() - Method in interface org.onosproject.openflow.controller.OpenFlowSwitch
fetch the software description.
start() - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Starts adaptive flow statistic collection.
startDriverHandshake() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
startDriverHandshake() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Starts the driver specific handshake process.
startDriverHandshakeCalled - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
stop() - Method in class org.onosproject.provider.of.flow.impl.NewAdaptiveFlowStatsCollector
Stops adaptive flow statistic collection.
supported(ExtensionSelectorType) - Method in interface org.onosproject.openflow.controller.ExtensionSelectorInterpreter
Returns true if the given extension selector is supported by this driver.
supported(ExtensionTreatmentType) - Method in interface org.onosproject.openflow.controller.ExtensionTreatmentInterpreter
Returns true if the given extension treatment is supported by this driver.
supportNxRole() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
supportNxRole() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Does this switch support Nicira Role messages.
switchAdded(Dpid) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitchListener
Notify that the switch was added.
switchChanged(Dpid) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitchListener
Notify that the switch has changed in some way.
SwitchDriverSubHandshakeAlreadyStarted - Exception in org.onosproject.openflow.controller.driver
Thrown when IOFSwitch.startDriverHandshake() is called more than once.
SwitchDriverSubHandshakeAlreadyStarted() - Constructor for exception org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeAlreadyStarted
 
SwitchDriverSubHandshakeCompleted - Exception in org.onosproject.openflow.controller.driver
Indicates that a message was passed to a switch driver's subhandshake handling code but the driver has already completed the sub-handshake.
SwitchDriverSubHandshakeCompleted(OFMessage) - Constructor for exception org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeCompleted
 
SwitchDriverSubHandshakeException - Exception in org.onosproject.openflow.controller.driver
Base class for exception thrown by switch driver sub-handshake processing.
SwitchDriverSubHandshakeException() - Constructor for exception org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeException
 
SwitchDriverSubHandshakeException(String, Throwable) - Constructor for exception org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeException
 
SwitchDriverSubHandshakeException(String) - Constructor for exception org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeException
 
SwitchDriverSubHandshakeException(Throwable) - Constructor for exception org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeException
 
SwitchDriverSubHandshakeNotStarted - Exception in org.onosproject.openflow.controller.driver
Thrown when a switch driver's sub-handshake has not been started but an operation requiring the sub-handshake has been attempted.
SwitchDriverSubHandshakeNotStarted() - Constructor for exception org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeNotStarted
 
SwitchDriverSubHandshakeStateException - Exception in org.onosproject.openflow.controller.driver
Thrown when a switch driver's sub-handshake state-machine receives an unexpected OFMessage and/or is in an invald state.
SwitchDriverSubHandshakeStateException(String) - Constructor for exception org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeStateException
 
switchRemoved(Dpid) - Method in interface org.onosproject.openflow.controller.OpenFlowSwitchListener
Notify that the switch was removed.
SwitchStateException - Exception in org.onosproject.openflow.controller.driver
This exception indicates an error or unexpected message during message handling.
SwitchStateException() - Constructor for exception org.onosproject.openflow.controller.driver.SwitchStateException
 
SwitchStateException(String, Throwable) - Constructor for exception org.onosproject.openflow.controller.driver.SwitchStateException
 
SwitchStateException(String) - Constructor for exception org.onosproject.openflow.controller.driver.SwitchStateException
 
SwitchStateException(Throwable) - Constructor for exception org.onosproject.openflow.controller.driver.SwitchStateException
 

T

tableFull - Variable in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
ThirdPartyMessage - Class in org.onosproject.openflow.controller
Used to support for the third party privacy flow rule.
ThirdPartyMessage(byte[]) - Constructor for class org.onosproject.openflow.controller.ThirdPartyMessage
 
toString() - Method in class org.onosproject.openflow.controller.Dpid
Convert the DPID value to a ':' separated hexadecimal string.
toString() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
toString() - Method in class org.onosproject.openflow.controller.driver.RoleReplyInfo
 
transitionToEqualSwitch() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
transitionToEqualSwitch(Dpid) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Called when this controller's role for a switch transitions to equal.
transitionToEqualSwitch() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Transition this switch-controller relationship to an EQUAL state.
transitionToMasterSwitch() - Method in class org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch
 
transitionToMasterSwitch(Dpid) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Called when this controller's role for a switch transitions from equal to master.
transitionToMasterSwitch() - Method in interface org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver
Transition this switch-controller relationship to an Master state.

U

unparsed() - Method in class org.onosproject.openflow.controller.DefaultOpenFlowPacketContext
 
unparsed() - Method in interface org.onosproject.openflow.controller.OpenFlowPacketContext
Provide an unparsed copy of the data.
uri(Dpid) - Static method in class org.onosproject.openflow.controller.Dpid
Produces device URI from the given DPID.
uri(long) - Static method in class org.onosproject.openflow.controller.Dpid
Produces device URI from the given DPID long.

V

validActivation(Dpid) - Method in interface org.onosproject.openflow.controller.driver.OpenFlowAgent
Checks if the activation for this switch is valid.
value() - Method in class org.onosproject.openflow.controller.Dpid
Get the value of the DPID.
valueOf(String) - Static method in enum org.onosproject.openflow.controller.driver.RoleRecvStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.onosproject.openflow.controller.PortDescPropertyType
Returns the enum constant of this type with the specified name.
valueOf() - Method in enum org.onosproject.openflow.controller.PortDescPropertyType
 
valueOf(String) - Static method in enum org.onosproject.openflow.controller.RoleState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.onosproject.provider.of.flow.util.FlowEntryBuilder.FlowType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.onosproject.openflow.controller.driver.RoleRecvStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.onosproject.openflow.controller.PortDescPropertyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.onosproject.openflow.controller.RoleState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.onosproject.provider.of.flow.util.FlowEntryBuilder.FlowType
Returns an array containing the constants of this enum type, in the order they are declared.

W

WithTypedPorts - Interface in org.onosproject.openflow.controller
An interface implemented by OpenFlow devices that enables providers to retrieve ports based on port property.
write(Dpid, OFMessage) - Method in interface org.onosproject.openflow.controller.OpenFlowController
Send a message to a particular switch.
writeTo(ChannelBuffer) - Method in class org.onosproject.openflow.controller.ThirdPartyMessage
 

X

xid - Variable in class org.onosproject.provider.of.flow.impl.FlowModBuilder
 
A B C D E F G H I L M N O P R S T U V W X 
Skip navigation links