org.piax.gtrans.ov.compound

クラス CompoundOverlay<D extends Destination,K extends Key>

java.lang.Object

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

org.piax.gtrans.impl.RequestTransportImpl<D>

org.piax.gtrans.ov.impl.OverlayImpl<D,K>

org.piax.gtrans.ov.compound.CompoundOverlay<D,K>

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

Overlay<D,K>, OverlayListener<D,K>, RequestTransport<D>, Transport<D>, TransportListener<D>

public class CompoundOverlay<D extends Destination,K extends Key>
extends OverlayImpl<D,K>
implements OverlayListener<D,K>

An implementation of compound overlay

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

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	CompoundOverlay.PayloadOption
static class	CompoundOverlay.SpecialKey 複合オーバーレイのgateway機能のためにセットする特殊key

フィールドのサマリー

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

isJoined, keyRegister

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

NON

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

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

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

DEFAULT_APP_ID

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

コンストラクタ

コンストラクタと説明
CompoundOverlay(Peer peer, List<TransportIdPath> overlays)
CompoundOverlay(Peer peer, TransportId transId, List<TransportIdPath> overlays)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	addKey(ObjectId upper, K key) 指定されたkeyをオーバレイに登録する。
void	fin() Finalize the Transport object.
Endpoint	getEndpoint() Returns the local endpoint of the Transport.
List<TransportIdPath>	getSpecifiedOverlays() このCompoundOverlayの生成時に指定されたOverlayを探し出すためのTransportIdPathのリストを返す。
boolean	join(Collection<? extends Endpoint> seeds) 引数で指定されたseedのリストをseedピアとして、Overlayをjoinする。
boolean	leave() Overlayを不活性化（leave）する。
void	onReceive(Overlay<D,K> ov, OverlayReceivedMessage<K> msg)
void	onReceive(RequestTransport<D> trans, ReceivedMessage rmsg)
void	onReceive(Transport<D> trans, ReceivedMessage rmsg) Transportオブジェクトがメッセージを受信した際に呼び出されるメソッド。
FutureQueue<?>	onReceiveRequest(Overlay<D,K> trans, OverlayReceivedMessage<K> rmsg)
FutureQueue<?>	onReceiveRequest(RequestTransport<D> trans, ReceivedMessage rmsg)
boolean	removeKey(ObjectId upper, K key) 指定されたkeyをオーバレイから登録削除する。
FutureQueue<?>	request(ObjectId sender, ObjectId receiver, D dst, Object msg, TransOptions opts) Send a request message.
FutureQueue<?>	request0(ObjectId sender, ObjectId receiver, List<TransportIdPath> nextOvs, D dst, Object msg, TransOptions opts)
void	send(ObjectId sender, ObjectId receiver, D dst, Object msg) Send a message from a local object to a remote object.
void	setGateway(boolean isOn) 複合オーバーレイのgateway機能をセットする。

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

addKey, getAvailableKeyType, getKeys, getKeys, getListener, isJoined, join, lowerAddKey, lowerRemoveKey, registerKey, removeKey, request, request, request, request, request, request, request, request, request, request, selectOnReceive, send, send, send, send, setListener, singletonFutureQueue, singletonFutureQueue, toString0, unregisterKey

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

checkAndClearIsEasySend, getListener0, request, request, request, request, request, request, request, request, request, request, selectOnReceive, send

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

checkActive, getBaseTransport, getDefaultAppId, getListener, getLowerTransport, getLowerTransports, getMTU, getPeer, getPeerId, getTransportId, getTransportIdPath, getUppers, hasStableLocator, isUp, 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.RequestTransport

request, request, request, request, request, request, request, request, request, request

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

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

コンストラクタの詳細

CompoundOverlay

public CompoundOverlay(Peer peer,
                       List<TransportIdPath> overlays)
                throws IdConflictException,
                       IOException

例外:

IdConflictException

IOException

CompoundOverlay

public CompoundOverlay(Peer peer,
                       TransportId transId,
                       List<TransportIdPath> overlays)
                throws IdConflictException,
                       IOException

例外:

IdConflictException

IOException

メソッドの詳細

fin

public void fin()

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

