org.piax.gtrans.impl

クラス DatagramBasedTransport<U extends Endpoint,L extends Endpoint>

java.lang.Object

org.piax.gtrans.impl.TransportImpl<E>

org.piax.gtrans.impl.ChannelTransportImpl<U>

org.piax.gtrans.impl.DatagramBasedTransport<U,L>

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

ChannelListener<L>, ChannelTransport<U>, Transport<U>, TransportListener<L>

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

BaseDatagramTransport, ChannelAddOnTransport, HandoverTransport

public abstract class DatagramBasedTransport<U extends Endpoint,L extends Endpoint>
extends ChannelTransportImpl<U>
implements TransportListener<L>, ChannelListener<L>

Channel通信機能を提供しない下位のTransportまたはRawTransportを使って、 通常のChannelを使ったTransportの機能を作るためのテンプレートクラス

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
protected static class	DatagramBasedTransport.DatagramChannel<E extends Endpoint>

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static byte	CH_CLOSE_CMD
static byte	CH_NEW_ACK_CMD
static byte	CH_NEW_CMD
static byte	CH_NEW_NACK_CMD

クラスから継承されたフィールド org.piax.gtrans.impl.ChannelTransportImpl

chListenersByUpper, supportsDuplex

クラスから継承されたフィールド org.piax.gtrans.impl.TransportImpl

defaultAppId, isActive, isBaseTransport, listenersByUpper, lowerTrans, peer, peerId, transId, transIdPath, uppers

インタフェースから継承されたフィールド org.piax.gtrans.Transport

DEFAULT_APP_ID

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

コンストラクタ

修飾子	コンストラクタと説明
protected	DatagramBasedTransport(Peer peer, TransportId transId, Transport<?> lowerTrans, boolean supportsDuplex)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	_onReceive(ReceivedMessage rmsg)
protected abstract NestedMessage	_preReceive(ReceivedMessage rmsg) サブクラスで受信時のロジックを埋めるための用いるメソッド。
protected void	_send(ObjectId sender, ObjectId receiver, int channelNo, U dst, Object msg)
protected void	closeCh(boolean isDirect, ChannelImpl<U> ch) channelのclose処理を行う。
protected DatagramBasedTransport.DatagramChannel<U>	getAcceptCh(PeerId creator, int channelNo)
protected DatagramBasedTransport.DatagramChannel<U>	getClientCh(int channelNo)
protected abstract void	lowerSend(U dst, NestedMessage nmsg) サブクラスで下位層の送信処理を実装するために用いるメソッド。
protected DatagramBasedTransport.DatagramChannel<U>	newAcceptChIfAbsent(PeerId creator, ObjectId localObjId, ObjectId remoteObjId, int channelNo, U dst)
Channel<U>	newChannel(ObjectId sender, ObjectId receiver, U dst, boolean isDuplex, int timeout) Create a new channel with isDuplex and timeout.
boolean	onAccepting(Channel<L> channel) Channelが通信相手によって、生成された際に呼び出されるメソッド。
void	onClosed(Channel<L> channel) Channelが通信相手によって、closeされた際に呼び出されるメソッド。
void	onFailure(Channel<L> channel, Exception cause) Channelが予期せぬ例外によって、切断された際に呼び出されるメソッド。
void	onReceive(Channel<L> lowerCh) Channelがメッセージを受信した際に呼び出されるメソッド。
void	onReceive(Transport<L> lowerTrans, ReceivedMessage rmsg) Transportオブジェクトがメッセージを受信した際に呼び出されるメソッド。
protected void	raiseUpperListener(NestedMessage nmsg)
void	send(ObjectId sender, ObjectId receiver, U dst, Object msg) Send a message from a local object to a remote object.
protected abstract boolean	useReceiverThread(int numProc) ここでの受信処理をスレッドを使って並行化させるかどうかを判断する。

クラスから継承されたメソッド org.piax.gtrans.impl.ChannelTransportImpl

fin, getChannelListener, getChannelListener, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, newChannel, setChannelListener, setChannelListener, supportsDuplex, toString0

