NettyChannel (PIAX GTrans 3.2-SNAPSHOT API)

java.lang.Object
- org.piax.gtrans.netty.NettyChannel

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

public class NettyChannel
extends Object
implements Channel<NettyLocator>

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

コンストラクタ
コンストラクタと説明
`NettyChannel(int channelNo, NettyLocator channelInitiator, NettyLocator destination, ObjectId localObjectId, ObjectId remoteObjectId, boolean isCreator, NettyRawChannel raw, NettyChannelTransport trans)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`close()` Channelをcloseする。
`NettyLocator`	`getChannelInitiator()`
`int`	`getChannelNo()` このChannelが内部的に持つ番号を返す。
`NettyLocator`	`getLocal()` このChannelのローカル側のEndpointを返す。
`ObjectId`	`getLocalObjectId()` このChannelのローカル側に位置するエンティティのobject IDを返す。
`NettyLocator`	`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)`
`Object`	`receive()` Channelから直ちにメッセージを受信する。
`Object`	`receive(int timeout)` Channelからメッセージを受信する。
`void`	`send(Object msg)` Channelにmsgにより指定されたメッセージを送信する。
`String`	`toString()`

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

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

クラス NettyChannel

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

メソッドのサマリー

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

コンストラクタの詳細

NettyChannel

メソッドの詳細

close

isClosed

getTransportId

getChannelNo

getLocal

getLocalObjectId

getRemote

getRemoteObjectId

isDuplex

isCreatorSide

getChannelInitiator

send

putReceiveQueue

receive

receive

toString