oracle.pgx.api.executionenvironment

Class CpuEnvironment

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.executionenvironment.CpuEnvironment

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

A sub environment for CPU bound tasks

See Also:

AnalysisTaskConfig

Method Summary

Modifier and Type	Method and Description
int	getMaxNumThreads() Blocking version of getMaxNumThreadsAsync().
PgxFuture<java.lang.Integer>	getMaxNumThreadsAsync()
TaskPriority	getPriority() Blocking version of getPriorityAsync().
PgxFuture<TaskPriority>	getPriorityAsync()
java.util.Map<java.lang.String,java.lang.Object>	getValues() Blocking version of getValuesAsync().
PgxFuture<java.util.Map<java.lang.String,java.lang.Object>>	getValuesAsync()
int	getWeight() Blocking version of getWeightAsync().
PgxFuture<java.lang.Integer>	getWeightAsync()
void	reset() Blocking version of resetAsync().
PgxFuture<java.lang.Void>	resetAsync() reset the sub environment to the configured default values
void	setMaxNumThreads(java.lang.Integer maxNumThreads) Blocking version of setMaxNumThreadsAsync(Integer).
PgxFuture<java.lang.Void>	setMaxNumThreadsAsync(java.lang.Integer maxNumThreads) Sets the limit on the numbers of thread to use to the given value
void	setPriority(TaskPriority priority) Blocking version of setPriorityAsync(TaskPriority).
PgxFuture<java.lang.Void>	setPriorityAsync(TaskPriority priority) Sets the priority to the given value
void	setWeight(java.lang.Integer weight) Blocking version of setWeightAsync(Integer).
PgxFuture<java.lang.Void>	setWeightAsync(java.lang.Integer weight) Sets the weight to the given value
java.lang.String	toString()
<T> T	withMaxNumThreads(int maxNumThreads, java.util.function.Supplier<PgxFuture<T>> asyncRequest) Blocking version of withMaxNumThreadsAsync(int, Supplier).
<T> PgxFuture<T>	withMaxNumThreadsAsync(int maxNumThreads, java.util.function.Supplier<PgxFuture<T>> asyncRequest) Executes the given asynchronous request with the given limit on the number of threads to use
<T> T	withPriority(TaskPriority priority, java.util.function.Supplier<PgxFuture<T>> asyncRequest) Blocking version of withPriorityAsync(TaskPriority, Supplier).
<T> PgxFuture<T>	withPriorityAsync(TaskPriority priority, java.util.function.Supplier<PgxFuture<T>> asyncRequest) Executes the given asynchronous request with the given priority.
<T> T	withWeight(int weight, java.util.function.Supplier<PgxFuture<T>> asyncRequest) Blocking version of withWeightAsync(int, Supplier).
<T> PgxFuture<T>	withWeightAsync(int weight, java.util.function.Supplier<PgxFuture<T>> asyncRequest) Executes the given asynchronous request with the given weight.

Methods inherited from class java.lang.Object

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

Method Detail

getMaxNumThreads

public int getMaxNumThreads()
                     throws java.util.concurrent.ExecutionException,
                            java.lang.InterruptedException

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

Throws:

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

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

getMaxNumThreadsAsync

public PgxFuture<java.lang.Integer> getMaxNumThreadsAsync()

Returns:

the currently configured limit on the numbers of thread to use

See Also:

AnalysisTaskConfig.Field.MAX_THREADS

getPriority

public TaskPriority getPriority()
                         throws java.util.concurrent.ExecutionException,
                                java.lang.InterruptedException

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

Throws:

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

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

getPriorityAsync

public PgxFuture<TaskPriority> getPriorityAsync()

Returns:

the currently configured priority

See Also:

AnalysisTaskConfig.Field.PRIORITY

getWeight

public int getWeight()
              throws java.util.concurrent.ExecutionException,
                     java.lang.InterruptedException

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

Throws:

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

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

getWeightAsync

public PgxFuture<java.lang.Integer> getWeightAsync()

Returns:

the currently configured weight

See Also:

AnalysisTaskConfig.Field.WEIGHT

setMaxNumThreads

public void setMaxNumThreads(java.lang.Integer maxNumThreads)
                      throws java.util.concurrent.ExecutionException,
                             java.lang.InterruptedException

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

Throws:

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

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

setMaxNumThreadsAsync

public PgxFuture<java.lang.Void> setMaxNumThreadsAsync(java.lang.Integer maxNumThreads)

Sets the limit on the numbers of thread to use to the given value

Parameters:

maxNumThreads - the new limit on the numbers of threads to use

See Also:

AnalysisTaskConfig.Field.MAX_THREADS

setPriority

public void setPriority(TaskPriority priority)
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

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

Throws:

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

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

setPriorityAsync

public PgxFuture<java.lang.Void> setPriorityAsync(TaskPriority priority)

Sets the priority to the given value

Parameters:

priority - the new priority

See Also:

AnalysisTaskConfig.Field.PRIORITY

setWeight

public void setWeight(java.lang.Integer weight)
               throws java.util.concurrent.ExecutionException,
                      java.lang.InterruptedException

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

Throws:

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

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

setWeightAsync

public PgxFuture<java.lang.Void> setWeightAsync(java.lang.Integer weight)

Sets the weight to the given value

Parameters:

weight - the new weight

See Also:

AnalysisTaskConfig.Field.WEIGHT

withMaxNumThreads

public <T> T withMaxNumThreads(int maxNumThreads,
                               java.util.function.Supplier<PgxFuture<T>> asyncRequest)
                        throws java.util.concurrent.ExecutionException,
                               java.lang.InterruptedException

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

Throws:

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

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

withMaxNumThreadsAsync

public <T> PgxFuture<T> withMaxNumThreadsAsync(int maxNumThreads,
                                               java.util.function.Supplier<PgxFuture<T>> asyncRequest)

Executes the given asynchronous request with the given limit on the number of threads to use

Parameters:

maxNumThreads - the temporary limit on the numbers of threads to use

asyncRequest - the request to execute

Returns:

the result of the asynchronous request

withPriority

public <T> T withPriority(TaskPriority priority,
                          java.util.function.Supplier<PgxFuture<T>> asyncRequest)
                   throws java.util.concurrent.ExecutionException,
                          java.lang.InterruptedException

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

Throws:

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

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

withPriorityAsync

public <T> PgxFuture<T> withPriorityAsync(TaskPriority priority,
                                          java.util.function.Supplier<PgxFuture<T>> asyncRequest)

Executes the given asynchronous request with the given priority.

Parameters:

priority - the temporary priority

asyncRequest - the request to execute

Returns:

the result of the asynchronous request

withWeight

public <T> T withWeight(int weight,
                        java.util.function.Supplier<PgxFuture<T>> asyncRequest)
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

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

Throws:

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

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

withWeightAsync

public <T> PgxFuture<T> withWeightAsync(int weight,
                                        java.util.function.Supplier<PgxFuture<T>> asyncRequest)

Executes the given asynchronous request with the given weight.

Parameters:

weight - the temporary weight

asyncRequest - the request to execute

Returns:

the result of the asynchronous request

getValues

public final java.util.Map<java.lang.String,java.lang.Object> getValues()
                                                                 throws java.util.concurrent.ExecutionException,
                                                                        java.lang.InterruptedException

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

Throws:

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

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

getValuesAsync

public final PgxFuture<java.util.Map<java.lang.String,java.lang.Object>> getValuesAsync()

Returns:

the current configuration of the sub environment

reset

public final void reset()
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

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

Throws:

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

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

resetAsync

public final PgxFuture<java.lang.Void> resetAsync()

reset the sub environment to the configured default values

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object