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

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

型パラメータ:

D - The destination specification of the overlay.

K - The key of the overlay.

すべてのスーパーインタフェース:

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

既知の実装クラスのリスト:

OverlayImpl

public interface Overlay<D extends Destination,K extends Destination>
extends RequestTransport<D>

The common overlay interface.

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

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

RequestTransport.Response

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
static Option.StringOption	DEFAULT_ENDPOINT
static Option.StringOption	DEFAULT_SEED

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

DEFAULT_APP_ID

メソッドの概要

修飾子とタイプ	メソッド	説明
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 seedSpec)
boolean	join(Collection<? extends Endpoint> seeds)	引数で指定されたseedのリストをseedピアとして、Overlayをjoinする。
boolean	join(Endpoint seed)
boolean	leave()	Overlayを不活性化（leave）する。
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, 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 upperTrans, String dstExp, Object msg, int timeout)
default void	requestAsync(String appIdStr, D dst, String msg, BiConsumer<Object,Exception> responseReceiver)
default void	requestAsync(String dstExp, Object msg, BiConsumer<Object,Exception> responseReceiver)
default void	requestAsync(String dstExp, Object msg, BiConsumer<Object,Exception> responseReceiver, TransOptions opts)
default void	requestAsync(ObjectId appId, String dstExp, Object msg, BiConsumer<Object,Exception> responseReceiver)
default void	requestAsync(ObjectId appId, String dstExp, Object msg, BiConsumer<Object,Exception> responseReceiver, TransOptions opts)
void	requestAsync(ObjectId sender, ObjectId receiver, String dstExp, Object msg, BiConsumer<Object,Exception> resultsReceiver, TransOptions opts)
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 upperTrans, String dstExp, Object msg)
void	setListener(ObjectId upper, OverlayListener<D,K> listener)

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

request, request, request, request, request, request, request, request, request, request, request, requestAsync, requestAsync, requestAsync, requestAsync, requestAsync, requestAsync, requestAsync, singletonFutureQueue, singletonFutureQueue

インタフェースから継承されたメソッド 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

フィールド詳細

DEFAULT_ENDPOINT

static final Option.StringOption DEFAULT_ENDPOINT

DEFAULT_SEED

static final Option.StringOption DEFAULT_SEED

メソッドの詳細

setListener

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

getListener

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 インタフェース内 Transport<D extends Destination>

パラメータ:

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

戻り値:

The TransportListener registered.

getAvailableKeyType

Class<?> getAvailableKeyType()

send

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

send

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

send

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

send

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

request

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

requestAsync

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

requestAsync

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

requestAsync

default void requestAsync(ObjectId appId, String dstExp, Object msg, BiConsumer<Object,Exception> responseReceiver) throws org.piax.gtrans.dcl.parser.ParseException, ProtocolUnsupportedException, IOException

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

requestAsync

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

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

requestAsync

default void requestAsync(String dstExp, Object msg, BiConsumer<Object,Exception> responseReceiver) throws org.piax.gtrans.dcl.parser.ParseException, ProtocolUnsupportedException, IOException

例外:

org.piax.gtrans.dcl.parser.ParseException

ProtocolUnsupportedException

IOException

requestAsync

default void requestAsync(String appIdStr, D dst, String msg, BiConsumer<Object,Exception> responseReceiver)

addKey

boolean addKey(ObjectId upper, K key) throws IOException

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

同一key が複数回登録できるかどうかはオーバーレイによる。 オーバーレイが同一keyの複数回登録を許していない場合、登録は失敗しfalseが返る。

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

パラメータ:

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

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

戻り値:

登録に成功した場合 true

例外:

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

IllegalArgumentException - keyに nullが指定された場合

ClassCastException - 引数が適切な型でない場合

UnsupportedOperationException - オーバレイがこのメソッドをサポートしていない場合

addKey

boolean addKey(K key) throws IOException

例外:

IOException

addKeyAsync

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

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

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

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

パラメータ:

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

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

戻り値:

登録用のCompletionStageを表すCompletableFuture

例外:

IllegalArgumentException - keyに nullが指定された場合

ClassCastException - 引数が適切な型でない場合

UnsupportedOperationException - オーバレイがこのメソッドをサポートしていない場合

addKeyAsync

CompletableFuture<Boolean> addKeyAsync(K key) throws IOException

例外:

IOException

removeKey

boolean removeKey(ObjectId upper, K key) throws IOException

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

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

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

パラメータ:

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

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

戻り値:

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

例外:

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

IllegalArgumentException - keyに nullが指定された場合

ClassCastException - 引数が適切な型でない場合

UnsupportedOperationException - オーバレイがこのメソッドをサポートしていない場合

removeKey

boolean removeKey(K key) throws IOException

例外:

IOException

removeKeyAsync

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

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

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

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

パラメータ:

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

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

戻り値:

登録削除用のCompletionStageを表すCompletableFuture

例外:

IllegalArgumentException - keyに nullが指定された場合

ClassCastException - 引数が適切な型でない場合

UnsupportedOperationException - オーバレイがこのメソッドをサポートしていない場合

removeKeyAsync

CompletableFuture<Boolean> removeKeyAsync(K key)

getKeys

Set<K> getKeys(ObjectId upper)

getKeys

Set<K> getKeys()

join

boolean join(Endpoint seed) throws IOException

例外:

IOException

join

boolean join() throws IOException

例外:

IOException

join

boolean join(String seedSpec) throws IOException

例外:

IOException

join

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

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

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

パラメータ:

seeds - seedピアのリスト

戻り値:

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

例外:

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

leave

boolean leave() throws IOException

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

戻り値:

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

例外:

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

isJoined

boolean isJoined()

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

戻り値:

overlayの状態。joinedの場合はtrue