org.piax.gtrans.ov.combined

クラス CombinedOverlay

java.lang.Object

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

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

org.piax.gtrans.ov.impl.OverlayImpl<Destination,Key>

org.piax.gtrans.ov.combined.CombinedOverlay

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

Overlay<Destination,Key>, OverlayListener<Destination,Key>, RequestTransport<Destination>, Transport<Destination>, TransportListener<Destination>

public class CombinedOverlay
extends OverlayImpl<Destination,Key>
implements OverlayListener<Destination,Key>

An implementation of combined overlay

フィールドのサマリー

フィールド

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

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

isJoined, keyRegister

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

NON

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

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

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

DEFAULT_APP_ID

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

コンストラクタ

コンストラクタと説明
CombinedOverlay(Peer peer, TransportId transId)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	addKey(ObjectId upper, Key key) 指定されたkeyをオーバレイに登録する。
void	bindOverlay(String attribName, TransportIdPath suffix) 指定されたattribNameを持つAttributeに、 指定されたTransportIdPathをsuffixとして持ち、型の互換性のあるOverlayをbindさせる。
void	declareAttrib(String attribName)
void	declareAttrib(String attribName, Class<?> type)
void	fin() Finalize the Transport object.
Overlay<?,?>	getBindOverlay(String attribName)
List<String>	getDeclaredAttribNames()
Endpoint	getEndpoint() Returns the local endpoint of the Transport.
Set<Key>	getKeys()
RowData	getRow(Id rowId) 指定されたrowIdを持つRowDataを取得する。
List<RowData>	getRows()
void	insertRow(RowData row) RowDataを挿入する。
boolean	isJoined() overlayの状態（join/leave）を返す。
boolean	join(Collection<? extends Endpoint> seeds) 引数で指定されたseedのリストをseedピアとして、Overlayをjoinする。
boolean	leave() Overlayを不活性化（leave）する。
RowData	newRow(Id rowId) 指定されたrowIdを持つRowDataを新たに生成する。
void	onReceive(Overlay<Destination,Key> trans, OverlayReceivedMessage<Key> rmsg)
void	onReceive(RequestTransport<Destination> trans, ReceivedMessage rmsg)
void	onReceive(Transport<Destination> trans, ReceivedMessage rmsg) Transportオブジェクトがメッセージを受信した際に呼び出されるメソッド。
FutureQueue<?>	onReceiveRequest(Overlay<Destination,Key> trans, OverlayReceivedMessage<Key> rmsg)
FutureQueue<?>	onReceiveRequest(RequestTransport<Destination> trans, ReceivedMessage rmsg)
boolean	removeKey(ObjectId upper, Key key) 指定されたkeyをオーバレイから登録削除する。
RowData	removeRow(Id rowId)
FutureQueue<?>	request(ObjectId sender, ObjectId receiver, Destination dst, Object msg, TransOptions opts) Send a request message.
FutureQueue<?>	request(ObjectId sender, ObjectId receiver, String dstExp, Object msg, int timeout)
FutureQueue<?>	request(ObjectId sender, ObjectId receiver, String dstExp, Object msg, TransOptions opts)
void	send(ObjectId sender, ObjectId receiver, String dstExp, Object msg)
RowData	setSuperRow(Id rowId) 指定されたrowIdを持つRowDataをsuperRowとしてセットする。
void	unbindOverlay(String attribName)

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

addKey, getAvailableKeyType, getKeys, getListener, join, lowerAddKey, lowerRemoveKey, registerKey, removeKey, request, request, request, request, request, request, request, request, selectOnReceive, 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, 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, send, setListener, setListener

フィールドの詳細

table

public final AttributeTable table

コンストラクタの詳細

CombinedOverlay

public CombinedOverlay(Peer peer,
                       TransportId transId)
                throws IdConflictException

例外:

IdConflictException

メソッドの詳細

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<Destination>

オーバーライド:

fin クラス内 TransportImpl<Destination>

send

public void send(ObjectId sender,
                 ObjectId receiver,
                 String dstExp,
                 Object msg)
          throws org.piax.common.dcl.parser.ParseException,
                 ProtocolUnsupportedException,
                 IOException

定義:

send インタフェース内 Overlay<Destination,Key>

オーバーライド:

send クラス内 OverlayImpl<Destination,Key>

例外:

org.piax.common.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

public FutureQueue<?> request(ObjectId sender,
                              ObjectId receiver,
                              String dstExp,
                              Object msg,
                              TransOptions opts)
                       throws org.piax.common.dcl.parser.ParseException,
                              ProtocolUnsupportedException,
                              IOException

定義:

request インタフェース内 Overlay<Destination,Key>

オーバーライド:

request クラス内 OverlayImpl<Destination,Key>

例外:

org.piax.common.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

public FutureQueue<?> request(ObjectId sender,
                              ObjectId receiver,
                              String dstExp,
                              Object msg,
                              int timeout)
                       throws org.piax.common.dcl.parser.ParseException,
                              ProtocolUnsupportedException,
                              IOException

定義:

request インタフェース内 Overlay<Destination,Key>

