AbstractProcedureScheduler (Apache HBase - Procedure 2.0.0-alpha4 API)

java.lang.Object
- org.apache.hadoop.hbase.procedure2.AbstractProcedureScheduler

All Implemented Interfaces:: ProcedureScheduler

Direct Known Subclasses:: SimpleProcedureScheduler

@InterfaceAudience.Private
public abstract class AbstractProcedureScheduler
extends Object
implements ProcedureScheduler

Constructor Summary

Constructors
Constructor and Description

AbstractProcedureScheduler()

Constructors
Constructor and Description
`AbstractProcedureScheduler()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBack(Procedure procedure)` Inserts the specified element at the end of this queue.
`void`	`addFront(Procedure procedure)` Inserts the specified element at the front of this queue.
`protected abstract Procedure`	`dequeue()` Fetch one Procedure from the queue NOTE: this method is called with the sched lock held.
`protected abstract void`	`enqueue(Procedure procedure, boolean addFront)` Add the procedure to the queue.
`long`	`getNullPollCalls()`
`long`	`getPollCalls()`
`boolean`	`hasRunnables()`
`Procedure`	`poll()` Fetch one Procedure from the queue
`Procedure`	`poll(long nanos)`
`Procedure`	`poll(long timeout, TimeUnit unit)` Fetch one Procedure from the queue
`protected void`	`push(Procedure procedure, boolean addFront, boolean notify)`
`protected abstract boolean`	`queueHasRunnables()` Returns true if there are procedures available to process.
`protected abstract int`	`queueSize()` Returns the number of elements in this queue.
`protected void`	`schedLock()`
`protected void`	`schedUnlock()`
`void`	`signalAll()` In case the class is blocking on poll() waiting for items to be added, this method should awake poll() and poll() should return.
`int`	`size()` Returns the number of elements in this queue.
`void`	`start()` Start the scheduler
`void`	`stop()` Stop the scheduler
`void`	`suspendEvent(ProcedureEvent event)` Mark the event as not ready.
`boolean`	`waitEvent(ProcedureEvent event, Procedure procedure)` Suspend the procedure if the event is not ready yet.
`protected void`	`waitProcedure(ProcedureDeque waitQueue, Procedure proc)`
`void`	`wakeEvent(ProcedureEvent event)` Wake every procedure waiting for the specified event (By design each event has only one "wake" caller)
`void`	`wakeEvents(int count, ProcedureEvent... events)` Wake every procedure waiting for the specified events.
`protected void`	`wakePollIfNeeded(int waitingCount)`
`protected void`	`wakeProcedure(Procedure procedure)`
`protected int`	`wakeWaitingProcedures(ProcedureDeque waitQueue)` Wakes up given waiting procedures by pushing them back into scheduler queues.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.procedure2.ProcedureScheduler
clear, completionCleanup, getLockResource, getLocks, yield

- Constructor Detail
  - AbstractProcedureScheduler
```
public AbstractProcedureScheduler()
```
- Method Detail
  - start
```
public void start()
```
    Description copied from interface: ProcedureScheduler
    
    Start the scheduler
    
    Specified by:
    
    start in interface ProcedureScheduler
  - stop
```
public void stop()
```
    Description copied from interface: ProcedureScheduler
    
    Stop the scheduler
    
    Specified by:
    
    stop in interface ProcedureScheduler
  - signalAll
```
public void signalAll()
```
    Description copied from interface: ProcedureScheduler
    
    In case the class is blocking on poll() waiting for items to be added, this method should awake poll() and poll() should return.
    
    Specified by:
    
    signalAll in interface ProcedureScheduler
  - enqueue
```
protected abstract void enqueue(Procedure procedure,
                                boolean addFront)
```
    Add the procedure to the queue. NOTE: this method is called with the sched lock held.
    
    Parameters:
    
    procedure - the Procedure to add
    
    addFront - true if the item should be added to the front of the queue
  - addFront
```
public void addFront(Procedure procedure)
```
    Description copied from interface: ProcedureScheduler
    
    Inserts the specified element at the front of this queue.
    
    Specified by:
    
    addFront in interface ProcedureScheduler
    
    Parameters:
    
    procedure - the Procedure to add
  - addBack
```
public void addBack(Procedure procedure)
```
    Description copied from interface: ProcedureScheduler
    
    Inserts the specified element at the end of this queue.
    
    Specified by:
    
    addBack in interface ProcedureScheduler
    
    Parameters:
    
    procedure - the Procedure to add
  - push
```
protected void push(Procedure procedure,
                    boolean addFront,
                    boolean notify)
```
  - dequeue
