BackgroundPushAPI.BackgroundWorker (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.papi.helper.pipe.background.BackgroundPushAPI.BackgroundWorker

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

Enclosing class:

BackgroundPushAPI
```
protected class BackgroundPushAPI.BackgroundWorker
extends java.lang.Object
implements java.io.Flushable, java.io.Closeable
```
Background runner.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class BackgroundPushAPI.BackgroundWorker.BackgroundWorkerThread
Thread Background runner.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`BackgroundPushAPI.BackgroundWorker.BackgroundWorkerThread` Thread Background runner.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`currentBytes`
`protected int`	`currentCount`
`protected PushAPIException`	`exception`
`protected boolean`	`exit`
`protected boolean`	`isStarted`
`protected boolean`	`isWorking`
`protected java.util.ArrayList<BackgroundPushAPI.BackgroundWorkerItem>`	`items`
`protected long`	`lastWorkTick`
`protected BackgroundPushAPI.BackgroundWorker.BackgroundWorkerThread`	`thread`
`protected java.util.HashMap<java.lang.Long,java.lang.Long>`	`tickThread`

Constructor Summary

Constructors
Constructor and Description

BackgroundWorker()
Constructor.

Constructors
Constructor and Description
`BackgroundWorker()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the BackgroundPushAPI object.
`void`	`exit()` Request exit of worker thread.
`protected void`	`exitUnsync()` exit() unsynchronized.
`void`	`flush()` Flush (ie.
`void`	`flushAll()` Flush (ie.
`void`	`flushCurrent()` Flush current (ie.
`void`	`push(BackgroundPushAPI.BackgroundWorkerItem item)` Push an operation.
`protected void`	`start()` Start thread.
`void`	`startWorker()` Ensure worker thread is started.
`void`	`stopWorker()` Ensure worker thread is ended.
`protected void`	`throwIfNotRunning()` Throw an exception if the worker thread is not running.
`void`	`waitEmpty()` Wait for the background queue to be fully empty.

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

- Field Detail
  - exit
```
protected boolean exit
```
  - isStarted
```
protected boolean isStarted
```
  - isWorking
```
protected boolean isWorking
```
  - exception
```
protected PushAPIException exception
```
  - items
```
protected java.util.ArrayList<BackgroundPushAPI.BackgroundWorkerItem> items
```
  - currentCount
```
protected int currentCount
```
  - currentBytes
```
protected long currentBytes
```
  - tickThread
```
protected java.util.HashMap<java.lang.Long,java.lang.Long> tickThread
```
  - lastWorkTick
```
protected long lastWorkTick
```
  - thread
```
protected BackgroundPushAPI.BackgroundWorker.BackgroundWorkerThread thread
```
- Constructor Detail
  - BackgroundWorker
```
public BackgroundWorker()
```
    Constructor. Call start() to start the worker.
- Method Detail
  - throwIfNotRunning
```
protected void throwIfNotRunning()
                          throws PushAPIException
```
    Throw an exception if the worker thread is not running.
    
    Throws:
    
    PushAPIException
  - push
```
public void push(BackgroundPushAPI.BackgroundWorkerItem item)
          throws PushAPIException
```
    Push an operation. May block until the queue is not fulled. This function is thread-safe.
    
    Throws:
    
    PushAPIException
  - start
```
protected void start()
```
    Start thread.
  - startWorker
```
public void startWorker()
```
    Ensure worker thread is started.
  - stopWorker
```
public void stopWorker()
```
    Ensure worker thread is ended.
  - waitEmpty
```
public void waitEmpty()
               throws PushAPIException
```
    Wait for the background queue to be fully empty. This function is thread-safe.
    
    Throws:
    
    PushAPIException
  - flush
```
public void flush()
           throws java.io.IOException
```
    Flush (ie. wait for pending operations to be finished) Identical to waitEmpty() This function is thread-safe.
    
    Specified by:
    
    flush in interface java.io.Flushable
    
    Throws:
    
    java.io.IOException
  - flushAll
```
public void flushAll()
              throws PushAPIException
```
    Flush (ie. wait for pending operations to be finished) Identical to waitEmpty() This function is thread-safe.
    
    Throws:
    
    PushAPIException
  - flushCurrent
```
public void flushCurrent()
                  throws PushAPIException
```
    Flush current (ie. wait for pending operations added before this call to be finished, but do not wait for operations that might be added in the meantime) This function is thread-safe.
    
    Throws:
    
    PushAPIException
  - exitUnsync
```
protected void exitUnsync()
```
    exit() unsynchronized.
  - exit
```
public void exit()
```
    Request exit of worker thread. This function is thread-safe. If called before all thread operations finished, will cause other worker threads to choke on a PushAPIException.
  - close
```
public void close()
           throws java.io.IOException
```
    Closes the BackgroundPushAPI object. This function is thread-safe.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException

Class BackgroundPushAPI.BackgroundWorker

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

exit

isStarted

isWorking

exception

items

currentCount

currentBytes

tickThread

lastWorkTick

thread

Constructor Detail

BackgroundWorker

Method Detail

throwIfNotRunning

push

start

startWorker

stopWorker

waitEmpty

flush

flushAll

flushCurrent

exitUnsync

exit

close