org.apache.ignite.internal.processors.platform

Class PlatformAbstractTarget

java.lang.Object

org.apache.ignite.internal.processors.platform.PlatformAbstractTarget

All Implemented Interfaces:

PlatformTarget

Direct Known Subclasses:

PlatformAbstractQueryCursor, PlatformAffinity, PlatformAffinityFunctionTarget, PlatformAtomicLong, PlatformAtomicReference, PlatformAtomicSequence, PlatformCache, PlatformCacheIterator, PlatformClusterGroup, PlatformCompute, PlatformDataStreamer, PlatformEvents, PlatformMessaging, PlatformServices, PlatformTransactions

public abstract class PlatformAbstractTarget
extends Object
implements PlatformTarget

Abstract interop target.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	FALSE Constant: FALSE.
protected IgniteLogger	log Logger.
protected PlatformContext	platformCtx Context.
protected static int	TRUE Constant: TRUE.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlatformAbstractTarget(PlatformContext platformCtx) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Exception	convertException(Exception e) Convert caught exception.
protected IgniteInternalFuture	currentFuture() When overridden in a derived class, gets future for the current operation.
protected PlatformFutureUtils.Writer	futureWriter(int opId) When overridden in a derived class, gets a custom future writer.
void	inObjectStreamOutStream(int type, Object arg, long inMemPtr, long outMemPtr) Operation accepting an object and a memory stream and returning result to another memory stream.
long	inStreamOutLong(int type, long memPtr) Operation accepting memory stream and returning long value.
Object	inStreamOutObject(int type, long memPtr) Operation accepting memory stream and returning object.
void	inStreamOutStream(int type, long inMemPtr, long outMemPtr) Operation accepting one memory stream and returning result to another memory stream.
void	listenFuture(long futId, int typ) Start listening for the future.
PlatformListenable	listenFutureAndGet(long futId, int typ) Start listening for the future.
void	listenFutureForOperation(long futId, int typ, int opId) Start listening for the future for specific operation type.
PlatformListenable	listenFutureForOperationAndGet(long futId, int typ, int opId) Start listening for the future for specific operation type.
long	outLong(int type) Operation returning long result.
Object	outObject(int type) Operation returning object result.
void	outStream(int type, long memPtr) Operation returning result to memory stream.
PlatformContext	platformContext()
protected void	processInObjectStreamOutStream(int type, Object arg, BinaryRawReaderEx reader, BinaryRawWriterEx writer) Process IN-OUT operation.
protected long	processInStreamOutLong(int type, BinaryRawReaderEx reader) Process IN operation.
protected Object	processInStreamOutObject(int type, BinaryRawReaderEx reader) Process IN operation with managed object as result.
protected void	processInStreamOutStream(int type, BinaryRawReaderEx reader, BinaryRawWriterEx writer) Process IN-OUT operation.
protected long	processOutLong(int type) Process OUT operation.
protected Object	processOutObject(int type) Process OUT operation.
protected void	processOutStream(int type, BinaryRawWriterEx writer) Process OUT operation.
protected <T> T	throwUnsupported(int type) Throw an exception rendering unsupported operation type.

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

protected static final int TRUE

Constant: TRUE.

See Also:

Constant Field Values

FALSE

protected static final int FALSE

Constant: FALSE.

See Also:

Constant Field Values

platformCtx

protected final PlatformContext platformCtx

Context.

log

protected final IgniteLogger log

Logger.

Constructor Detail

PlatformAbstractTarget

protected PlatformAbstractTarget(PlatformContext platformCtx)

Constructor.

Parameters:

platformCtx - Context.

Method Detail

inStreamOutLong

public long inStreamOutLong(int type,
                   long memPtr)
                     throws Exception

Operation accepting memory stream and returning long value.

Specified by:

inStreamOutLong in interface PlatformTarget

Parameters:

type - Operation type.

memPtr - Memory pointer.

Returns:

Result.

Throws:

Exception - If case of failure.

inStreamOutObject

public Object inStreamOutObject(int type,
                       long memPtr)
                         throws Exception

Operation accepting memory stream and returning object.

Specified by:

inStreamOutObject in interface PlatformTarget

Parameters:

type - Operation type.

memPtr - Memory pointer.

Returns:

Result.

Throws:

Exception - If case of failure.

outLong

public long outLong(int type)
             throws Exception

Operation returning long result.

Specified by:

outLong in interface PlatformTarget

Parameters:

type - Operation type.

Returns:

Result.

Throws:

Exception - In case of failure.

outStream

public void outStream(int type,
             long memPtr)
               throws Exception

Operation returning result to memory stream.

Specified by:

outStream in interface PlatformTarget

Parameters:

type - Operation type.

memPtr - Memory pointer.

Throws:

Exception - In case of failure.

outObject

public Object outObject(int type)
                 throws Exception

Operation returning object result.

Specified by:

outObject in interface PlatformTarget

Parameters:

type - Operation type.

Returns:

Result.

Throws:

Exception - If failed.

inStreamOutStream

public void inStreamOutStream(int type,
                     long inMemPtr,
                     long outMemPtr)
                       throws Exception

Operation accepting one memory stream and returning result to another memory stream.

