com.hp.of.ctl

Interface RoleAdvisor

public interface RoleAdvisor

Provides an abstraction of the "Role Service".

Author:

Thomas Vachuska, Simon Hunt

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isEnforcingRegions() Returns true if the service is actively enforcing regions.
boolean	isMasterFor(DataPathId dpid) Returns true if the local controller instance has the Master role for the specified data path; false otherwise.
boolean	isValidRegionAddress(IpAddress ip) Returns true if the given address is defined in a region.
void	postHandshake(DataPathId dpid, IpAddress ip, ProtocolVersion pv, Runnable task, Runnable ownerOnlyTask) Called to inform the service of a post-handshake.
void	preDisconnected(DataPathId dpid, IpAddress ip, ProtocolVersion pv) Called to inform the service of a disconnection.

Method Detail

isMasterFor

boolean isMasterFor(DataPathId dpid)

Returns true if the local controller instance has the Master role for the specified data path; false otherwise.

Parameters:

dpid - the target datapath

Returns:

true if this controller is Master; false otherwise

isEnforcingRegions

boolean isEnforcingRegions()

Returns true if the service is actively enforcing regions.

Returns:

true if regions are being enforced

isValidRegionAddress

boolean isValidRegionAddress(IpAddress ip)

Returns true if the given address is defined in a region.

Returns:

true if the given address is defined in a region.

postHandshake

void postHandshake(DataPathId dpid,
                 IpAddress ip,
                 ProtocolVersion pv,
                 Runnable task,
                 Runnable ownerOnlyTask)

Called to inform the service of a post-handshake.

Parameters:

dpid - data path ID of the connection

ip - device IP of the connection

pv - protocol version

task - post handshake task to run

ownerOnlyTask - addition post handshake task to run if owner

preDisconnected

void preDisconnected(DataPathId dpid,
                   IpAddress ip,
                   ProtocolVersion pv)

Called to inform the service of a disconnection.

Parameters:

dpid - data path ID of the connection

ip - device IP of the connection

pv - protocol version