クラスから継承されたメソッド org.piax.gtrans.impl.TransportImpl

checkActive, getBaseTransport, getDefaultAppId, getListener, getListener, getLowerTransport, getLowerTransports, getMTU, getPeer, getPeerId, getTransportId, getTransportIdPath, getUppers, hasStableLocator, isUp, send, send, send, send, send, send, send, setBaseTransport, setDefaultAppId, setListener, setListener, toString

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getEndpoint

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

getBaseTransport, getListener, getListener, getLowerTransport, getLowerTransports, getMTU, getPeer, getPeerId, getTransportId, getTransportIdPath, hasStableLocator, isUp, send, send, send, send, send, send, send, setListener, setListener

フィールドの詳細

CH_NEW_CMD

public static final byte CH_NEW_CMD

関連項目:

定数フィールド値

CH_NEW_ACK_CMD

public static final byte CH_NEW_ACK_CMD

関連項目:

定数フィールド値

CH_NEW_NACK_CMD

public static final byte CH_NEW_NACK_CMD

関連項目:

定数フィールド値

CH_CLOSE_CMD

public static final byte CH_CLOSE_CMD

関連項目:

定数フィールド値

コンストラクタの詳細

DatagramBasedTransport

protected DatagramBasedTransport(Peer peer,
                                 TransportId transId,
                                 Transport<?> lowerTrans,
                                 boolean supportsDuplex)
                          throws IdConflictException

例外:

IdConflictException

メソッドの詳細

newChannel

public Channel<U> newChannel(ObjectId sender,
                             ObjectId receiver,
                             U dst,
                             boolean isDuplex,
                             int timeout)
                      throws ProtocolUnsupportedException,
                             IOException

インタフェースからコピーされた説明: ChannelTransport

Create a new channel with isDuplex and timeout.

定義:

newChannel インタフェース内 ChannelTransport<U extends Endpoint>

定義:

newChannel クラス内 ChannelTransportImpl<U extends Endpoint>

パラメータ:

sender - object ID of the sender.

receiver - object ID of the receiver.

dst - the endpoint of the destination to create channel.

isDuplex - whether the connection is duplex or not.

timeout - the timeout length.

戻り値:

a new instance of channel.

例外:

ProtocolUnsupportedException - an exception thrown when the protocol is not supported.

IOException - an exception when thrown when an I/O error occurred.

getClientCh

protected DatagramBasedTransport.DatagramChannel<U> getClientCh(int channelNo)

getAcceptCh

protected DatagramBasedTransport.DatagramChannel<U> getAcceptCh(PeerId creator,
                                                                int channelNo)

newAcceptChIfAbsent

protected DatagramBasedTransport.DatagramChannel<U> newAcceptChIfAbsent(PeerId creator,
                                                                        ObjectId localObjId,
                                                                        ObjectId remoteObjId,
                                                                        int channelNo,
                                                                        U dst)

closeCh

protected void closeCh(boolean isDirect,
                       ChannelImpl<U> ch)

channelのclose処理を行う。 こちら側のtransportがchannelのcloseを指示した場合は、isDirectをtrueにする。 相手側のtransportがchannelのcloseを行った場合（制御メッセージが送られる）はfalseにする。

パラメータ:

isDirect - こちら側のtransportがchannelのcloseを指示した場合はtrue、 それ以外はfalseをセットする。

ch - channelオブジェクト

lowerSend

protected abstract void lowerSend(U dst,
                                  NestedMessage nmsg)
                           throws ProtocolUnsupportedException,
                                  IOException

サブクラスで下位層の送信処理を実装するために用いるメソッド。

パラメータ:

dst - 送信先

nmsg - NestedMessage

例外:

ProtocolUnsupportedException - プロトコルミスマッチ等の例外が出た場合

IOException - I/O関係の例外が出た場合

_send

protected void _send(ObjectId sender,
                     ObjectId receiver,
                     int channelNo,
                     U dst,
                     Object msg)
              throws ProtocolUnsupportedException,
                     IOException

