SocketManager (Java client library for Okuyama KVS 1.1.3 API)

java.lang.Object
- mitonize.datastore.SocketManager

public class SocketManager
extends Object

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected AtomicInteger`	`activeSocketCount`
`protected AtomicInteger`	`currentEndpointIndex`
`protected ArrayBlockingQueue<SocketStreams>`	`queue` オープンしているソケット、入出力ストリームをプールするためのキュー。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

SocketManager(String[] masternodes, int maxPoolSize)

コンストラクタ
コンストラクタと説明
`SocketManager(String[] masternodes, int maxPoolSize)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods Deprecated Methods
修飾子とタイプ	メソッドと説明
`SocketStreams`	`aquire()` プールしているソケットを取り出して返却する。
`void`	`destroy(SocketStreams streams)`
`int`	`getDelayToMarkOnlineInMillis()` オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)を取得
`int`	`getMaxCoucurrentSockets()`
`int`	`getMaxPoolSize()`
`int`	`getTimeoutToConnectInMillis()` TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)を取得する。
`int`	`getTimeoutToReadInMillis()` ソケットの読み取りタイムアウト時間(ミリ秒)を取得する。
`boolean`	`isDumpStream()`
`void`	`recycle(SocketStreams socket)` プールから取り出されたソケットを返却する。
`void`	`setDelayToMarkOnlineInMillis(int delayToMarkOnlineInMillis)` オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)を設定する(デフォルト:3000ミリ秒)。
`void`	`setDumpFilterStreamFactory(DumpFilterStreamFactory dumpFilterStreamFactory)`
`void`	`setDumpStream(boolean b)` 非推奨です。
`void`	`setSocketTimeToLiveInMilli(long socketTimeToLiveInMilli)` 新規に作成されてから設定値の期間経過したソケットは、そのソケットがプールから選択されるタイミングで削除され、利用されなくなります。
`void`	`setTimeoutToConnectInMillis(int timeoutToConnectInMillis)` TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)を設定する(デフォルト:1000ミリ秒)。
`void`	`setTimeoutToReadInMillis(int timeoutToReadInMillis)` ソケットの読み取りタイムアウト時間(ミリ秒)を設定する(デフォルト:1000ミリ秒)
`void`	`shutdown()`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - queue
```
protected final ArrayBlockingQueue<SocketStreams> queue
```
    オープンしているソケット、入出力ストリームをプールするためのキュー。要求された際にキューから取り出し、使用後に返却された時にキューに戻す。
  - activeSocketCount
```
protected final AtomicInteger activeSocketCount
```
  - currentEndpointIndex
```
protected final AtomicInteger currentEndpointIndex
```
- コンストラクタの詳細
  - SocketManager
```
public SocketManager(String[] masternodes,
                     int maxPoolSize)
              throws UnknownHostException
```
    例外:
    
    UnknownHostException
- メソッドの詳細
  - setDumpStream
```
@Deprecated
public void setDumpStream(boolean b)
```
    非推奨です。
  - isDumpStream
```
public boolean isDumpStream()
```
  - aquire
```
public SocketStreams aquire()
                     throws IOException
```
    プールしているソケットを取り出して返却する。取り出した時にそのソケットが有効かをチェックして、無効なら新規にソケットを開く。新規のソケットは登録されているエンドポイントのうちラウンドロビンで選択され、接続に成功したものとなる。
    
    戻り値:
    
    有効な接続先のソケット。
    
    例外:
    
    IOException - 有効な接続先が1つもない場合。
  - recycle
```
public void recycle(SocketStreams socket)
```
    プールから取り出されたソケットを返却する。新規にオープンしたソケットのタイムスタンプを管理して、プールの上限数に達した最後のタイムスタンプよりも新しいソケットはキューに戻されない。タイムスタンプよりも古いソケットが無効だった場合はプール数が減るが、同時接続数が有効なプール数よりも増えた段階で新規に開かれ、タイムスタンプも更新される。
    
    パラメータ:
    
    socket - プールから取り出したソケット
  - destroy
```
public void destroy(SocketStreams streams)
```
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
  - getMaxCoucurrentSockets
```
public int getMaxCoucurrentSockets()
```
  - setDumpFilterStreamFactory
```
public void setDumpFilterStreamFactory(DumpFilterStreamFactory dumpFilterStreamFactory)
```
  - getTimeoutToReadInMillis
```
public int getTimeoutToReadInMillis()
```
    ソケットの読み取りタイムアウト時間(ミリ秒)を取得する。
    
    戻り値:
    
    ソケットの読み取りタイムアウト時間(ミリ秒)
  - setTimeoutToReadInMillis
```
public void setTimeoutToReadInMillis(int timeoutToReadInMillis)
```
    ソケットの読み取りタイムアウト時間(ミリ秒)を設定する(デフォルト:1000ミリ秒)
    
    パラメータ:
    
    timeoutToReadInMillis - ソケットの読み取りタイムアウト時間(ミリ秒)
  - getTimeoutToConnectInMillis
```
public int getTimeoutToConnectInMillis()
```
    TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)を取得する。
    
    戻り値:
    
    TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)
  - setTimeoutToConnectInMillis
```
public void setTimeoutToConnectInMillis(int timeoutToConnectInMillis)
```
    TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)を設定する(デフォルト:1000ミリ秒)。
    
    パラメータ:
    
    timeoutToConnectInMillis - TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)
  - getDelayToMarkOnlineInMillis
```
public int getDelayToMarkOnlineInMillis()
```
    オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)を取得
    
    戻り値:
    
    オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)
  - setDelayToMarkOnlineInMillis
```
public void setDelayToMarkOnlineInMillis(int delayToMarkOnlineInMillis)
```
    オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)を設定する(デフォルト:3000ミリ秒)。 TCPポートが開いてから実際に待ち受け可能になるまで時間がかかるサーバの場合に指定する。不要な場合は0でよい。
    
    パラメータ:
    
    delayToMarkOnlineInMillis - オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)
  - setSocketTimeToLiveInMilli
```
public void setSocketTimeToLiveInMilli(long socketTimeToLiveInMilli)
```
    新規に作成されてから設定値の期間経過したソケットは、そのソケットがプールから選択されるタイミングで削除され、利用されなくなります。
    
    パラメータ:
    
    socketTimeToLiveInMilli - ソケットの生存期間[ミリ秒]（デフォルトは5分）
  - shutdown
```
public void shutdown()
```

クラス SocketManager

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

queue

activeSocketCount

currentEndpointIndex

コンストラクタの詳細

SocketManager

メソッドの詳細

setDumpStream

isDumpStream

aquire

recycle

destroy

getMaxPoolSize

getMaxCoucurrentSockets

setDumpFilterStreamFactory

getTimeoutToReadInMillis

setTimeoutToReadInMillis

getTimeoutToConnectInMillis

setTimeoutToConnectInMillis

getDelayToMarkOnlineInMillis

setDelayToMarkOnlineInMillis

setSocketTimeToLiveInMilli

shutdown