Specified by:

inStreamOutStream in interface PlatformTarget

Parameters:

type - Operation type.

inMemPtr - Input memory pointer.

outMemPtr - Output memory pointer.

Throws:

Exception - In case of failure.

inObjectStreamOutStream

public void inObjectStreamOutStream(int type,
                           Object arg,
                           long inMemPtr,
                           long outMemPtr)
                             throws Exception

Operation accepting an object and a memory stream and returning result to another memory stream.

Specified by:

inObjectStreamOutStream in interface PlatformTarget

Parameters:

type - Operation type.

arg - Argument (optional).

inMemPtr - Input memory pointer.

outMemPtr - Output memory pointer.

Throws:

Exception - In case of failure.

convertException

public Exception convertException(Exception e)

Convert caught exception.

Parameters:

e - Exception to convert.

Returns:

Converted exception.

platformContext

public PlatformContext platformContext()

Returns:

Context.

listenFuture

public void listenFuture(long futId,
                int typ)
                  throws Exception

Start listening for the future.

Specified by:

listenFuture in interface PlatformTarget

Parameters:

futId - Future ID.

typ - Result type.

Throws:

IgniteCheckedException - In case of failure.

Exception

listenFutureForOperation

public void listenFutureForOperation(long futId,
                            int typ,
                            int opId)
                              throws Exception

Start listening for the future for specific operation type.

Specified by:

listenFutureForOperation in interface PlatformTarget

Parameters:

futId - Future ID.

typ - Result type.

opId - Operation ID required to pick correct result writer.

Throws:

IgniteCheckedException - In case of failure.

Exception

listenFutureAndGet

public PlatformListenable listenFutureAndGet(long futId,
                                    int typ)
                                      throws Exception

Start listening for the future.

Specified by:

listenFutureAndGet in interface PlatformTarget

Parameters:

futId - Future ID.

typ - Result type.

Throws:

IgniteCheckedException - In case of failure.

Exception

listenFutureForOperationAndGet

public PlatformListenable listenFutureForOperationAndGet(long futId,
                                                int typ,
                                                int opId)
                                                  throws Exception

Start listening for the future for specific operation type.

Specified by:

listenFutureForOperationAndGet in interface PlatformTarget

Parameters:

futId - Future ID.

typ - Result type.

opId - Operation ID required to pick correct result writer.

Throws:

IgniteCheckedException - In case of failure.

Exception

currentFuture

protected IgniteInternalFuture currentFuture()
                                      throws IgniteCheckedException

When overridden in a derived class, gets future for the current operation.

Returns:

current future.

Throws:

IgniteCheckedException

futureWriter

@Nullable
protected PlatformFutureUtils.Writer futureWriter(int opId)

When overridden in a derived class, gets a custom future writer.

Parameters:

opId - Operation id.

Returns:

A custom writer for given op id.

processInStreamOutLong

protected long processInStreamOutLong(int type,
                          BinaryRawReaderEx reader)
                               throws IgniteCheckedException

Process IN operation.

Parameters:

type - Type.

reader - Binary reader.

Returns:

Result.

Throws:

IgniteCheckedException - In case of exception.

processInStreamOutStream

protected void processInStreamOutStream(int type,
                            BinaryRawReaderEx reader,
                            BinaryRawWriterEx writer)
                                 throws IgniteCheckedException

Process IN-OUT operation.

Parameters:

type - Type.

reader - Binary reader.

writer - Binary writer.

Throws:

IgniteCheckedException - In case of exception.

processInStreamOutObject

protected Object processInStreamOutObject(int type,
                              BinaryRawReaderEx reader)
                                   throws IgniteCheckedException

Process IN operation with managed object as result.

Parameters:

type - Type.

reader - Binary reader.

Returns:

Result.

Throws:

IgniteCheckedException - In case of exception.

processInObjectStreamOutStream

protected void processInObjectStreamOutStream(int type,
                                  @Nullable
                                  Object arg,
                                  BinaryRawReaderEx reader,
                                  BinaryRawWriterEx writer)
                                       throws IgniteCheckedException

Process IN-OUT operation.

Parameters:

type - Type.

arg - Argument.

reader - Binary reader.

writer - Binary writer.

Throws:

IgniteCheckedException - In case of exception.

processOutLong

protected long processOutLong(int type)
                       throws IgniteCheckedException

Process OUT operation.

Parameters:

type - Type.

Throws:

IgniteCheckedException - In case of exception.

processOutStream

protected void processOutStream(int type,
                    BinaryRawWriterEx writer)
                         throws IgniteCheckedException

Process OUT operation.

Parameters:

type - Type.

writer - Binary writer.

Throws:

IgniteCheckedException - In case of exception.

processOutObject

protected Object processOutObject(int type)
                           throws IgniteCheckedException

Process OUT operation.

Parameters:

type - Type.

Throws:

IgniteCheckedException - In case of exception.

throwUnsupported

protected <T> T throwUnsupported(int type)
                      throws IgniteCheckedException

Throw an exception rendering unsupported operation type.

Parameters:

type - Operation type.

Returns:

Dummy value which is never returned.

Throws:

IgniteCheckedException - Exception to be thrown.