com.hp.of.lib.msg

Class MessageBatchFuture

java.lang.Object

com.hp.of.lib.msg.DefaultMessageFuture

com.hp.of.lib.msg.DataPathMessageFuture

com.hp.of.lib.msg.MessageBatchFuture

All Implemented Interfaces:

MessageFuture

public class MessageBatchFuture
extends DataPathMessageFuture

A future for a batch of flow-mod messages sent to a specific datapath. Instances are created with the static method:

 List<OfmFlowMod> flows = ...;
 DataPathId dpid = ...;
 MessageBatchFuture batchFuture =
         MessageBatchFuture.createBatchFuture(flows, dpid);
 

A barrier request is generated on the caller's behalf and assigned as the principal message. Waiting on the batchFuture is the same as waiting on the future for the barrier request. Once it is satisfied (and the waiter unblocked), the result for the batch will reflect the aggregate state of all messages associated with the batch.

Author:

Simon Hunt

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.of.lib.msg.MessageFuture

MessageFuture.Result

Field Summary

Fields inherited from class com.hp.of.lib.msg.DefaultMessageFuture

cause, reply, request, xid

Method Summary

Methods

Modifier and Type	Method and Description
static MessageBatchFuture	createBatchFuture(List<OfmFlowMod> flows, DataPathId dpid) Creates and returns a message batch future for the given messages destined for the specified datapath.
List<DataPathMessageFuture>	getFailedFutures() Returns the futures for the flow mods that failed.
List<DataPathMessageFuture>	getFlowFutures() Returns the futures for the flow mods associated with this batch.
List<String>	reconcileFlowFutures() Invoked by the caller once they have confirmation that the barrier request has been satisfied with a barrier response.
MessageFuture.Result	result() Returns the future's result.
protected void	satisfied() Invoked when the future is satisfied.
String	toDebugString() Returns a multi-line string representation of this batch of futures.
String	toString()

Methods inherited from class com.hp.of.lib.msg.DataPathMessageFuture

dpid

Methods inherited from class com.hp.of.lib.msg.DefaultMessageFuture

await, await, awaitUninterruptibly, awaitUninterruptibly, cause, problemString, reply, request, setFailure, setFailure, setFailureTimeout, setSuccess, setSuccess, xid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

result

public MessageFuture.Result result()

Description copied from interface: MessageFuture

Returns the future's result.

Specified by:

result in interface MessageFuture

Overrides:

result in class DefaultMessageFuture

Returns:

the future's result

satisfied

protected void satisfied()

Description copied from class: DefaultMessageFuture

Invoked when the future is satisfied. This default implementation does nothing. Subclasses may override to do housekeeping, before listeners are awoken.

Overrides:

satisfied in class DefaultMessageFuture

toString

public String toString()

Overrides:

toString in class DefaultMessageFuture

getFlowFutures

public List<DataPathMessageFuture> getFlowFutures()

Returns the futures for the flow mods associated with this batch.

Returns:

the flow mod futures

getFailedFutures

public List<DataPathMessageFuture> getFailedFutures()

Returns the futures for the flow mods that failed.

Returns:

the failed flow mod futures

toDebugString

public String toDebugString()

Returns a multi-line string representation of this batch of futures.

Returns:

a multi-line string representation

reconcileFlowFutures

public List<String> reconcileFlowFutures()

Invoked by the caller once they have confirmation that the barrier request has been satisfied with a barrier response. Note that this method should only be invoked once; subsequent invocations will have no effect.

This method processes the flow-mod futures and generates an error string (suitable for logging) for each failed future. If all went well, an empty list will be returned, indicating no errors.

This method also sets the aggregate result for the batch.

Returns:

the list of errors, if any

createBatchFuture

public static MessageBatchFuture createBatchFuture(List<OfmFlowMod> flows,
                                   DataPathId dpid)

Creates and returns a message batch future for the given messages destined for the specified datapath. Note that a barrier request is generated on the caller's behalf, and added to the set of messages to be submitted.

Parameters:

flows - the batch of flows to send

dpid - the target datapath

Returns:

the batch message future

Throws:

NullPointerException - if either parameter is null

IllegalArgumentException - if flows list is empty