```
protected abstract Procedure dequeue()
```
    Fetch one Procedure from the queue NOTE: this method is called with the sched lock held.
    
    Returns:
    
    the Procedure to execute, or null if nothing is available.
  - poll
```
public Procedure poll()
```
    Description copied from interface: ProcedureScheduler
    
    Fetch one Procedure from the queue
    
    Specified by:
    
    poll in interface ProcedureScheduler
    
    Returns:
    
    the Procedure to execute, or null if nothing present.
  - poll
```
public Procedure poll(long timeout,
                      TimeUnit unit)
```
    Description copied from interface: ProcedureScheduler
    
    Fetch one Procedure from the queue
    
    Specified by:
    
    poll in interface ProcedureScheduler
    
    Parameters:
    
    timeout - how long to wait before giving up, in units of unit
    
    unit - a TimeUnit determining how to interpret the timeout parameter
    
    Returns:
    
    the Procedure to execute, or null if nothing present.
  - poll
```
public Procedure poll(long nanos)
```
  - queueSize
```
protected abstract int queueSize()
```
    Returns the number of elements in this queue. NOTE: this method is called with the sched lock held.
    
    Returns:
    
    the number of elements in this queue.
  - queueHasRunnables
```
protected abstract boolean queueHasRunnables()
```
    Returns true if there are procedures available to process. NOTE: this method is called with the sched lock held.
    
    Returns:
    
    true if there are procedures available to process, otherwise false.
  - size
```
public int size()
```
    Description copied from interface: ProcedureScheduler
    
    Returns the number of elements in this queue.
    
    Specified by:
    
    size in interface ProcedureScheduler
    
    Returns:
    
    the number of elements in this queue.
  - hasRunnables
```
public boolean hasRunnables()
```
    Specified by:
    
    hasRunnables in interface ProcedureScheduler
    
    Returns:
    
    true if there are procedures available to process, otherwise false.
  - getPollCalls
```
public long getPollCalls()
```
  - getNullPollCalls
```
public long getNullPollCalls()
```
  - waitEvent
```
public boolean waitEvent(ProcedureEvent event,
                         Procedure procedure)
```
    Description copied from interface: ProcedureScheduler
    
    Suspend the procedure if the event is not ready yet.
    
    Specified by:
    
    waitEvent in interface ProcedureScheduler
    
    Parameters:
    
    event - the event to wait on
    
    procedure - the procedure waiting on the event
    
    Returns:
    
    true if the procedure has to wait for the event to be ready, false otherwise.
  - suspendEvent
```
public void suspendEvent(ProcedureEvent event)
```
    Description copied from interface: ProcedureScheduler
    
    Mark the event as not ready. Procedures calling waitEvent() will be suspended.
    
    Specified by:
    
    suspendEvent in interface ProcedureScheduler
    
    Parameters:
    
    event - the event to mark as suspended/not ready
  - wakeEvent
```
public void wakeEvent(ProcedureEvent event)
```
    Description copied from interface: ProcedureScheduler
    
    Wake every procedure waiting for the specified event (By design each event has only one "wake" caller)
    
    Specified by:
    
    wakeEvent in interface ProcedureScheduler
    
    Parameters:
    
    event - the event to wait
  - wakeEvents
```
public void wakeEvents(int count,
                       ProcedureEvent... events)
```
    Description copied from interface: ProcedureScheduler
    
    Wake every procedure waiting for the specified events. (By design each event has only one "wake" caller)
    
    Specified by:
    
    wakeEvents in interface ProcedureScheduler
    
    Parameters:
    
    count - the number of events in the array to wake
    
    events - the list of events to wake
  - wakeWaitingProcedures
```
protected int wakeWaitingProcedures(ProcedureDeque waitQueue)
```
    Wakes up given waiting procedures by pushing them back into scheduler queues.
    
    Returns:
    
    size of given waitQueue.
  - waitProcedure
```
protected void waitProcedure(ProcedureDeque waitQueue,
                             Procedure proc)
```
  - wakeProcedure
```
protected void wakeProcedure(Procedure procedure)
```
  - schedLock
```
protected void schedLock()
```
  - schedUnlock
```
protected void schedUnlock()
```
  - wakePollIfNeeded
```
protected void wakePollIfNeeded(int waitingCount)
```

Class AbstractProcedureScheduler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hbase.procedure2.ProcedureScheduler

Constructor Detail

AbstractProcedureScheduler

Method Detail

start

stop

signalAll

enqueue

addFront

addBack

push

dequeue

poll

poll

poll

queueSize

queueHasRunnables

size

hasRunnables

getPollCalls

getNullPollCalls

waitEvent

suspendEvent

wakeEvent

wakeEvents

wakeWaitingProcedures

waitProcedure

wakeProcedure

schedLock

schedUnlock

wakePollIfNeeded