org.openkilda.messaging.model.Flow Class Reference

Inheritance diagram for org.openkilda.messaging.model.Flow:

Public Member Functions
	Flow ()
	Flow (Flow flow)
	Flow (@JsonProperty(Utils.FLOW_ID) final String flowId, @JsonProperty("bandwidth") final long bandwidth, @JsonProperty("ignore_bandwidth") Boolean ignoreBandwidth, @JsonProperty("cookie") final long cookie, @JsonProperty("description") final String description, @JsonProperty("last_updated") final String lastUpdated, @JsonProperty("src_switch") final SwitchId sourceSwitch, @JsonProperty("dst_switch") final SwitchId destinationSwitch, @JsonProperty("src_port") final int sourcePort, @JsonProperty("dst_port") final int destinationPort, @JsonProperty("src_vlan") final int sourceVlan, @JsonProperty("dst_vlan") final int destinationVlan, @JsonProperty("meter_id") final int meterId, @JsonProperty("transit_vlan") final int transitVlan, @JsonProperty(Utils.FLOW_PATH) final PathInfoData flowPath, @JsonProperty("state") FlowState state)
	Flow (String flowId, long bandwidth, boolean ignoreBandwidth, String description, SwitchId sourceSwitch, int sourcePort, int sourceVlan, SwitchId destinationSwitch, int destinationPort, int destinationVlan)
void	setIgnoreBandwidth (Boolean ignoreBandwidth)
boolean	isOneSwitchFlow ()
long	getFlagglessCookie ()
boolean	isForward ()
boolean	isReverse ()
boolean	containsSwitchInPath (SwitchId switchId)
boolean	equals (Object object)
int	hashCode ()
String	toString ()

Detailed Description

Represents flow entity.

Definition at line 42 of file Flow.java.

Constructor & Destructor Documentation

Flow() [1/4]

org.openkilda.messaging.model.Flow.Flow

(

)

Default constructor.

Definition at line 150 of file Flow.java.

Flow() [2/4]

org.openkilda.messaging.model.Flow.Flow

(

Flow

flow

)

Copy constructor.

Parameters

flow

flow

Definition at line 158 of file Flow.java.

Flow() [3/4]

org.openkilda.messaging.model.Flow.Flow	(	@JsonProperty(Utils.FLOW_ID) final String	flowId,
		@JsonProperty("bandwidth") final long	bandwidth,
		@JsonProperty("ignore_bandwidth") Boolean	ignoreBandwidth,
		@JsonProperty("cookie") final long	cookie,
		@JsonProperty("description") final String	description,
		@JsonProperty("last_updated") final String	lastUpdated,
		@JsonProperty("src_switch") final SwitchId	sourceSwitch,
		@JsonProperty("dst_switch") final SwitchId	destinationSwitch,
		@JsonProperty("src_port") final int	sourcePort,
		@JsonProperty("dst_port") final int	destinationPort,
		@JsonProperty("src_vlan") final int	sourceVlan,
		@JsonProperty("dst_vlan") final int	destinationVlan,
		@JsonProperty("meter_id") final int	meterId,
		@JsonProperty("transit_vlan") final int	transitVlan,
		@JsonProperty(Utils.FLOW_PATH) final PathInfoData	flowPath,
		@JsonProperty("state") FlowState	state
	)

Instance constructor.

Parameters

flowId	flow id
bandwidth	bandwidth
ignoreBandwidth	ignore bandwidth flag
cookie	cookie
description	description
lastUpdated	last updated timestamp
sourceSwitch	source switch
destinationSwitch	destination switch
sourcePort	source port
destinationPort	destination port
sourceVlan	source vlan id
destinationVlan	destination vlan id
meterId	meter id
transitVlan	transit vlan id
flowPath	flow switch path
state	flow state

Definition at line 199 of file Flow.java.

Flow() [4/4]

org.openkilda.messaging.model.Flow.Flow	(	String	flowId,
		long	bandwidth,
		boolean	ignoreBandwidth,
		String	description,
		SwitchId	sourceSwitch,
		int	sourcePort,
		int	sourceVlan,
		SwitchId	destinationSwitch,
		int	destinationPort,
		int	destinationVlan
	)

Instance constructor.

Parameters

flowId	flow id
bandwidth	bandwidth
ignoreBandwidth	ignore bandwidth flag
description	description
sourceSwitch	source switch
sourcePort	source port
sourceVlan	source vlan id
destinationSwitch	destination switch
destinationPort	destination port
destinationVlan	destination vlan id

Definition at line 247 of file Flow.java.

Member Function Documentation

containsSwitchInPath()

boolean org.openkilda.messaging.model.Flow.containsSwitchInPath

(

SwitchId

switchId

)

Checks if flow path contains specified switch.

Parameters

switchId

switch id

Returns

true if flow path contains specified switch

Definition at line 342 of file Flow.java.

equals()

boolean org.openkilda.messaging.model.Flow.equals

(

Object

object

)

Definition at line 351 of file Flow.java.

getFlagglessCookie()

long org.openkilda.messaging.model.Flow.getFlagglessCookie

(

)

Definition at line 287 of file Flow.java.

hashCode()

int org.openkilda.messaging.model.Flow.hashCode

(

)

Definition at line 376 of file Flow.java.

isForward()

boolean org.openkilda.messaging.model.Flow.isForward

(

)

Returns whether this represents a forward flow. The result is based on the cookie value, see Flow#cookieMarkedAsFroward and Flow#cookieMarkedAsReversed().

Definition at line 297 of file Flow.java.

isOneSwitchFlow()

boolean org.openkilda.messaging.model.Flow.isOneSwitchFlow

(

)

Returns whether this is a single switch flow.

Definition at line 278 of file Flow.java.

isReverse()

boolean org.openkilda.messaging.model.Flow.isReverse

(

)

Definition at line 310 of file Flow.java.

setIgnoreBandwidth()

void org.openkilda.messaging.model.Flow.setIgnoreBandwidth

(

Boolean

ignoreBandwidth

)

Sets the ignoreBandwidth.

Parameters

ignoreBandwidth

ignore bandwidth flag

Definition at line 267 of file Flow.java.

toString()

String org.openkilda.messaging.model.Flow.toString

(

)

Definition at line 385 of file Flow.java.

---

The documentation for this class was generated from the following file:

• /Users/kevin/Desktop/Kilda/open-kilda-develop/services/src/messaging/src/main/java/org/openkilda/messaging/model/Flow.java