DOLR (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.gtrans.impl.TransportImpl<D>
- - org.piax.gtrans.impl.RequestTransportImpl<D>
  - - org.piax.gtrans.ov.impl.OverlayImpl<K,K>
    - - org.piax.gtrans.ov.dolr.DOLR<K>

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

Overlay<K,K>, OverlayListener<ConvertedComparableKey<K>,ConvertedComparableKey<K>>, RequestTransport<K>, Transport<K>, TransportListener<ConvertedComparableKey<K>>
```
public class DOLR<K extends Key>
extends OverlayImpl<K,K>
implements OverlayListener<ConvertedComparableKey<K>,ConvertedComparableKey<K>>
```
Decentralized object location and routing implementation on PIAX

フィールドのサマリー

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

static TransportId DEFAULT_TRANSPORT_ID
- クラスから継承されたフィールド 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

フィールド
修飾子とタイプ	フィールドと説明
`static TransportId`	`DEFAULT_TRANSPORT_ID`

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

コンストラクタ
コンストラクタと説明
`DOLR(Overlay<? super ConvertedComparableKey<K>,? super ConvertedComparableKey<K>> sg)`
`DOLR(TransportId transId, Overlay<? super ConvertedComparableKey<K>,? super ConvertedComparableKey<K>> sg)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`fin()` Finalize the Transport object.
`Class<?>`	`getAvailableKeyType()`
`Endpoint`	`getEndpoint()` Returns the local endpoint of the Transport.
`Overlay<ConvertedComparableKey<K>,ConvertedComparableKey<K>>`	`getLowerTransport()` Returns the lower layer Transport object.
`boolean`	`isJoined()` overlayの状態（join/leave）を返す。
`boolean`	`join(Collection<? extends Endpoint> seeds)` 引数で指定されたseedのリストをseedピアとして、Overlayをjoinする。
`boolean`	`leave()` Overlayを不活性化（leave）する。
`protected void`	`lowerAddKey(K key)`
`protected void`	`lowerRemoveKey(K key)`
`void`	`onReceive(Overlay<ConvertedComparableKey<K>,ConvertedComparableKey<K>> trans, OverlayReceivedMessage<ConvertedComparableKey<K>> rmsg)`
`void`	`onReceive(RequestTransport<ConvertedComparableKey<K>> trans, ReceivedMessage rmsg)`
`void`	`onReceive(Transport<ConvertedComparableKey<K>> trans, ReceivedMessage rmsg)` Transportオブジェクトがメッセージを受信した際に呼び出されるメソッド。
`FutureQueue<?>`	`onReceiveRequest(Overlay<ConvertedComparableKey<K>,ConvertedComparableKey<K>> trans, OverlayReceivedMessage<ConvertedComparableKey<K>> rmsg)`
`FutureQueue<?>`	`onReceiveRequest(RequestTransport<ConvertedComparableKey<K>> trans, ReceivedMessage rmsg)`
`FutureQueue<?>`	`request(ObjectId sender, ObjectId receiver, K dst, Object msg, TransOptions opts)` Send a request message.

クラスから継承されたメソッド org.piax.gtrans.ov.impl.OverlayImpl
addKey, addKey, getKeys, getKeys, getListener, join, registerKey, removeKey, 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, send

クラスから継承されたメソッド org.piax.gtrans.impl.TransportImpl
checkActive, getBaseTransport, getDefaultAppId, getListener, 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, getLowerTransports, getMTU, getPeer, getPeerId, getTransportId, getTransportIdPath, hasStableLocator, isUp, send, send, send, send, send, send, send, send, setListener, setListener

- フィールドの詳細
  - DEFAULT_TRANSPORT_ID
```
public static TransportId DEFAULT_TRANSPORT_ID
```
- コンストラクタの詳細
  - DOLR
```
public DOLR(Overlay<? super ConvertedComparableKey<K>,? super ConvertedComparableKey<K>> sg)
     throws IdConflictException,
            IOException
```
    例外:
    
    IdConflictException
    
    IOException
  - DOLR
```
public DOLR(TransportId transId,
            Overlay<? super ConvertedComparableKey<K>,? super ConvertedComparableKey<K>> sg)
     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<K extends Key>
    
    オーバーライド:
    
    fin クラス内 TransportImpl<K extends Key>
  - 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<K extends Key>
    
    戻り値:
    
    The Endpoint which the Transport treats.
  - getAvailableKeyType
```
public Class<?> getAvailableKeyType()
```
    定義:
    
    getAvailableKeyType インタフェース内 Overlay<K extends Key,K extends Key>
    
    オーバーライド:
    
    getAvailableKeyType クラス内 OverlayImpl<K extends Key,K extends Key>
  - request
```
public FutureQueue<?> request(ObjectId sender,
                              ObjectId receiver,
                              K dst,
                              Object msg,
                              TransOptions opts)
                       throws ProtocolUnsupportedException,
                              IOException
```
    インタフェースからコピーされた説明: RequestTransport
    
    Send a request message. FutureQueue object is returned to access arrived responses.
    
    定義:
    
    request インタフェース内 RequestTransport<K extends Key>
    
    パラメータ:
    
    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<ConvertedComparableKey<K>,ConvertedComparableKey<K>> trans,
                      OverlayReceivedMessage<ConvertedComparableKey<K>> rmsg)