オーバーライド:

request クラス内 OverlayImpl<Destination,Key>

例外:

org.piax.common.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

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

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

定義:

request インタフェース内 RequestTransport<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.

onReceive

public void onReceive(Overlay<Destination,Key> trans,
                      OverlayReceivedMessage<Key> rmsg)

定義:

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

onReceiveRequest

public FutureQueue<?> onReceiveRequest(Overlay<Destination,Key> trans,
                                       OverlayReceivedMessage<Key> rmsg)

定義:

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

declareAttrib

public void declareAttrib(String attribName)
                   throws IllegalStateException

例外:

IllegalStateException

declareAttrib

public void declareAttrib(String attribName,
                          Class<?> type)
                   throws IllegalStateException

例外:

IllegalStateException

getDeclaredAttribNames

public List<String> getDeclaredAttribNames()

bindOverlay

public void bindOverlay(String attribName,
                        TransportIdPath suffix)
                 throws IllegalArgumentException,
                        NoSuchOverlayException,
                        IncompatibleTypeException

指定されたattribNameを持つAttributeに、 指定されたTransportIdPathをsuffixとして持ち、型の互換性のあるOverlayをbindさせる。

パラメータ:

attribName - attribName

suffix - suffixとして指定されたTransportIdPath

例外:

IllegalArgumentException - 該当するAttributeが存在しない場合

NoSuchOverlayException - 該当するOverlayが存在しない場合

IncompatibleTypeException - 型の互換性が原因で候補が得られない場合

unbindOverlay

public void unbindOverlay(String attribName)
                   throws IllegalArgumentException,
                          IllegalStateException

例外:

IllegalArgumentException

IllegalStateException

getBindOverlay

public Overlay<?,?> getBindOverlay(String attribName)
                            throws IllegalArgumentException

例外:

IllegalArgumentException

setSuperRow

public RowData setSuperRow(Id rowId)
                    throws IdConflictException

指定されたrowIdを持つRowDataをsuperRowとしてセットする。 すでにRowDataが存在する場合はIdConflictExceptionがthrowされる。

パラメータ:

rowId - rowId

戻り値:

superRow

例外:

IdConflictException - すでにsuperRowが存在する場合

newRow

public RowData newRow(Id rowId)
               throws IdConflictException

指定されたrowIdを持つRowDataを新たに生成する。 すでにRowDataが存在する場合はIdConflictExceptionがthrowされる。

パラメータ:

rowId - rowId

戻り値:

rowIdを持つRowData

例外:

IdConflictException - すでにRowDataが存在する場合

insertRow

public void insertRow(RowData row)
               throws IllegalStateException,
                      IdConflictException

RowDataを挿入する。 すでに同じrowIdを持つRowDataが存在する場合はIdConflictExceptionがthrowされる。

この挿入によって起こりうる不整合に注意する必要がある。 属性値を別に持つRowDataを新たにtableに挿入することで、属性名との不整合が起こりうる。 このため、Attributeに対してunboundなRowDataでないと挿入は許されない。

パラメータ:

row - RowData

例外:

IllegalStateException - RowDataがAttributeに対してunboundでない場合

IdConflictException - すでに同じrowIdを持つRowDataが存在する場合

removeRow

public RowData removeRow(Id rowId)

getRow

public RowData getRow(Id rowId)

指定されたrowIdを持つRowDataを取得する。 RowDataが存在しない場合はnullが返される。

パラメータ:

rowId - rowId

戻り値:

rowIdを持つRowData

getRows

public List<RowData> getRows()

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<Destination>

戻り値:

The Endpoint which the Transport treats.

join

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

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

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

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

定義:

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

定義:

join クラス内 OverlayImpl<Destination,Key>

パラメータ:

seeds - seedピアのリスト

戻り値:

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

例外:

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

leave

public boolean leave()
              throws IOException

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

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

定義:

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

定義:

leave クラス内 OverlayImpl<Destination,Key>

戻り値:

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

例外:

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

isJoined

public boolean isJoined()

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

overlayの状態（join/leave）を返す。

定義:

isJoined インタフェース内 Overlay<Destination,Key>

オーバーライド:

isJoined クラス内 OverlayImpl<Destination,Key>

戻り値:

overlayの状態。joinedの場合はtrue

addKey

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

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

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

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

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

定義:

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

オーバーライド:

addKey クラス内 OverlayImpl<Destination,Key>

パラメータ:

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

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

戻り値:

登録に成功した場合 true

例外:

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

removeKey

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

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

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

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

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

定義:

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

オーバーライド:

removeKey クラス内 OverlayImpl<Destination,Key>

パラメータ:

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

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

戻り値:

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

例外:

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

getKeys

public Set<Key> getKeys()

定義:

getKeys インタフェース内 Overlay<Destination,Key>

オーバーライド:

getKeys クラス内 OverlayImpl<Destination,Key>

onReceive

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

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

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

定義:

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

定義:

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

パラメータ:

trans - Transportオブジェクト

rmsg - ReceivedMessageオブジェクト

onReceive

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

onReceiveRequest

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