MessageTask (common 0.0.1 API)

java.lang.Object
- com.serenegiant.utils.MessageTask

All Implemented Interfaces:: java.lang.Runnable

Direct Known Subclasses:: EglTask

public abstract class MessageTask
extends java.lang.Object
implements java.lang.Runnable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class MessageTask.Request

static class MessageTask.TaskBreak

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`MessageTask.Request`
`static class`	`MessageTask.TaskBreak`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`REQUEST_TASK_NON`
`protected static int`	`REQUEST_TASK_QUIT`
`protected static int`	`REQUEST_TASK_RUN`
`protected static int`	`REQUEST_TASK_RUN_AND_WAIT`
`protected static int`	`REQUEST_TASK_START`

Constructor Summary

Constructors
Constructor and Description
`MessageTask()` コンストラクタプール&キューのサイズは無制限プールは空で生成
`MessageTask(int init_num)` コンストラクタプール&キューのサイズは無制限
`MessageTask(int max_request, int init_num)` コンストラクタプール及びキュー可能な最大サイズを指定して初期化

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`callOnError(java.lang.Exception e)` エラー処理。
`protected void`	`init(int arg1, int arg2, java.lang.Object obj)` 初期化要求。
`boolean`	`isFinished()`
`boolean`	`isRunning()`
`protected MessageTask.Request`	`obtain(int request, int arg1, int arg2, java.lang.Object obj)` RequestプールからRequestを取得するプールが空の場合は新規に生成する
`boolean`	`offer(int request)` offer request to run on worker thread
`boolean`	`offer(int request, int arg1)` offer request to run on worker thread
`boolean`	`offer(int request, int arg1, int arg2)` offer request to run on worker thread
`boolean`	`offer(int request, int arg1, int arg2, java.lang.Object obj)` offer request to run on worker thread
`boolean`	`offer(int request, int arg1, java.lang.Object obj)` offer request to run on worker thread
`boolean`	`offer(int request, java.lang.Object obj)` offer request to run on worker thread
`java.lang.Object`	`offerAndWait(int request, int arg1, int arg2, java.lang.Object obj)` offer request to run on worker thread and wait for result caller thread is blocked until the request finished running on worker thread FIXME このメソッドはMessageTaskを実行中のスレッド上で呼び出すとデッドロックする
`boolean`	`offerFirst(int request, int arg1, int arg2, java.lang.Object obj)` offer request to run on worker thread on top of the request queue
`protected void`	`onBeforeStop()` onStopの直前に呼び出される, interruptされた時は呼び出されない
`protected boolean`	`onError(java.lang.Exception e)` メッセージ処理ループ中でのエラー発生時の処理デフフォルトはtrueを返しメッセージ処理ループを終了する
`protected abstract void`	`onInit(int arg1, int arg2, java.lang.Object obj)` 初期化処理
`protected abstract void`	`onRelease()` onStop後に呼び出される。
`protected abstract void`	`onStart()` 要求処理ループ開始直前に呼ばれる
`protected abstract void`	`onStop()` 停止処理, interruptされた時は呼び出されない
`protected abstract java.lang.Object`	`processRequest(int request, int arg1, int arg2, java.lang.Object obj)` 要求メッセージの処理(内部メッセージは来ない) TaskBreakをthrowすると要求メッセージ処理ループを終了する
`boolean`	`queueEvent(java.lang.Runnable task)` request to run on worker thread
`void`	`release()` request terminate worker thread and release all related resources
`void`	`release(boolean interrupt)` request terminate worker thread and release all related resources
`void`	`releaseSelf()` 実行中のタスクが終了後開放する
`void`	`removeRequest(int request)`
`void`	`removeRequest(MessageTask.Request request)`
`void`	`run()`
`protected MessageTask.Request`	`takeRequest()` 要求メッセージを取り出す処理(要求メッセージがなければブロックされる)
`void`	`userBreak()` processRequest内でメッセージループを非常終了させるためのヘルパーメソッド単にTaskBreakをthrowするだけ
`boolean`	`waitReady()`

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