Finalize the Transport object. If the Transport object is already finalized, nothing happens. Normally, this method is not called by toplevel application. (Called by Peer#fin in turn.)

定義:

fin インタフェース内 Transport<D extends Destination>

オーバーライド:

fin クラス内 TransportImpl<D extends Destination>

getSpecifiedOverlays

public List<TransportIdPath> getSpecifiedOverlays()

このCompoundOverlayの生成時に指定されたOverlayを探し出すためのTransportIdPathのリストを返す。

戻り値:

Overlayを探し出すためのTransportIdPathのリスト

getEndpoint

public Endpoint getEndpoint()

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

Returns the local endpoint of the Transport. If the Transport is BaseTransport (or the successor of the BaseTransport), PeerLocator is returned. The transports that are defined as upper layers return PeerId.

定義:

getEndpoint インタフェース内 Transport<D extends Destination>

戻り値:

The Endpoint which the Transport treats.

setGateway

public void setGateway(boolean isOn)

複合オーバーレイのgateway機能をセットする。

パラメータ:

isOn - gateway機能をonする場合はtrue

addKey

public boolean addKey(ObjectId upper,
                      K key)
               throws IOException

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

指定されたkeyをオーバレイに登録する。

同一key が複数回登録される場合は、 key がすでにオーバレイに登録されていても、false は返らない。

null を key として登録することはできない。 引数に nullを指定した場合は、IllegalArgumentException が発生する。 引数が、実装クラスにとって適切な型でない場合は、 ClassCastException が発生する。 また、実装クラスがこのメソッドをサポートしない場合は、 UnsupportedOperationException が発生する。 実装クラス特有の例外が発生した場合は、IOExceptionのサブクラスとなる例外が発生する。

定義:

addKey インタフェース内 Overlay<D extends Destination,K extends Key>

オーバーライド:

addKey クラス内 OverlayImpl<D extends Destination,K extends Key>

パラメータ:

upper - このオーバーレイを利用するエンティティのObjectId

key - オーバレイに登録するkey

戻り値:

登録に成功した場合 true

例外:

IOException - 実装クラス特有の例外が発生した場合

removeKey

public boolean removeKey(ObjectId upper,
                         K key)
                  throws IOException

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

指定されたkeyをオーバレイから登録削除する。

key がオーバレイに登録されていない場合は、falseが返る。 同一key が複数回登録される場合は、 addKey された回数と同じ回数だけremoveKeyが呼ばれないとkeyは削除されない。

null を key として指定することはできない。 引数に nullを指定した場合は、IllegalArgumentException が発生する。 引数が、実装クラスにとって適切な型でない場合は、 ClassCastException が発生する。 また、実装クラスがこのメソッドをサポートしない場合は、 UnsupportedOperationException が発生する。 実装クラス特有の例外が発生した場合は、IOExceptionのサブクラスとなる例外が発生する。

定義:

removeKey インタフェース内 Overlay<D extends Destination,K extends Key>

オーバーライド:

removeKey クラス内 OverlayImpl<D extends Destination,K extends Key>

パラメータ:

upper - このオーバーレイを利用するエンティティのObjectId

key - オーバレイから登録削除するkey

戻り値:

登録削除に成功した場合 true

例外:

IOException - 実装クラス特有の例外が発生した場合

send

public void send(ObjectId sender,
                 ObjectId receiver,
                 D 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<D extends Destination>

オーバーライド:

send クラス内 RequestTransportImpl<D extends Destination>

パラメータ:

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.

request

public FutureQueue<?> request(ObjectId sender,
                              ObjectId receiver,
                              D dst,
                              Object msg,
                              TransOptions opts)
                       throws ProtocolUnsupportedException,
                              IOException

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

Send a request message. FutureQueue object is returned to access arrived responses.

定義:

request インタフェース内 RequestTransport<D extends Destination>

パラメータ:

sender - the object ID of the sender.

receiver - the object ID of the receiver.

dst - the destination.

msg - the request message.

opts - the options.

戻り値:

the future queue to access responses.

例外:

ProtocolUnsupportedException - thrown when the protocol is not supported.

IOException - thrown when an I/O error occurs.

request0

public FutureQueue<?> request0(ObjectId sender,
                               ObjectId receiver,
                               List<TransportIdPath> nextOvs,
                               D dst,
                               Object msg,
                               TransOptions opts)
                        throws ProtocolUnsupportedException,
                               IOException

例外:

ProtocolUnsupportedException

IOException

onReceive

public void onReceive(Overlay<D,K> ov,
                      OverlayReceivedMessage<K> msg)

定義:

onReceive インタフェース内 OverlayListener<D extends Destination,K extends Key>

onReceiveRequest

public FutureQueue<?> onReceiveRequest(Overlay<D,K> trans,
                                       OverlayReceivedMessage<K> rmsg)

定義:

onReceiveRequest インタフェース内 OverlayListener<D extends Destination,K extends Key>

join

public boolean join(Collection<? extends Endpoint> seeds)
             throws IOException

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

引数で指定されたseedのリストをseedピアとして、Overlayをjoinする。

Overlayがすでにjoinな状態の場合は、joinは実行されずに、falseが返る。

定義:

join インタフェース内 Overlay<D extends Destination,K extends Key>

定義:

join クラス内 OverlayImpl<D extends Destination,K extends Key>

パラメータ:

seeds - seedピアのリスト

戻り値:

すでにjoinされていた場合false

例外:

IOException - join時に例外が発生した時

leave

public boolean leave()
              throws IOException

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

Overlayを不活性化（leave）する。 不活性化により、自ピアはオーバレイネットワークから離脱する。

定義:

leave インタフェース内 Overlay<D extends Destination,K extends Key>

定義:

leave クラス内 OverlayImpl<D extends Destination,K extends Key>

戻り値:

すでにleaveされていた場合false

例外:

IOException - I/Oエラーが発生した場合

onReceive

public void onReceive(Transport<D> trans,
                      ReceivedMessage rmsg)

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

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

定義:

onReceive インタフェース内 OverlayListener<D extends Destination,K extends Key>

定義:

onReceive インタフェース内 TransportListener<D extends Destination>

パラメータ:

trans - Transportオブジェクト

rmsg - ReceivedMessageオブジェクト

onReceive

public void onReceive(RequestTransport<D> trans,
                      ReceivedMessage rmsg)

onReceiveRequest

public FutureQueue<?> onReceiveRequest(RequestTransport<D> trans,
                                       ReceivedMessage rmsg)