SplitLogWorkerCoordination (Apache HBase 1.2.12 API)

All Known Implementing Classes:

ZkSplitLogWorkerCoordination
```
@InterfaceAudience.Private
public interface SplitLogWorkerCoordination
```
Coordinated operations for SplitLogWorker and WALSplitterHandler Important methods for SplitLogWorker:
isReady() called from SplitLogWorker.run() to check whether the coordination is ready to supply the tasks
taskLoop() loop for new tasks until the worker is stopped
isStop() a flag indicates whether worker should finish
registerListener() called from SplitLogWorker.run() and could register listener for external changes in coordination (if required)
endTask(SplitLogTask, AtomicLong, SplitTaskDetails) notify coordination engine that
Important methods for WALSplitterHandler:
splitting task has completed.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SplitLogWorkerCoordination.SplitTaskDetails` Interface for log-split tasks Used to carry implementation details in encapsulated way through Handlers to the coordination API.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_MAX_SPLITTERS

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_SPLITTERS`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`endTask(SplitLogTask slt, AtomicLong ctr, SplitLogWorkerCoordination.SplitTaskDetails splitTaskDetails)` Notify coordination engine that splitting task has completed.
`org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.RegionStoreSequenceIds`	`getRegionFlushedSequenceId(String failedServerName, String key)`
`int`	`getTaskReadySeq()` Used by unit tests to check how many tasks were processed
`void`	`init(RegionServerServices server, org.apache.hadoop.conf.Configuration conf, SplitLogWorker.TaskExecutor splitTaskExecutor, SplitLogWorker worker)` Initialize internal values.
`boolean`	`isReady()` Check whether the log splitter is ready to supply tasks
`boolean`	`isStop()`
`void`	`markCorrupted(org.apache.hadoop.fs.Path rootDir, String name, org.apache.hadoop.fs.FileSystem fs)` marks log file as corrupted
`void`	`registerListener()` set the listener for task changes.
`void`	`removeListener()` remove the listener for task changes.
`void`	`stopProcessingTasks()` called when Coordination should stop processing tasks and exit
`void`	`taskLoop()` Wait for the new tasks and grab one

- Field Detail
  - DEFAULT_MAX_SPLITTERS
```
static final int DEFAULT_MAX_SPLITTERS
```
    See Also:
    Constant Field Values
- Method Detail
  - init
```
void init(RegionServerServices server,
        org.apache.hadoop.conf.Configuration conf,
        SplitLogWorker.TaskExecutor splitTaskExecutor,
        SplitLogWorker worker)
```
    Initialize internal values. This method should be used when corresponding SplitLogWorker instance is created
    
    Parameters:
    server - instance of RegionServerServices to work with
    conf - is current configuration.
    splitTaskExecutor - split executor from SplitLogWorker
    worker - instance of SplitLogWorker
  - stopProcessingTasks
```
void stopProcessingTasks()
```
    called when Coordination should stop processing tasks and exit
  - isStop
```
boolean isStop()
```
    Returns:
    the current value of exitWorker
  - taskLoop
```
void taskLoop()
              throws InterruptedException
```
    Wait for the new tasks and grab one
    
    Throws:
    
    InterruptedException - if the SplitLogWorker was stopped
  - markCorrupted
```
void markCorrupted(org.apache.hadoop.fs.Path rootDir,
                 String name,
                 org.apache.hadoop.fs.FileSystem fs)
```
    marks log file as corrupted
    
    Parameters:
    rootDir - where to find the log
    name - of the log
    fs - file system
  - isReady
```
boolean isReady()
                throws InterruptedException
```
    Check whether the log splitter is ready to supply tasks
    
    Returns:
    false if there is no tasks
    
    Throws:
    
    InterruptedException - if the SplitLogWorker was stopped
  - getTaskReadySeq
```
int getTaskReadySeq()
```
    Used by unit tests to check how many tasks were processed
    
    Returns:
    number of tasks
  - registerListener
```
void registerListener()
```
    set the listener for task changes. Implementation specific
  - removeListener
```
void removeListener()
```
    remove the listener for task changes. Implementation specific
  - endTask
```
void endTask(SplitLogTask slt,
           AtomicLong ctr,
           SplitLogWorkerCoordination.SplitTaskDetails splitTaskDetails)
```
    Notify coordination engine that splitting task has completed.
    
    Parameters:
    slt - See SplitLogTask
    ctr - counter to be updated
    splitTaskDetails - details about log split task (specific to coordination engine being used).
  - getRegionFlushedSequenceId
```
org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.RegionStoreSequenceIds getRegionFlushedSequenceId(String failedServerName,
                                                                                                               String key)
                                                                                                                 throws IOException
```
    Throws:
    
    IOException

Interface SplitLogWorkerCoordination

Nested Class Summary

Field Summary

Method Summary

Field Detail

DEFAULT_MAX_SPLITTERS

Method Detail

init

stopProcessingTasks

isStop

taskLoop

markCorrupted

isReady

getTaskReadySeq

registerListener

removeListener

endTask

getRegionFlushedSequenceId