Class ExecutionEnvironment

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.executionenvironment.ExecutionEnvironment

public final class ExecutionEnvironment
extends oracle.pgx.api.internal.ApiObject

A session bound environment holding the execution configuration for each task type.

Constructor Summary

Constructors

Constructor	Description
ExecutionEnvironment(PgxSession session, oracle.pgx.api.internal.CoreSessionApi coreSessionApi)

Method Summary

Modifier and Type	Method	Description
boolean	allowsConcurrentTasks()	Blocking version of allowsConcurrentTasksAsync().
PgxFuture<Boolean>	allowsConcurrentTasksAsync()	Checks if the session allows the tasks to run concurrently.
CpuEnvironment	getAnalysisEnvironment()
CpuEnvironment	getFastAnalysisEnvironment()
IoEnvironment	getIoEnvironment()
PgxSession	getSession()
List<Map.Entry<String,Object>>	getValues()	Blocking version of getValuesAsync().
PgxFuture<List<Map.Entry<String,Object>>>	getValuesAsync()
void	reset()	Blocking version of resetAsync().
PgxFuture<Void>	resetAsync()	Resets the environment for this session to the configured default values.
String	toString()
<T> T	withMaxNumThreads(int maxNumThreads, Supplier<PgxFuture<T>> asyncRequest)	Blocking version of withMaxNumThreadsAsync(int, Supplier).
<T> PgxFuture<T>	withMaxNumThreadsAsync(int maxNumThreads, Supplier<PgxFuture<T>> asyncRequest)	Executes the given asynchronous request with at most maxNumThreads.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ExecutionEnvironment

public ExecutionEnvironment(PgxSession session,
 oracle.pgx.api.internal.CoreSessionApi coreSessionApi)

Method Details

getValuesAsync

public PgxFuture<List<Map.Entry<String,Object>>> getValuesAsync()

Returns:

the current configuration

withMaxNumThreadsAsync

public <T> PgxFuture<T> withMaxNumThreadsAsync(int maxNumThreads,
 Supplier<PgxFuture<T>> asyncRequest)

Executes the given asynchronous request with at most maxNumThreads. This affects all task types.

Parameters:

maxNumThreads - the maximum number of threads to use for the request

asyncRequest - the asynchronous request to execute

Returns:

the result of the asynchronous request

resetAsync

public PgxFuture<Void> resetAsync()

Resets the environment for this session to the configured default values.

reset

public void reset()
           throws ExecutionException,
InterruptedException

Blocking version of resetAsync(). Calls resetAsync() and waits for returned PgxFuture to complete.

Throws:

InterruptedException - if the caller thread gets interrupted while waiting for completion.

ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

withMaxNumThreads

public <T> T withMaxNumThreads(int maxNumThreads,
 Supplier<PgxFuture<T>> asyncRequest)
                        throws ExecutionException,
InterruptedException

Blocking version of withMaxNumThreadsAsync(int, Supplier). Calls withMaxNumThreadsAsync(int, Supplier) and waits for returned PgxFuture to complete.

Throws:

InterruptedException - if the caller thread gets interrupted while waiting for completion.

ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getValues

public List<Map.Entry<String,Object>> getValues()
                                         throws ExecutionException,
InterruptedException

Blocking version of getValuesAsync(). Calls getValuesAsync() and waits for returned PgxFuture to complete.

Throws:

InterruptedException - if the caller thread gets interrupted while waiting for completion.

ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getSession

public PgxSession getSession()

Returns:

the session associated with this execution environment.

getIoEnvironment

public IoEnvironment getIoEnvironment()

Returns:

the execution environment for IO tasks

getAnalysisEnvironment

public CpuEnvironment getAnalysisEnvironment()

Returns:

the execution environment for analysis tasks

getFastAnalysisEnvironment

public CpuEnvironment getFastAnalysisEnvironment()

Returns:

the execution environment for fast analysis tasks

allowsConcurrentTasksAsync

public PgxFuture<Boolean> allowsConcurrentTasksAsync()

Checks if the session allows the tasks to run concurrently.

Returns:

true if the session allows concurrent tasks, false otherwise

Since:

3.3.0

allowsConcurrentTasks

public boolean allowsConcurrentTasks()

Blocking version of allowsConcurrentTasksAsync(). Calls allowsConcurrentTasksAsync() and waits for returned PgxFuture to complete.

toString

public String toString()

Overrides:

toString in class Object