com.hazelcast.client.impl.protocol.template

Interface ScheduledExecutorCodecTemplate

@Since(value="1.4")
public interface ScheduledExecutorCodecTemplate

Method Summary

Modifier and Type	Method and Description
boolean	cancelFromAddress(String schedulerName, String taskName, Address address, boolean mayInterruptIfRunning) Cancels further execution and scheduling of the task
boolean	cancelFromPartition(String schedulerName, String taskName, boolean mayInterruptIfRunning) Cancels further execution and scheduling of the task
void	disposeFromAddress(String schedulerName, String taskName, Address address) Dispose the task from the scheduler
void	disposeFromPartition(String schedulerName, String taskName) Dispose the task from the scheduler
Object	getAllScheduledFutures(String schedulerName) Returns all scheduled tasks in for a given scheduler in the given member.
long	getDelayFromAddress(String schedulerName, String taskName, Address address) Returns the ScheduledFuture's delay in nanoseconds for the task in the scheduler.
long	getDelayFromPartition(String schedulerName, String taskName) Returns the ScheduledFuture's delay in nanoseconds for the task in the scheduler.
Data	getResultFromAddress(String schedulerName, String taskName, Address address) Fetches the result of the task (Callable) The call will blocking until the result is ready.
Data	getResultFromPartition(String schedulerName, String taskName) Fetches the result of the task (Callable) The call will blocking until the result is ready.
Object	getStatsFromAddress(String schedulerName, String taskName, Address address) Returns statistics of the task
Object	getStatsFromPartition(String schedulerName, String taskName) Returns statistics of the task
boolean	isCancelledFromAddress(String schedulerName, String taskName, Address address) Checks whether a task as identified from the given handler is already cancelled.
boolean	isCancelledFromPartition(String schedulerName, String taskName) Checks whether a task as identified from the given handler is already cancelled.
boolean	isDoneFromAddress(String schedulerName, String taskName, Address address) Checks whether a task is done.
boolean	isDoneFromPartition(String schedulerName, String taskName) Checks whether a task is done.
void	shutdown(String schedulerName, Address address) Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
void	submitToAddress(String schedulerName, Address address, byte type, String taskName, Data task, long initialDelayInMillis, long periodInMillis) Submits the task to a member for execution, member is provided in the form of an address.
void	submitToPartition(String schedulerName, byte type, String taskName, Data task, long initialDelayInMillis, long periodInMillis) Submits the task to partition for execution, partition is chosen based on multiple criteria of the given task.

Method Detail

shutdown

@Since(value="1.4")
void shutdown(String schedulerName,
                                  Address address)

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

Parameters:

schedulerName - Name of the scheduler.

address - The cluster member where the shutdown for this scheduler will be sent.

submitToPartition

@Since(value="1.4")
void submitToPartition(String schedulerName,
                                           byte type,
                                           String taskName,
                                           Data task,
                                           long initialDelayInMillis,
                                           long periodInMillis)

Submits the task to partition for execution, partition is chosen based on multiple criteria of the given task.

Parameters:

schedulerName - The name of the scheduler.

type - type of schedule logic, values 0 for SINGLE_RUN, 1 for AT_FIXED_RATE

taskName - The name of the task

task - The data form of the Callable or Runnable task to be executed on that scheduler

initialDelayInMillis - initial delay in milliseconds

periodInMillis - period between each run in milliseconds

submitToAddress

@Since(value="1.4")
void submitToAddress(String schedulerName,
                                         Address address,
                                         byte type,
                                         String taskName,
                                         Data task,
                                         long initialDelayInMillis,
                                         long periodInMillis)

Submits the task to a member for execution, member is provided in the form of an address.

Parameters:

schedulerName - The name of the scheduler.

address - The address of the member where the task will get scheduled.

type - type of schedule logic, values 0 for SINGLE_RUN, 1 for AT_FIXED_RATE

taskName - The name of the task

task - The data form of the Callable or Runnable task to be executed on that scheduler

initialDelayInMillis - initial delay in milliseconds

periodInMillis - period between each run in milliseconds

getAllScheduledFutures

@Since(value="1.4")
Object getAllScheduledFutures(String schedulerName)

