ChannelImpl (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.gtrans.impl.ChannelImpl<E>

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

Channel<E>

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

DatagramBasedTransport.DatagramChannel, OneToOneMappingTransport.OneToOneChannel
```
public abstract class ChannelImpl<E extends Endpoint>
extends Object
implements Channel<E>
```
Channelオブジェクトを実装するための部品として使用するabstractクラス

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected PeerId`	`creator`
`protected boolean`	`isDuplex`
`protected ObjectId`	`localObjectId`
`protected ChannelTransport<E>`	`mother`
`protected E`	`remote`
`protected ObjectId`	`remoteObjectId`

メソッドのサマリー

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

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

インタフェースから継承されたメソッド org.piax.gtrans.Channel
send

- フィールドの詳細
  - creator
```
protected final PeerId creator
```
  - mother
```
protected final ChannelTransport<E extends Endpoint> mother
```
  - localObjectId
```
protected final ObjectId localObjectId
```
  - remoteObjectId
```
protected final ObjectId remoteObjectId
```
  - remote
```
protected final E extends Endpoint remote
```
  - isDuplex
```
protected final boolean isDuplex
```
- メソッドの詳細
  - close
```
public void close()
```
    インタフェースからコピーされた説明: Channel
    
    Channelをcloseする。なお、closeメソッドは多重に呼ばれても問題は起こらない。
    
    定義:
    
    close インタフェース内 Channel<E extends Endpoint>
  - isClosed
```
public boolean isClosed()
```
    定義:
    
    isClosed インタフェース内 Channel<E extends Endpoint>
  - checkActive
```
protected void checkActive()
                    throws IllegalStateException
```
    Channelオブジェクトがアクティブな状態であるかどうかをチェックする。 close() が呼ばれてインアクティブな状態である場合は、IllegalStateExceptionがthrowされる。サブクラスの場合も含め、close() の後に呼び出されては困る場合のメソッド呼び出しの際のチェックに用いる。
    
    例外:
    
    IllegalStateException - Channelオブジェクトがインアクティブな状態である場合
  - getTransportId
```
public TransportId getTransportId()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelオブジェクトを所有するTransportオブジェクトのtransport IDを返す。
    
    定義:
    
    getTransportId インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    このChannelオブジェクトを所有するTransportオブジェクトのtransport ID
  - getChannelNo
```
public int getChannelNo()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelが内部的に持つ番号を返す。
    
    定義:
    
    getChannelNo インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    このChannelが内部的に持つ番号
  - getLocal
```
public E getLocal()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelのローカル側のEndpointを返す。
    
    定義:
    
    getLocal インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    ローカル側のEndpoint
  - getLocalObjectId
```
public ObjectId getLocalObjectId()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelのローカル側に位置するエンティティのobject IDを返す。
    
    定義:
    
    getLocalObjectId インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    ローカル側の端点に位置するエンティティのobject ID
  - getRemote
```
public E getRemote()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelのリモート側のEndpointを返す。
    
    定義:
    
    getRemote インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    リモート側のEndpoint
  - getRemoteObjectId
```
public ObjectId getRemoteObjectId()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelのリモート側に位置するエンティティのobject IDを返す。
    
    定義:
    
    getRemoteObjectId インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    リモート側の端点に位置するエンティティのobject ID
  - isDuplex
```
public boolean isDuplex()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelが双方向通信可能かどうかを判定する。双方向通信可能な場合はtrueが返される。
    
    定義:
    
    isDuplex インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    このChannelが双方向通信可能な場合はtrue、それ以外はfalse
  - isCreatorSide
```
public boolean isCreatorSide()
```
    インタフェースからコピーされた説明: Channel
    
    このChannelオブジェクトを持つTransportオブジェクトによってChannelが生成されたかどうかを判定する。こちら側のTransportオブジェクトによってChannelが生成された場合はtrueが返される。
    
    定義:
    
    isCreatorSide インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    こちら側のTransportオブジェクトによってChannelが生成された場合はtrue、それ以外はfalse
  - putReceiveQueue
```
protected void putReceiveQueue(Object msg)
```
    rcvQueueに受信メッセージをputする。このメソッドは、motherとなるTransportの受信部分からディスパッチされて呼び出される。
    
    パラメータ:
    
    msg - 受信メッセージ
  - receive
```
public Object receive()
```
    インタフェースからコピーされた説明: Channel
    
    Channelから直ちにメッセージを受信する。 Channelがメッセージを受信していない場合は、nullが返される。
    
    定義:
    
    receive インタフェース内 Channel<E extends Endpoint>
    
    戻り値:
    
    受信メッセージ、受信していない場合はnull
  - receive
```
public Object receive(int timeout)
               throws NetworkTimeoutException
```
    インタフェースからコピーされた説明: Channel
    
    Channelからメッセージを受信する。 Channelがメッセージを受信していない場合は、指定されたtimeoutの時間、受信するまでブロックする。 timeoutをすぎた場合はNetworkTimeoutExceptionがthrowされる。
    
    定義:
    
    receive インタフェース内 Channel<E extends Endpoint>
    
    パラメータ:
    
    timeout - 受信のための待機時間（msec）
    
    戻り値:
    
    受信メッセージ
    
    例外:
    
    NetworkTimeoutException - 待機時間が経過した場合
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object

クラス ChannelImpl<E extends Endpoint>

フィールドのサマリー

メソッドのサマリー

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

インタフェースから継承されたメソッド org.piax.gtrans.Channel

フィールドの詳細

creator

mother

localObjectId

remoteObjectId

remote

isDuplex

メソッドの詳細

close

isClosed

checkActive

getTransportId

getChannelNo

getLocal

getLocalObjectId

getRemote

getRemoteObjectId

isDuplex

isCreatorSide

putReceiveQueue

receive

receive

toString