com.bigdata.bop.engine

Class HaltOpMessage

java.lang.Object

com.bigdata.bop.engine.HaltOpMessage

All Implemented Interfaces:

IHaltOpMessage, IOpLifeCycleMessage, IOpMessage, Externalizable, Serializable

public class HaltOpMessage
extends Object
implements Externalizable, IHaltOpMessage

A message sent to the IQueryClient when an operator is done executing for some chunk of inputs.

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HaltOpMessage() De-serialization constructor.
HaltOpMessage(UUID queryId, int bopId, int partitionId, UUID serviceId, Throwable cause, int sinkMessagesOut, int altSinkMessagesOut, BOpStats taskStats)

Method Summary

Methods

Modifier and Type	Method and Description
int	getAltSinkMessagesOut() The number of the IChunkMessages that were output for the alternative sink.
int	getBOpId() Return the operator identifier.
Throwable	getCause() The cause and null if the operator halted normally.
int	getPartitionId() Return the index partition identifier.
UUID	getQueryId() Return the query identifier.
UUID	getServiceId() Return the identifier of the service on which the operator will/did execute.
int	getSinkMessagesOut() The number of the IChunkMessages that were output for the primary sink.
BOpStats	getStats() The statistics for the execution of the bop against the partition on the service.
void	readExternal(ObjectInput in)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

HaltOpMessage

public HaltOpMessage()

De-serialization constructor.

HaltOpMessage

public HaltOpMessage(UUID queryId,
             int bopId,
             int partitionId,
             UUID serviceId,
             Throwable cause,
             int sinkMessagesOut,
             int altSinkMessagesOut,
             BOpStats taskStats)

Parameters:

queryId - The query identifier.

bopId - The operator whose execution phase has terminated for a specific index partition and input chunk.

partitionId - The index partition against which the operator was executed.

serviceId - The node which executed the operator.

cause - null unless execution halted abnormally.

sinkMessagesOut - The number of IChunkMessage which were sent to the operator for the default sink.

altSinkMessagesOut - The number of IChunkMessage which were sent to the operator for the alternative sink.

taskStats - The statistics for the execution of that bop on that shard and service.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getQueryId

public UUID getQueryId()

Description copied from interface: IOpMessage

Return the query identifier.

Specified by:

getQueryId in interface IOpMessage

getBOpId

public int getBOpId()

Description copied from interface: IOpMessage

Return the operator identifier.

Specified by:

getBOpId in interface IOpMessage

getPartitionId

public int getPartitionId()

Description copied from interface: IOpMessage

Return the index partition identifier.

Specified by:

getPartitionId in interface IOpMessage

getServiceId

public UUID getServiceId()

Description copied from interface: IOpLifeCycleMessage

Return the identifier of the service on which the operator will/did execute.

Specified by:

getServiceId in interface IOpLifeCycleMessage

getCause

public Throwable getCause()

Description copied from interface: IHaltOpMessage

The cause and null if the operator halted normally.

Specified by:

getCause in interface IHaltOpMessage

getSinkMessagesOut

public int getSinkMessagesOut()

Description copied from interface: IHaltOpMessage

The number of the IChunkMessages that were output for the primary sink. (This information is used for the atomic termination decision.)

For a given downstream operator this is ONE (1) for scale-up. For scale-out, this is one per index partition over which the intermediate results were mapped.

Specified by:

getSinkMessagesOut in interface IHaltOpMessage

getAltSinkMessagesOut

public int getAltSinkMessagesOut()

Description copied from interface: IHaltOpMessage

The number of the IChunkMessages that were output for the alternative sink. (This information is used for the atomic termination decision.)

For a given downstream operator this is ONE (1) for scale-up. For scale-out, this is one per index partition over which the intermediate results were mapped. It is zero if there was no alternative sink for the operator.

Specified by:

getAltSinkMessagesOut in interface IHaltOpMessage

getStats

public BOpStats getStats()

Description copied from interface: IHaltOpMessage

The statistics for the execution of the bop against the partition on the service.

Specified by:

getStats in interface IHaltOpMessage

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException