com.bigdata.bop.fed

Class NIOChunkMessage<E>

java.lang.Object

com.bigdata.bop.fed.NIOChunkMessage<E>

All Implemented Interfaces:

IChunkMessage<E>, IOpMessage, Serializable

public class NIOChunkMessage<E>
extends Object
implements IChunkMessage<E>, Serializable

An IChunkMessage where the payload is made available to the receiving service using an NIO transfer against the sender's ResourceService. This is suitable for moving large blocks of data during query evaluation.

Author:

Bryan Thompson

See Also:

ResourceService should use NIO for file and buffer transfers, Support NIO solution set interchange on the cluster TODO Implement {@link Externalizable} for this class based on the {@link ThickChunkMessage} and {@link IVSolutionSetEncoder}., Serialized Form

Constructor Summary

Constructors

Constructor and Description
NIOChunkMessage(IQueryClient queryController, UUID queryId, int sinkId, int partitionId, DirectBufferPoolAllocator.IAllocationContext allocationContext, E[] source, InetSocketAddress addr)

Method Summary

Methods

Modifier and Type	Method and Description
int	getBOpId() Return the operator identifier.
int	getBytesAvailable() The #of bytes of data which are available for that operator.
IChunkAccessor<E>	getChunkAccessor() Return an interface which may be used to access the chunk's data.
int	getPartitionId() Return the index partition identifier.
IQueryClient	getQueryController() The proxy for the query controller.
UUID	getQueryControllerId() The UUID of the query controller (the IQueryClient to which the query was submitted).
UUID	getQueryId() Return the query identifier.
InetSocketAddress	getServiceAddr() The Internet address and port of a ResourceService from which the receiver may demand the data.
int	getSolutionCount() The #of elements in this chunk.
boolean	isLastInvocation() Return true iff the IChunkMessage is for the last evaluation pass of an operator.
boolean	isMaterialized() Return true if the chunk is materialized on the receiver.
void	materialize(FederatedRunningQuery runningQuery) Materialize the chunk on the receiver.
protected void	materialize(ManagedResourceService resourceService, DirectBufferPoolAllocator.IAllocationContext allocationContext) Core implementation.
void	release() Discard the materialized data.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NIOChunkMessage

public NIOChunkMessage(IQueryClient queryController,
               UUID queryId,
               int sinkId,
               int partitionId,
               DirectBufferPoolAllocator.IAllocationContext allocationContext,
               E[] source,
               InetSocketAddress addr)

Parameters:

queryController -

queryId -

sinkId -

partitionId -

allocations - The ordered list of DirectBufferPoolAllocator.IAllocations comprising the chunk.

addr - The Internet address and port where the receiver can fetch the payload using the sender's ResourceService.

Method Detail

getQueryController

public IQueryClient getQueryController()

Description copied from interface: IChunkMessage

The proxy for the query controller.

Specified by:

getQueryController in interface IChunkMessage<E>

See Also:

Optimize serialization for query messages on cluster, The query controller should be discoverable

getQueryControllerId

public UUID getQueryControllerId()

Description copied from interface: IChunkMessage

The UUID of the query controller (the IQueryClient to which the query was submitted).

Specified by:

getQueryControllerId in interface IChunkMessage<E>

See Also:

https://sourceforge.net/apps/trac/bigdata/ticket/475

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

isLastInvocation

public boolean isLastInvocation()

Description copied from interface: IChunkMessage

Return true iff the IChunkMessage is for the last evaluation pass of an operator. The last evaluation pass for an operator must be requested using an annotation. When it is requested, the operator will be invoked one more time for each node or shard on which it was run (depending on the BOpEvaluationContext). When so invoked, the IChunkMessage will be associated with an empty source and this flag will be set.

Specified by:

isLastInvocation in interface IChunkMessage<E>

See Also:

PipelineOp.Annotations#LAST_PASS

getSolutionCount

public int getSolutionCount()

The #of elements in this chunk.

Specified by:

getSolutionCount in interface IChunkMessage<E>

getBytesAvailable

public int getBytesAvailable()

The #of bytes of data which are available for that operator.

getServiceAddr

public InetSocketAddress getServiceAddr()

The Internet address and port of a ResourceService from which the receiver may demand the data.

toString

public String toString()

Overrides:

toString in class Object

isMaterialized

public boolean isMaterialized()

Description copied from interface: IChunkMessage

Return true if the chunk is materialized on the receiver.

Specified by:

isMaterialized in interface IChunkMessage<E>

materialize

public void materialize(FederatedRunningQuery runningQuery)

Description copied from interface: IChunkMessage

Materialize the chunk on the receiver.

Specified by:

materialize in interface IChunkMessage<E>

Parameters:

runningQuery - The running query.

release

public void release()

Discard the materialized data.

Specified by:

release in interface IChunkMessage<E>

materialize

protected void materialize(ManagedResourceService resourceService,
               DirectBufferPoolAllocator.IAllocationContext allocationContext)

Core implementation. This is responsible receiving the data from the remote ResourceService and assembling it into a set of DirectBufferPoolAllocator.IAllocations in the specified DirectBufferPoolAllocator.IAllocationContext.

Parameters:

resourceService -

allocationContext -

getChunkAccessor

public IChunkAccessor<E> getChunkAccessor()

Description copied from interface: IChunkMessage

Return an interface which may be used to access the chunk's data.

Specified by:

getChunkAccessor in interface IChunkMessage<E>