Returns all scheduled tasks in for a given scheduler in the given member.

Parameters:

schedulerName - The name of the scheduler.

Returns:

A list of scheduled task handlers used to construct the future proxies.

getStatsFromPartition

@Since(value="1.4")
Object getStatsFromPartition(String schedulerName,
                                                 String taskName)

Returns statistics of the task

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

Returns:

A snapshot of the task statistics

getStatsFromAddress

@Since(value="1.4")
Object getStatsFromAddress(String schedulerName,
                                               String taskName,
                                               Address address)

Returns statistics of the task

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

address - The address of the member where the task will get scheduled.

Returns:

A snapshot of the task statistics

getDelayFromPartition

@Since(value="1.4")
long getDelayFromPartition(String schedulerName,
                                               String taskName)

Returns the ScheduledFuture's delay in nanoseconds for the task in the scheduler.

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

Returns:

The remaining delay of the task formatted in nanoseconds.

getDelayFromAddress

@Since(value="1.4")
long getDelayFromAddress(String schedulerName,
                                             String taskName,
                                             Address address)

Returns the ScheduledFuture's delay in nanoseconds for the task in the scheduler.

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

address - The address of the member where the task will get scheduled.

Returns:

The remaining delay of the task formatted in nanoseconds.

cancelFromPartition

@Since(value="1.4")
boolean cancelFromPartition(String schedulerName,
                                                String taskName,
                                                boolean mayInterruptIfRunning)

Cancels further execution and scheduling of the task

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

mayInterruptIfRunning - A boolean flag to indicate whether the task should be interrupted.

Returns:

True if the task was cancelled

cancelFromAddress

@Since(value="1.4")
boolean cancelFromAddress(String schedulerName,
                                              String taskName,
                                              Address address,
                                              boolean mayInterruptIfRunning)

Cancels further execution and scheduling of the task

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

address - The address of the member where the task will get scheduled.

mayInterruptIfRunning - A boolean flag to indicate whether the task should be interrupted.

Returns:

True if the task was cancelled

isCancelledFromPartition

@Since(value="1.4")
boolean isCancelledFromPartition(String schedulerName,
                                                     String taskName)

Checks whether a task as identified from the given handler is already cancelled.

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

Returns:

True if the task is cancelled

isCancelledFromAddress

@Since(value="1.4")
boolean isCancelledFromAddress(String schedulerName,
                                                   String taskName,
                                                   Address address)

Checks whether a task as identified from the given handler is already cancelled.

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

address - The address of the member where the task will get scheduled.

Returns:

True if the task is cancelled

isDoneFromPartition

@Since(value="1.4")
boolean isDoneFromPartition(String schedulerName,
                                                String taskName)

Checks whether a task is done.

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

Returns:

True if the task is done

See Also:

java.util.concurrent.Future#cancel(boolean)}

isDoneFromAddress

@Since(value="1.4")
boolean isDoneFromAddress(String schedulerName,
                                              String taskName,
                                              Address address)

Checks whether a task is done.

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

address - The address of the member where the task will get scheduled.

Returns:

True if the task is done

See Also:

java.util.concurrent.Future#cancel(boolean)}

getResultFromPartition

@Since(value="1.4")
Data getResultFromPartition(String schedulerName,
                                                String taskName)

Fetches the result of the task (Callable) The call will blocking until the result is ready.

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

Returns:

The result of the completed task, in serialized form (Data.

getResultFromAddress

@Since(value="1.4")
Data getResultFromAddress(String schedulerName,
                                              String taskName,
                                              Address address)

Fetches the result of the task (Callable) The call will blocking until the result is ready.

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

address - The address of the member where the task will get scheduled.

Returns:

The result of the completed task, in serialized form (Data.

disposeFromPartition

@Since(value="1.4")
void disposeFromPartition(String schedulerName,
                                              String taskName)

Dispose the task from the scheduler

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

disposeFromAddress

@Since(value="1.4")
void disposeFromAddress(String schedulerName,
                                            String taskName,
                                            Address address)

Dispose the task from the scheduler

Parameters:

schedulerName - The name of the scheduler.

taskName - The name of the task

address - The address of the member where the task will get scheduled.