```
    定義:
    
    onReceive インタフェース内 OverlayListener<ConvertedComparableKey<K extends Key>,ConvertedComparableKey<K extends Key>>
  - onReceiveRequest
```
public FutureQueue<?> onReceiveRequest(Overlay<ConvertedComparableKey<K>,ConvertedComparableKey<K>> trans,
                                       OverlayReceivedMessage<ConvertedComparableKey<K>> rmsg)
```
    定義:
    
    onReceiveRequest インタフェース内 OverlayListener<ConvertedComparableKey<K extends Key>,ConvertedComparableKey<K extends Key>>
  - join
```
public boolean join(Collection<? extends Endpoint> seeds)
             throws IOException
```
    インタフェースからコピーされた説明: Overlay
    
    引数で指定されたseedのリストをseedピアとして、Overlayをjoinする。
    Overlayがすでにjoinな状態の場合は、joinは実行されずに、falseが返る。
    
    定義:
    
    join インタフェース内 Overlay<K extends Key,K extends Key>
    
    定義:
    
    join クラス内 OverlayImpl<K extends Key,K extends Key>
    
    パラメータ:
    
    seeds - seedピアのリスト
    
    戻り値:
    
    すでにjoinされていた場合false
    
    例外:
    
    IOException - join時に例外が発生した時
  - leave
```
public boolean leave()
              throws IOException
```
    インタフェースからコピーされた説明: Overlay
    
    Overlayを不活性化（leave）する。不活性化により、自ピアはオーバレイネットワークから離脱する。
    
    定義:
    
    leave インタフェース内 Overlay<K extends Key,K extends Key>
    
    定義:
    
    leave クラス内 OverlayImpl<K extends Key,K extends Key>
    
    戻り値:
    
    すでにleaveされていた場合false
    
    例外:
    
    IOException - I/Oエラーが発生した場合
  - isJoined
```
public boolean isJoined()
```
    インタフェースからコピーされた説明: Overlay
    
    overlayの状態（join/leave）を返す。
    
    定義:
    
    isJoined インタフェース内 Overlay<K extends Key,K extends Key>
    
    オーバーライド:
    
    isJoined クラス内 OverlayImpl<K extends Key,K extends Key>
    
    戻り値:
    
    overlayの状態。joinedの場合はtrue
  - lowerAddKey
```
protected void lowerAddKey(K key)
                    throws IOException
```
    オーバーライド:
    
    lowerAddKey クラス内 OverlayImpl<K extends Key,K extends Key>
    
    例外:
    
    IOException
  - lowerRemoveKey
```
protected void lowerRemoveKey(K key)
                       throws IOException
```
    オーバーライド:
    
    lowerRemoveKey クラス内 OverlayImpl<K extends Key,K extends Key>
    
    例外:
    
    IOException
  - getLowerTransport
```
public Overlay<ConvertedComparableKey<K>,ConvertedComparableKey<K>> getLowerTransport()
```
    インタフェースからコピーされた説明: Transport
    
    Returns the lower layer Transport object. If there are multiple Transport objects exist or no Transport object exists, null is returned.
    
    定義:
    
    getLowerTransport インタフェース内 Transport<K extends Key>
    
    オーバーライド:
    
    getLowerTransport クラス内 TransportImpl<K extends Key>
    
    戻り値:
    
    The lower layer Transport object.
  - onReceive
```
public void onReceive(Transport<ConvertedComparableKey<K>> trans,
                      ReceivedMessage rmsg)
```
    インタフェースからコピーされた説明: TransportListener
    
    Transportオブジェクトがメッセージを受信した際に呼び出されるメソッド。受信メッセージは、送信元の情報などを付加したReceivedMessageオブジェクトの形で取得される。
    
    定義:
    
    onReceive インタフェース内 OverlayListener<ConvertedComparableKey<K extends Key>,ConvertedComparableKey<K extends Key>>
    
    定義:
    
    onReceive インタフェース内 TransportListener<ConvertedComparableKey<K extends Key>>
    
    パラメータ:
    
    trans - Transportオブジェクト
    
    rmsg - ReceivedMessageオブジェクト
  - onReceive
```
public void onReceive(RequestTransport<ConvertedComparableKey<K>> trans,
                      ReceivedMessage rmsg)
```
  - onReceiveRequest
```
public FutureQueue<?> onReceiveRequest(RequestTransport<ConvertedComparableKey<K>> trans,
                                       ReceivedMessage rmsg)
```

クラス DOLR<K extends Key>

フィールドのサマリー

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

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

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

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

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

メソッドのサマリー

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

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

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

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

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

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

フィールドの詳細

DEFAULT_TRANSPORT_ID

コンストラクタの詳細

DOLR

DOLR

メソッドの詳細

fin

getEndpoint

getAvailableKeyType

request

onReceive

onReceiveRequest

join

leave

isJoined

lowerAddKey

lowerRemoveKey

getLowerTransport

onReceive

onReceive

onReceiveRequest