パッケージ org.piax.gtrans.ov.impl

クラス OverlayImpl<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>

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

Closeable, AutoCloseable, Overlay<D,K>, RequestTransport<D>, Transport<D>

public abstract class OverlayImpl<D extends Destination,K extends Key>
extends RequestTransportImpl<D>
implements Overlay<D,K>

ネストされたクラスの概要

クラスから継承されたネストされたクラス/インタフェース org.piax.gtrans.impl.RequestTransportImpl

RequestTransportImpl.IsEasySend

インタフェースから継承されたネストされたクラス/インタフェース org.piax.gtrans.RequestTransport

RequestTransport.Response

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
protected boolean	isJoined
protected Map<K,Integer>	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.ov.Overlay

DEFAULT_ENDPOINT, DEFAULT_SEED

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

DEFAULT_APP_ID

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
OverlayImpl(Peer peer, TransportId transId, Transport<?> lowerTrans)

メソッドの概要

修飾子とタイプ	メソッド	説明
boolean	addKey(K key)
boolean	addKey(ObjectId upper, K key)	指定されたkeyをオーバレイに登録する。
CompletableFuture<Boolean>	addKeyAsync(K key)
CompletableFuture<Boolean>	addKeyAsync(ObjectId upper, K key)	指定されたkeyをオーバレイに非同期に登録する。
Class<?>	getAvailableKeyType()
Set<K>	getKeys()
Set<K>	getKeys(ObjectId upper)
OverlayListener<D,K>	getListener(ObjectId upper)	Return the registered TransportListener.
boolean	isJoined()	overlayの状態（join/leave）を返す。
boolean	join()
boolean	join(String spec)
abstract boolean	join(Collection<? extends Endpoint> seeds)	引数で指定されたseedのリストをseedピアとして、Overlayをjoinする。
boolean	join(Endpoint seed)
abstract boolean	leave()	Overlayを不活性化（leave）する。
protected void	lowerAddKey(K key)
protected CompletableFuture<Boolean>	lowerAddKeyAsync(K key)
protected void	lowerRemoveKey(K key)
protected CompletableFuture<Boolean>	lowerRemoveKeyAsync(K key)
protected int	numOfRegisteredKey(K key)
protected void	registerKey(K key)
protected void	registerKey(ObjectId upper, K key)
boolean	removeKey(K key)
boolean	removeKey(ObjectId upper, K key)	指定されたkeyをオーバレイから登録削除する。
CompletableFuture<Boolean>	removeKeyAsync(K key)
CompletableFuture<Boolean>	removeKeyAsync(ObjectId upper, K key)	指定されたkeyをオーバレイから非同期に登録削除する。
FutureQueue<?>	request(String dstExp, Object msg)
FutureQueue<?>	request(String dstExp, Object msg, int timeout)
FutureQueue<?>	request(String dstExp, Object msg, TransOptions opts)
FutureQueue<?>	request(ObjectId appId, String dstExp, Object msg)
FutureQueue<?>	request(ObjectId appId, String dstExp, Object msg, int timeout)
FutureQueue<?>	request(ObjectId appId, String dstExp, Object msg, TransOptions opts)
FutureQueue<?>	request(ObjectId sender, ObjectId receiver, String dstExp, Object msg)
FutureQueue<?>	request(ObjectId sender, ObjectId receiver, String dstExp, Object msg, int timeout)
FutureQueue<?>	request(ObjectId sender, ObjectId receiver, String dstExp, Object msg, TransOptions opts)
FutureQueue<?>	request(TransportId transId, String dstExp, Object msg, int timeout)
void	requestAsync(ObjectId sender, ObjectId receiver, String dstExp, Object msg, BiConsumer<Object,Exception> responseReceiver, TransOptions opts)
protected Object	selectOnReceive(OverlayListener<D,K> listener, Overlay<D,K> trans, OverlayReceivedMessage<K> rmsg)
void	send(String dstExp, Object msg)
void	send(ObjectId appId, String dstExp, Object msg)
void	send(ObjectId sender, ObjectId receiver, String dstExp, Object msg)
void	send(TransportId transId, String dstExp, Object msg)
void	setListener(ObjectId upper, OverlayListener<D,K> listener)
<E> FutureQueue<E>	singletonFutureQueue(E value)
<E> FutureQueue<E>	singletonFutureQueue(E value, Throwable t)
String	toString0()
protected boolean	unregisterKey(K key)
protected boolean	unregisterKey(ObjectId upper, K key)

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

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

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

checkActive, fin, 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.ov.Overlay

requestAsync, requestAsync, requestAsync, requestAsync, requestAsync

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

request, request, request, request, request, request, request, request, request, request, request, requestAsync, requestAsync, requestAsync, requestAsync, requestAsync, requestAsync, requestAsync

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

close, fin, getBaseTransport, getEndpoint, getListener, getLowerTransport, getLowerTransports, getMTU, getPeer, getPeerId, getTransportId, getTransportIdPath, hasStableLocator, isUp, send, send, send, send, send, send, send, send, sendAsync, sendAsync, sendAsync, sendAsync, sendAsync, sendAsync, setListener, setListener

フィールド詳細

keyRegister

protected final Map<K extends Key,Integer> keyRegister

isJoined

protected volatile boolean isJoined

コンストラクタの詳細

OverlayImpl

public OverlayImpl(Peer peer, TransportId transId, Transport<?> lowerTrans) throws IdConflictException

パラメータ:

peer - the peer object.

transId - the id of the transport.

lowerTrans - the lower transport.

