com.hp.of.common

Interface MessageSink

All Known Implementing Classes:

ProgrammableSink

public interface MessageSink

Defines the interface between the OpenflowController and the layer above it. This is where the controller will notify of the comings and goings of datapath connections, and to where it will post incoming OpenFlow messages.

Author:

Simon Hunt, Scoot Simes, Frank Wood

Method Summary

Methods

Modifier and Type	Method and Description
void	dataPathAdded(DataPathId dpid, ProtocolVersion negotiated, IpAddress ip) Invoked by the controller when a new datapath has completed the extended handshake sequence and is ready to talk OpenFlow.
void	dataPathReady(DataPathId dpid, ProtocolVersion negotiated, IpAddress ip) Invoked by the controller when a new datapath has completed the post-handshake task and is ready for some real work.
void	dataPathRemoved(DataPathId dpid, ProtocolVersion negotiated, IpAddress ip, boolean logMsg) Invoked by the controller when a datapath connection is dropped.
void	dataPathRevoked(DataPathId dpid, ProtocolVersion negotiated, IpAddress ip) Invoked by the controller when a datapath connection is refused because a datapath with the given ID is already connected.
void	msgRx(OpenflowMessage msg, DataPathId dpid, int auxId, ProtocolVersion negotiated) OpenFlow message received from the specified datapath on the given auxiliary channel.

Method Detail

dataPathAdded

void dataPathAdded(DataPathId dpid,
                 ProtocolVersion negotiated,
                 IpAddress ip)

Invoked by the controller when a new datapath has completed the extended handshake sequence and is ready to talk OpenFlow. The IP address is that of the remote end of the connection (i.e. the IP address of the switch).

Parameters:

dpid - the datapath id

negotiated - the negotiated protocol version

ip - the IP address of the switch

dataPathReady

void dataPathReady(DataPathId dpid,
                 ProtocolVersion negotiated,
                 IpAddress ip)

Invoked by the controller when a new datapath has completed the post-handshake task and is ready for some real work. The IP address is that of the remote end of the connection (i.e. the IP address of the switch).

Parameters:

dpid - the datapath id

negotiated - the negotiated protocol version

ip - the IP address of the switch

dataPathRemoved

void dataPathRemoved(DataPathId dpid,
                   ProtocolVersion negotiated,
                   IpAddress ip,
                   boolean logMsg)

Invoked by the controller when a datapath connection is dropped. The IP address is that of the remote end of the connection (i.e. the IP address of the switch). Note if one or more switches do not belong to a region, the controller will go into a connect/disconnect loop which can consume all disk space with "Datapath removed:..." log msgs. The logMsg parameter was added to prevent this from happening.

Parameters:

dpid - the datapath id

negotiated - the negotiated protocol version

ip - the IP address of the switch

logMsg - True if we should log that the datapath is being removed.

dataPathRevoked

void dataPathRevoked(DataPathId dpid,
                   ProtocolVersion negotiated,
                   IpAddress ip)

Invoked by the controller when a datapath connection is refused because a datapath with the given ID is already connected.

Parameters:

dpid - the datapath id (duplicated)

negotiated - the negotiated version

ip - the IP address of the switch

msgRx

void msgRx(OpenflowMessage msg,
         DataPathId dpid,
         int auxId,
         ProtocolVersion negotiated)

OpenFlow message received from the specified datapath on the given auxiliary channel.

Parameters:

msg - the message

dpid - the datapath ID

auxId - the auxiliary channel ID

negotiated - the negotiated protocol version