com.gigaspaces.internal.utils.concurrent

Class AbstractAsyncHandlerProvider

java.lang.Object

com.gigaspaces.internal.utils.concurrent.AbstractAsyncHandlerProvider

All Implemented Interfaces:

IAsyncHandlerProvider

Direct Known Subclasses:

ScheduledThreadPoolAsyncHandlerProvider, SharedHandlerProviderCache.SharedAsyncHandlerProviderWrapper, ThreadAsyncHandlerProvider

public abstract class AbstractAsyncHandlerProvider
extends Object
implements IAsyncHandlerProvider

Since:

9.0.1

Author:

eitany

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAsyncHandlerProvider.ClosedProviderAsyncHandler

Nested classes/interfaces inherited from interface com.gigaspaces.internal.utils.concurrent.IAsyncHandlerProvider

IAsyncHandlerProvider.CycleResult

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	_stateLock

Constructor Summary

Constructors

Constructor and Description
AbstractAsyncHandlerProvider()

Method Summary

Modifier and Type	Method and Description
boolean	addStateListener(IAsyncHandlerProviderStateListener listener) Adds a state listener to be notified on this provider state changes events
void	close() Close the async handler provider
boolean	isClosed() Specifies is this async handler provider is already closed
protected abstract void	onClose()
void	removeStateListener(IAsyncHandlerProviderStateListener listener) Removes the specified state listener
IAsyncHandler	start(AsyncCallable callable, long idleDelayMilis, String name, boolean waitIdleDelayBeforeStart) Start executing a runnable in a repetitive manner.
protected abstract IAsyncHandler	startImpl(AsyncCallable callable, long idleDelayMilis, String name, boolean waitIdleDelayBeforeStart)
IAsyncHandler	startMayBlock(AsyncCallable callable, long idleDelayMilis, String name, boolean waitIdleDelayBeforeStart) Start executing a runnable in a repetitive manner, the task may block during its process so the provider must be able to support this.
protected abstract IAsyncHandler	startMayBlockImpl(AsyncCallable callable, long idleDelayMilis, String name, boolean waitIdleDelayBeforeStart)

Methods inherited from class java.lang.Object

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

Field Detail

_stateLock

protected final Object _stateLock

Constructor Detail

AbstractAsyncHandlerProvider

public AbstractAsyncHandlerProvider()

Method Detail

start

public IAsyncHandler start(AsyncCallable callable,
                           long idleDelayMilis,
                           String name,
                           boolean waitIdleDelayBeforeStart)

Description copied from interface: IAsyncHandlerProvider

Start executing a runnable in a repetitive manner.

Specified by:

start in interface IAsyncHandlerProvider

Parameters:

callable - the runnable to execute at each iteration

idleDelayMilis - the delay between each iteration when the runnable returned a IAsyncHandlerProvider.CycleResult.IDLE_CONTINUE

name - hint name for the async handler if supported

waitIdleDelayBeforeStart - should the task run for the first time only after idleDelayMillis

Returns:

async handler that allows interaction with the repetitive execution of the runnable If this method is executed after the provider is a closed, the result handler will be terminated on execution IAsyncHandler.isTerminated().

startImpl

protected abstract IAsyncHandler startImpl(AsyncCallable callable,
                                           long idleDelayMilis,
                                           String name,
                                           boolean waitIdleDelayBeforeStart)

startMayBlock

public IAsyncHandler startMayBlock(AsyncCallable callable,
                                   long idleDelayMilis,
                                   String name,
                                   boolean waitIdleDelayBeforeStart)

Description copied from interface: IAsyncHandlerProvider

Start executing a runnable in a repetitive manner, the task may block during its process so the provider must be able to support this. in terms of thread pool limitations

Specified by:

startMayBlock in interface IAsyncHandlerProvider

Parameters:

callable - the runnable to execute at each iteration

idleDelayMilis - the delay between each iteration when the runnable returned a IAsyncHandlerProvider.CycleResult.IDLE_CONTINUE

name - hint name for the async handler if supported

waitIdleDelayBeforeStart - should the task run for the first time only after idleDelayMillis

Returns:

async handler that allows interaction with the repetitive execution of the runnable If this method is executed after the provider is a closed, the result handler will be terminated on execution IAsyncHandler.isTerminated().

startMayBlockImpl

protected abstract IAsyncHandler startMayBlockImpl(AsyncCallable callable,
                                                   long idleDelayMilis,
                                                   String name,
                                                   boolean waitIdleDelayBeforeStart)

close

public void close()

Description copied from interface: IAsyncHandlerProvider

Close the async handler provider

Specified by:

close in interface IAsyncHandlerProvider

onClose

protected abstract void onClose()

isClosed

public boolean isClosed()

Description copied from interface: IAsyncHandlerProvider

Specifies is this async handler provider is already closed

Specified by:

isClosed in interface IAsyncHandlerProvider

addStateListener

public boolean addStateListener(IAsyncHandlerProviderStateListener listener)

Description copied from interface: IAsyncHandlerProvider

Adds a state listener to be notified on this provider state changes events

Specified by:

addStateListener in interface IAsyncHandlerProvider

Returns:

false if this provider is already closed

removeStateListener

public void removeStateListener(IAsyncHandlerProviderStateListener listener)

Description copied from interface: IAsyncHandlerProvider

Removes the specified state listener

Specified by:

removeStateListener in interface IAsyncHandlerProvider