- Field Detail
  - REQUEST_TASK_NON
```
protected static final int REQUEST_TASK_NON
```
    See Also:
    
    Constant Field Values
  - REQUEST_TASK_RUN
```
protected static final int REQUEST_TASK_RUN
```
    See Also:
    
    Constant Field Values
  - REQUEST_TASK_RUN_AND_WAIT
```
protected static final int REQUEST_TASK_RUN_AND_WAIT
```
    See Also:
    
    Constant Field Values
  - REQUEST_TASK_START
```
protected static final int REQUEST_TASK_START
```
    See Also:
    
    Constant Field Values
  - REQUEST_TASK_QUIT
```
protected static final int REQUEST_TASK_QUIT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MessageTask
```
public MessageTask()
```
    コンストラクタプール&キューのサイズは無制限プールは空で生成
  - MessageTask
```
public MessageTask(int init_num)
```
    コンストラクタプール&キューのサイズは無制限
    
    Parameters:
    
    init_num - プールするRequestの初期数を指定
  - MessageTask
```
public MessageTask(int max_request,
                   int init_num)
```
    コンストラクタプール及びキュー可能な最大サイズを指定して初期化
    
    Parameters:
    
    max_request - キューの最大サイズを指定
    
    init_num - プールするRequestの初期数を指定, max_requestよりも大きければ切り捨てる
- Method Detail
  - init
```
protected void init(int arg1,
                    int arg2,
                    java.lang.Object obj)
```
    初期化要求。継承クラスのコンストラクタから呼び出すことパラメータはonInitに引き渡される
    
    Parameters:
    
    arg1 -
    
    arg2 -
    
    obj -
  - onInit
```
protected abstract void onInit(int arg1,
                               int arg2,
                               java.lang.Object obj)
```
    初期化処理
  - onStart
```
protected abstract void onStart()
```
    要求処理ループ開始直前に呼ばれる
  - onBeforeStop
```
protected void onBeforeStop()
```
    onStopの直前に呼び出される, interruptされた時は呼び出されない
  - onStop
```
protected abstract void onStop()
```
    停止処理, interruptされた時は呼び出されない
  - onRelease
```
protected abstract void onRelease()
```
    onStop後に呼び出される。onStopで例外発生しても呼ばれる
  - onError
```
protected boolean onError(java.lang.Exception e)
```
    メッセージ処理ループ中でのエラー発生時の処理デフフォルトはtrueを返しメッセージ処理ループを終了する
    
    Returns:
    
    trueを返すとメッセージ処理ループを終了する
  - processRequest
```
protected abstract java.lang.Object processRequest(int request,
                                                   int arg1,
                                                   int arg2,
                                                   java.lang.Object obj)
                                            throws MessageTask.TaskBreak
```
    要求メッセージの処理(内部メッセージは来ない) TaskBreakをthrowすると要求メッセージ処理ループを終了する
    
    Throws:
    
    MessageTask.TaskBreak
  - takeRequest
```
protected MessageTask.Request takeRequest()
                                   throws java.lang.InterruptedException
```
    要求メッセージを取り出す処理(要求メッセージがなければブロックされる)
    
    Throws:
    
    java.lang.InterruptedException
  - waitReady
```
public boolean waitReady()
```
  - isRunning
```
public boolean isRunning()
```
  - isFinished
```
public boolean isFinished()
```
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - callOnError
```
protected boolean callOnError(java.lang.Exception e)
```
    エラー処理。onErrorを呼び出す。 trueを返すと要求メッセージ処理ループを終了する
    
    Parameters:
    
    e -
    
    Returns:
  - obtain
```
protected MessageTask.Request obtain(int request,
                                     int arg1,
                                     int arg2,
                                     java.lang.Object obj)
