RawChannel (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.gtrans.raw.RawChannel<E>

すべての実装されたインタフェース:

Channel<E>

直系の既知のサブクラス:

LWTcpChannel
```
public abstract class RawChannel<E extends PeerLocator>
extends Object
implements Channel<E>
```

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected boolean isActive

フィールド
修飾子とタイプ	フィールドと説明
`protected boolean`	`isActive`

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

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

RawChannel()

コンストラクタ
コンストラクタと説明
`RawChannel()`

メソッドのサマリー

All Methods Instance Methods Abstract Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`close()` RawChannelをcloseする。
`abstract int`	`getChannelNo()` このChannelが内部的に持つ番号を返す。
`E`	`getLocal()` このChannelのローカル側のEndpointを返す。
`ObjectId`	`getLocalObjectId()` このChannelのローカル側に位置するエンティティのobject IDを返す。
`abstract E`	`getRemote()` RawChannelの相手側のPeerLocatorを取得する。
`ObjectId`	`getRemoteObjectId()` このChannelのリモート側に位置するエンティティのobject IDを返す。
`TransportId`	`getTransportId()` このChannelオブジェクトを所有するTransportオブジェクトのtransport IDを返す。
`boolean`	`isClosed()`
`abstract boolean`	`isCreatorSide()` このChannelオブジェクトを持つTransportオブジェクトによってChannelが生成されたかどうかを判定する。
`boolean`	`isDuplex()` このChannelが双方向通信可能かどうかを判定する。
`protected void`	`putReceiveQueue(Object msg)`
`Object`	`receive()` Channelから直ちにメッセージを受信する。
`Object`	`receive(int timeout)` Channelからメッセージを受信する。
`abstract void`	`send(ByteBuffer bbuf)`
`void`	`send(Object msg)` Channelにmsgにより指定されたメッセージを送信する。

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

- フィールドの詳細
  - isActive
```
protected volatile boolean isActive
```
- コンストラクタの詳細
  - RawChannel
```
public RawChannel()
```
- メソッドの詳細
  - close
```
public void close()
```
    RawChannelをcloseする。尚、すでにcloseされたRawChannelを再びcloseしても問題は起こらない。
    
    定義:
    
    close インタフェース内 Channel<E extends PeerLocator>
  - isClosed
```
public boolean isClosed()
```
    定義:
    
    isClosed インタフェース内 Channel<E extends PeerLocator>
  - getChannelNo
```
public abstract int getChannelNo()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelが内部的に持つ番号を返す。
    
    定義:
    
    getChannelNo インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    このChannelが内部的に持つ番号
  - getRemote
```
public abstract E getRemote()
```
    RawChannelの相手側のPeerLocatorを取得する。
    
    定義:
    
    getRemote インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    RawChannelの相手側のPeerLocator
  - isCreatorSide
```
public abstract boolean isCreatorSide()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelオブジェクトを持つTransportオブジェクトによってChannelが生成されたかどうかを判定する。こちら側のTransportオブジェクトによってChannelが生成された場合はtrueが返される。
    
    定義:
    
    isCreatorSide インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    こちら側のTransportオブジェクトによってChannelが生成された場合はtrue、それ以外はfalse
  - send
```
public abstract void send(ByteBuffer bbuf)
                   throws IOException
```
    例外:
    
    IOException
  - send
```
public void send(Object msg)
          throws IOException
```
    インタフェースからコピーされた説明: Channel
    
    Channelにmsgにより指定されたメッセージを送信する。
    
    定義:
    
    send インタフェース内 Channel<E extends PeerLocator>
    
    パラメータ:
    
    msg - 送信メッセージ
    
    例外:
    
    IOException - I/Oエラーが発生した場合
  - putReceiveQueue
```
protected void putReceiveQueue(Object msg)
```
  - receive
```
public Object receive()
```
    インタフェースからコピーされた説明: Channel
    
    Channelから直ちにメッセージを受信する。 Channelがメッセージを受信していない場合は、nullが返される。
    
    定義:
    
    receive インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    受信メッセージ、受信していない場合はnull
  - receive
```
public Object receive(int timeout)
               throws NetworkTimeoutException
```
    インタフェースからコピーされた説明: Channel
    
    Channelからメッセージを受信する。 Channelがメッセージを受信していない場合は、指定されたtimeoutの時間、受信するまでブロックする。 timeoutをすぎた場合はNetworkTimeoutExceptionがthrowされる。
    
    定義:
    
    receive インタフェース内 Channel<E extends PeerLocator>
    
    パラメータ:
    
    timeout - 受信のための待機時間（msec）
    
    戻り値:
    
    受信メッセージ
    
    例外:
    
    NetworkTimeoutException - 待機時間が経過した場合
  - getTransportId
```
public TransportId getTransportId()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelオブジェクトを所有するTransportオブジェクトのtransport IDを返す。
    
    定義:
    
    getTransportId インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    このChannelオブジェクトを所有するTransportオブジェクトのtransport ID
  - getLocal
```
public E getLocal()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelのローカル側のEndpointを返す。
    
    定義:
    
    getLocal インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    ローカル側のEndpoint
  - getLocalObjectId
```
public ObjectId getLocalObjectId()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelのローカル側に位置するエンティティのobject IDを返す。
    
    定義:
    
    getLocalObjectId インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    ローカル側の端点に位置するエンティティのobject ID
  - getRemoteObjectId
```
public ObjectId getRemoteObjectId()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelのリモート側に位置するエンティティのobject IDを返す。
    
    定義:
    
    getRemoteObjectId インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    リモート側の端点に位置するエンティティのobject ID
  - isDuplex
```
public boolean isDuplex()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelが双方向通信可能かどうかを判定する。双方向通信可能な場合はtrueが返される。
    
    定義:
    
    isDuplex インタフェース内 Channel<E extends PeerLocator>
    
    戻り値:
    
    このChannelが双方向通信可能な場合はtrue、それ以外はfalse

クラス RawChannel<E extends PeerLocator>

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

isActive

コンストラクタの詳細

RawChannel

メソッドの詳細

close

isClosed

getChannelNo

getRemote

isCreatorSide

send

send

putReceiveQueue

receive

receive

getTransportId

getLocal

getLocalObjectId

getRemoteObjectId

isDuplex