例外:

ProtocolUnsupportedException

IOException

send

public void send(ObjectId sender,
                 ObjectId receiver,
                 U dst,
                 Object msg)
          throws ProtocolUnsupportedException,
                 IOException

インタフェースからコピーされた説明: Transport

Send a message from a local object to a remote object. The message is delivered to a object with ObjectId receiver on the peer with destination dst. This type of send is used when the sender and the receiver have different ObjectId, which means upper layer exchanges the message using Transport.

定義:

send インタフェース内 Transport<U extends Endpoint>

パラメータ:

sender - The ObjectId of the sender.

receiver - The ObjectId of the receiver.

dst - The Destination of the peer.

msg - The message itself.

例外:

ProtocolUnsupportedException - Raises if the 'dst' peer does not handle the protocol.

IOException - Raises if I/O-related exceptions occured.

_preReceive

protected abstract NestedMessage _preReceive(ReceivedMessage rmsg)

サブクラスで受信時のロジックを埋めるための用いるメソッド。

パラメータ:

rmsg - ReceivedMessage

戻り値:

以降の処理に渡す NestedMessage、処理をここで止める場合はnullを返す

useReceiverThread

protected abstract boolean useReceiverThread(int numProc)

ここでの受信処理をスレッドを使って並行化させるかどうかを判断する。 通常は、処理数が2以上の場合はスレッド化が望ましい。 下位の処理をすぐにreturnさせたい場合は、処理数が1の時でもtrueを返すよう実装する。

パラメータ:

numProc - procedureの数

戻り値:

スレッド化する場合true

raiseUpperListener

protected void raiseUpperListener(NestedMessage nmsg)

_onReceive

protected void _onReceive(ReceivedMessage rmsg)

onReceive

public void onReceive(Transport<L> lowerTrans,
                      ReceivedMessage rmsg)

インタフェースからコピーされた説明: TransportListener

Transportオブジェクトがメッセージを受信した際に呼び出されるメソッド。 受信メッセージは、送信元の情報などを付加したReceivedMessageオブジェクトの形で取得される。

定義:

onReceive インタフェース内 TransportListener<L extends Endpoint>

パラメータ:

lowerTrans - Transportオブジェクト

rmsg - ReceivedMessageオブジェクト

onAccepting

public boolean onAccepting(Channel<L> channel)

インタフェースからコピーされた説明: ChannelListener

Channelが通信相手によって、生成された際に呼び出されるメソッド。 通信相手によるChannelの生成を受理する場合はtrue、拒否する場合はfalseを返す。

定義:

onAccepting インタフェース内 ChannelListener<L extends Endpoint>

パラメータ:

channel - Channelオブジェクト

戻り値:

通信相手によるChannelの生成を受理する場合はtrue、拒否する場合はfalse

onClosed

public void onClosed(Channel<L> channel)

インタフェースからコピーされた説明: ChannelListener

Channelが通信相手によって、closeされた際に呼び出されるメソッド。 この時点で、内部処理によって、channelがcloseされているので、close()を呼び出す必要はない。

定義:

onClosed インタフェース内 ChannelListener<L extends Endpoint>

パラメータ:

channel - Channelオブジェクト

onFailure

public void onFailure(Channel<L> channel,
                      Exception cause)

インタフェースからコピーされた説明: ChannelListener

Channelが予期せぬ例外によって、切断された際に呼び出されるメソッド。

定義:

onFailure インタフェース内 ChannelListener<L extends Endpoint>

パラメータ:

channel - Channelオブジェクト

cause - Channelが切断された原因となる例外

onReceive

public void onReceive(Channel<L> lowerCh)

インタフェースからコピーされた説明: ChannelListener

Channelがメッセージを受信した際に呼び出されるメソッド。 受信メッセージは、channelのreceiveメソッドを呼び出すことにより取得される。

定義:

onReceive インタフェース内 ChannelListener<L extends Endpoint>

パラメータ:

lowerCh - Channelオブジェクト