例外:

IdConflictException - thrown when the id is conflicted.

メソッドの詳細

getAvailableKeyType

public Class<?> getAvailableKeyType()

定義:

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

setListener

public void setListener(ObjectId upper, OverlayListener<D,K> listener)

定義:

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

getListener

public OverlayListener<D,K> getListener(ObjectId upper)

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

Return the registered TransportListener. upper is an ObjectId specified by the setListener. If TransportListener is not registered, null is returned.

定義:

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

定義:

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

オーバーライド:

getListener クラス内 TransportImpl<D extends Destination>

パラメータ:

upper - The ObjectId of the receiver (upper layer) entity.

戻り値:

The TransportListener registered.

send

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

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

send

public void send(TransportId transId, String dstExp, Object msg) throws org.piax.gtrans.dcl.parser.ParseException, ProtocolUnsupportedException, IOException

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

singletonFutureQueue

public <E> FutureQueue<E> singletonFutureQueue(E value)

定義:

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

singletonFutureQueue

public <E> FutureQueue<E> singletonFutureQueue(E value, Throwable t)

定義:

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

send

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

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

send

public void send(String dstExp, Object msg) throws org.piax.gtrans.dcl.parser.ParseException, ProtocolUnsupportedException, IOException

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

public FutureQueue<?> request(TransportId transId, String dstExp, Object msg, int timeout) throws org.piax.gtrans.dcl.parser.ParseException, ProtocolUnsupportedException, IOException

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

public FutureQueue<?> request(ObjectId appId, String dstExp, Object msg) throws org.piax.gtrans.dcl.parser.ParseException, ProtocolUnsupportedException, IOException

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

public FutureQueue<?> request(String dstExp, Object msg) throws org.piax.gtrans.dcl.parser.ParseException, ProtocolUnsupportedException, IOException

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

requestAsync

public void requestAsync(ObjectId sender, ObjectId receiver, String dstExp, Object msg, BiConsumer<Object,Exception> responseReceiver, TransOptions opts) throws org.piax.gtrans.dcl.parser.ParseException, ProtocolUnsupportedException, IOException

定義:

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

selectOnReceive

protected Object selectOnReceive(OverlayListener<D,K> listener, Overlay<D,K> trans, OverlayReceivedMessage<K> rmsg)

numOfRegisteredKey

protected int numOfRegisteredKey(K key)

registerKey

protected void registerKey(K key)

registerKey

protected void registerKey(ObjectId upper, K key)

unregisterKey

protected boolean unregisterKey(K key)

unregisterKey

protected boolean unregisterKey(ObjectId upper, K key)

lowerAddKey

protected void lowerAddKey(K key) throws IOException

例外:

IOException

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>

パラメータ:

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

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

戻り値:

登録に成功した場合 true

例外:

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

addKey

public boolean addKey(K key) throws IOException

定義:

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

例外:

IOException

lowerAddKeyAsync

protected CompletableFuture<Boolean> lowerAddKeyAsync(K key)

addKeyAsync

public CompletableFuture<Boolean> addKeyAsync(ObjectId upper, K key)

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

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

CompletableFugure内に返値としてBooleanを返す。 その値は登録成功でtrue、失敗でfalseである。 同一keyが複数回登録できるかどうかはオーバーレイによる。 オーバーレイが同一keyの複数回登録を許していない場合、登録は失敗しfalseが返る。

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

定義:

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

パラメータ:

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

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

戻り値:

登録用のCompletionStageを表すCompletableFuture

addKeyAsync

public CompletableFuture<Boolean> addKeyAsync(K key)

定義:

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

lowerRemoveKey

protected void lowerRemoveKey(K key) throws IOException

例外:

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>

パラメータ:

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

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

戻り値:

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

例外:

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

removeKey

public boolean removeKey(K key) throws IOException

定義:

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

例外:

IOException

lowerRemoveKeyAsync

protected CompletableFuture<Boolean> lowerRemoveKeyAsync(K key)

removeKeyAsync

public CompletableFuture<Boolean> removeKeyAsync(ObjectId upper, K key)

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

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

CompletableFugure内に返値としてBooleanを返す。 その値は、keyの削除に成功した場合にtrue、失敗した場合はfalseである。 同一key が複数回登録される場合は、 addKey された回数と同じ回数だけremoveKeyAsyncが呼ばれないとkeyは削除されない。

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

定義:

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

パラメータ:

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

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

戻り値:

登録削除用のCompletionStageを表すCompletableFuture

removeKeyAsync

public CompletableFuture<Boolean> removeKeyAsync(K key)

定義:

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

getKeys

public Set<K> getKeys(ObjectId upper)

定義:

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

getKeys

public Set<K> getKeys()

定義:

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

join

public boolean join() throws ProtocolUnsupportedException, IOException

定義:

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

例外:

ProtocolUnsupportedException

IOException

join

public boolean join(String spec) throws ProtocolUnsupportedException, IOException

定義:

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

例外:

ProtocolUnsupportedException

IOException

join

public boolean join(Endpoint seed) throws IOException

定義:

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

例外:

IOException

join

public abstract 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>

パラメータ:

seeds - seedピアのリスト

戻り値:

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

例外:

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

leave

public abstract boolean leave() throws IOException

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

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

定義:

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

戻り値:

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

例外:

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

isJoined

public boolean isJoined()

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

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

定義:

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

戻り値:

overlayの状態。joinedの場合はtrue

toString0

public String toString0()

オーバーライド:

toString0 クラス内 TransportImpl<D extends Destination>