```
    RequestプールからRequestを取得するプールが空の場合は新規に生成する
    
    Parameters:
    
    request - minus values and zero are reserved
    
    arg1 -
    
    arg2 -
    
    obj -
    
    Returns:
    
    Request
  - offer
```
public boolean offer(int request,
                     int arg1,
                     int arg2,
                     java.lang.Object obj)
```
    offer request to run on worker thread
    
    Parameters:
    
    request - minus values and zero are reserved
    
    arg1 -
    
    arg2 -
    
    obj -
    
    Returns:
    
    true if success offer
  - offer
```
public boolean offer(int request,
                     int arg1,
                     java.lang.Object obj)
```
    offer request to run on worker thread
    
    Parameters:
    
    request - minus values and zero are reserved
    
    arg1 -
    
    obj -
    
    Returns:
    
    true if success offer
  - offer
```
public boolean offer(int request,
                     int arg1,
                     int arg2)
```
    offer request to run on worker thread
    
    Parameters:
    
    request - minus values and zero are reserved
    
    arg1 -
    
    arg2 -
    
    Returns:
    
    true if success offer
  - offer
```
public boolean offer(int request,
                     int arg1)
```
    offer request to run on worker thread
    
    Parameters:
    
    request - minus values and zero are reserved
    
    arg1 -
    
    Returns:
    
    true if success offer
  - offer
```
public boolean offer(int request)
```
    offer request to run on worker thread
    
    Parameters:
    
    request - minus values and zero are reserved
    
    Returns:
    
    true if success offer
  - offer
```
public boolean offer(int request,
                     java.lang.Object obj)
```
    offer request to run on worker thread
    
    Parameters:
    
    request - minus values and zero are reserved
    
    obj -
    
    Returns:
    
    true if success offer
  - offerFirst
```
public boolean offerFirst(int request,
                          int arg1,
                          int arg2,
                          java.lang.Object obj)
```
    offer request to run on worker thread on top of the request queue
    
    Parameters:
    
    request - minus values and zero are reserved
    
    arg1 -
    
    arg2 -
  - offerAndWait
```
public java.lang.Object offerAndWait(int request,
                                     int arg1,
                                     int arg2,
                                     java.lang.Object obj)
```
    offer request to run on worker thread and wait for result caller thread is blocked until the request finished running on worker thread FIXME このメソッドはMessageTaskを実行中のスレッド上で呼び出すとデッドロックする
    
    Parameters:
    
    request -
    
    arg1 -
    
    arg2 -
    
    obj -
    
    Returns:
  - queueEvent
```
public boolean queueEvent(java.lang.Runnable task)
```
    request to run on worker thread
    
    Parameters:
    
    task -
    
    Returns:
    
    true if success queue
  - removeRequest
```
public void removeRequest(MessageTask.Request request)
```
  - removeRequest
```
public void removeRequest(int request)
```
  - release
```
public void release()
```
    request terminate worker thread and release all related resources
  - release
```
public void release(boolean interrupt)
```
    request terminate worker thread and release all related resources
    
    Parameters:
    
    interrupt - trueなら実行中のタスクをinterruptする
  - releaseSelf
```
public void releaseSelf()
```
    実行中のタスクが終了後開放する
  - userBreak
```
public void userBreak()
               throws MessageTask.TaskBreak
```
    processRequest内でメッセージループを非常終了させるためのヘルパーメソッド単にTaskBreakをthrowするだけ
    
    Throws:
    
    MessageTask.TaskBreak

Class MessageTask

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REQUEST_TASK_NON

REQUEST_TASK_RUN

REQUEST_TASK_RUN_AND_WAIT

REQUEST_TASK_START

REQUEST_TASK_QUIT

Constructor Detail

MessageTask

MessageTask

MessageTask

Method Detail

init

onInit

onStart

onBeforeStop

onStop

onRelease

onError

processRequest

takeRequest

waitReady

isRunning

isFinished

run

callOnError

obtain

offer

offer

offer

offer

offer

offer

offerFirst

offerAndWait

queueEvent

removeRequest

removeRequest

release

release

releaseSelf

userBreak