MSkipGraph (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<D,K>
    - - org.piax.gtrans.ov.sg.MSkipGraph<D,K>

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

Overlay<D,K>, RoutingTableAccessor, SGExecQueryCallback, RequestTransport<D>, Transport<D>
```
public class MSkipGraph<D extends Destination,K extends ComparableKey<?>>
extends OverlayImpl<D,K>
implements RoutingTableAccessor, SGExecQueryCallback
```
Multi-key Skip Graph implementation for GTRANS.

フィールドのサマリー

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

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`

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

コンストラクタ
コンストラクタと説明

MSkipGraph(ChannelTransport<?> lowerTrans)

MSkipGraph(TransportId transId, ChannelTransport<?> lowerTrans)

コンストラクタ
コンストラクタと説明
`MSkipGraph(ChannelTransport<?> lowerTrans)`
`MSkipGraph(TransportId transId, ChannelTransport<?> lowerTrans)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`boolean`	`addKey(ObjectId upper, K key)` 指定されたkeyをオーバレイに登録する。
`void`	`fin()` Finalize the Transport object.
`FutureQueue<?>`	`forwardQueryToMaxLessThan(ObjectId sender, ObjectId receiver, LowerUpper lu, Object msg)`
`Link[]`	`getAll()`
`Class<?>`	`getAvailableKeyType()`
`Endpoint`	`getEndpoint()` Returns the local endpoint of the Transport.
`int`	`getHeight(Comparable<?> key)`
`Set<K>`	`getKeys(ObjectId upper)`
`Link`	`getLeft(Comparable<?> key)`
`Link`	`getLeft(Comparable<?> key, int level)`
`Link[]`	`getLefts(Comparable<?> key)`
`Link[]`	`getLefts(Comparable<?> key, int level)`
`Link`	`getLocal(Comparable<?> key)`
`Link`	`getRight(Comparable<?> key)`
`Link`	`getRight(Comparable<?> key, int level)`
`Link[]`	`getRights(Comparable<?> key)`
`Link[]`	`getRights(Comparable<?> key, int level)`
`boolean`	`join(Collection<? extends Endpoint> seeds)` 引数で指定されたseedのリストをseedピアとして、Overlayをjoinする。
`boolean`	`leave()` Overlayを不活性化（leave）する。
`protected void`	`lowerAddKey(K key)`
`protected void`	`lowerRemoveKey(K key)`
`FutureQueue<?>`	`onReceiveRequest(Collection<K> matchedKeys, NestedMessage nmsg)`
`boolean`	`removeKey(ObjectId upper, K key)` 指定されたkeyをオーバレイから登録削除する。
`FutureQueue<?>`	`request(ObjectId sender, ObjectId receiver, Destination dst, Object msg, TransOptions opts)` Send a request message.
`FutureQueue<?>`	`request(ObjectId sender, ObjectId receiver, D dst, Object msg, int timeout)` Send a request message.
`FutureQueue<?>`	`request1(ObjectId sender, ObjectId receiver, K dst, Object msg, TransOptions opts)`
`FutureQueue<?>`	`request2(ObjectId sender, ObjectId receiver, KeyRange<K> dst, Object msg, TransOptions opts)`
`FutureQueue<?>`	`request3(ObjectId sender, ObjectId receiver, KeyRanges<K> dst, Object msg, TransOptions opts)`
`RemoteValue<?>`	`sgExecQuery(Comparable<?> key, Object msg)`

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

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

- フィールドの詳細
  - DEFAULT_TRANSPORT_ID
```
public static TransportId DEFAULT_TRANSPORT_ID
```
- コンストラクタの詳細
  - MSkipGraph
```
public MSkipGraph(ChannelTransport<?> lowerTrans)
           throws IdConflictException,
                  IOException
```
    例外:
    
    IdConflictException
    
    IOException
  - MSkipGraph
```
public MSkipGraph(TransportId transId,
                  ChannelTransport<?> lowerTrans)
           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>
  - 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.
  - request1
```
public FutureQueue<?> request1(ObjectId sender,
                               ObjectId receiver,
                               K dst,
                               Object msg,
                               TransOptions opts)
                        throws ProtocolUnsupportedException,
                               IOException
```
    例外:
    
    ProtocolUnsupportedException
    
    IOException
  - request2
```
public FutureQueue<?> request2(ObjectId sender,
                               ObjectId receiver,
                               KeyRange<K> dst,
                               Object msg,
                               TransOptions opts)
                        throws ProtocolUnsupportedException,
                               IOException
```
    例外:
    
    ProtocolUnsupportedException
    
    IOException
  - request3
```
public FutureQueue<?> request3(ObjectId sender,
                               ObjectId receiver,
                               KeyRanges<K> dst,
                               Object msg,
                               TransOptions opts)
                        throws ProtocolUnsupportedException,
                               IOException
```
    例外:
    
    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<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.
  - forwardQueryToMaxLessThan
```
public FutureQueue<?> forwardQueryToMaxLessThan(ObjectId sender,
                                                ObjectId receiver,
                                                LowerUpper lu,
                                                Object msg)
                                         throws IllegalStateException
```
    例外:
    
    IllegalStateException
  - sgExecQuery
```
public RemoteValue<?> sgExecQuery(Comparable<?> key,
                                  Object msg)
```
    定義:
    
    sgExecQuery インタフェース内 SGExecQueryCallback
  - onReceiveRequest
```
public FutureQueue<?> onReceiveRequest(Collection<K> matchedKeys,
                                       NestedMessage nmsg)
```
  - 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 ComparableKey<?>>
    
    定義:
    
    join クラス内 OverlayImpl<D extends Destination,K extends ComparableKey<?>>
    
    パラメータ:
    
    seeds - seedピアのリスト
    
    戻り値:
    
    すでにjoinされていた場合false
    
    例外:
    
    IOException - join時に例外が発生した時
  - leave
```
public boolean leave()
              throws IOException
```
    インタフェースからコピーされた説明: Overlay
    
    Overlayを不活性化（leave）する。不活性化により、自ピアはオーバレイネットワークから離脱する。
    
    定義:
    
    leave インタフェース内 Overlay<D extends Destination,K extends ComparableKey<?>>
    
    定義:
    
    leave クラス内 OverlayImpl<D extends Destination,K extends ComparableKey<?>>
    
    戻り値:
    
    すでにleaveされていた場合false
    
    例外:
    
    IOException - I/Oエラーが発生した場合
  - getAvailableKeyType
```
public Class<?> getAvailableKeyType()
```
    定義:
    
    getAvailableKeyType インタフェース内 Overlay<D extends Destination,K extends ComparableKey<?>>
    
    オーバーライド:
    
    getAvailableKeyType クラス内 OverlayImpl<D extends Destination,K extends ComparableKey<?>>
  - lowerAddKey
```
protected void lowerAddKey(K key)
                    throws IOException
```
    オーバーライド:
    
    lowerAddKey クラス内 OverlayImpl<D extends Destination,K extends ComparableKey<?>>
    
    例外:
    
    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 ComparableKey<?>>
    
    オーバーライド:
    
    addKey クラス内 OverlayImpl<D extends Destination,K extends ComparableKey<?>>
    
    パラメータ:
    
    upper - このオーバーレイを利用するエンティティのObjectId
    
    key - オーバレイに登録するkey
    
    戻り値:
    
    登録に成功した場合 true
    
    例外:
    
    IOException - 実装クラス特有の例外が発生した場合
  - lowerRemoveKey
```
protected void lowerRemoveKey(K key)
                       throws IOException
```
    オーバーライド:
    
    lowerRemoveKey クラス内 OverlayImpl<D extends Destination,K extends ComparableKey<?>>
    
    例外:
    
    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 ComparableKey<?>>
    
    オーバーライド:
    
    removeKey クラス内 OverlayImpl<D extends Destination,K extends ComparableKey<?>>
    
    パラメータ:
    
    upper - このオーバーレイを利用するエンティティのObjectId
    
    key - オーバレイから登録削除するkey
    
    戻り値:
    
    登録削除に成功した場合 true
    
    例外:
    
    IOException - 実装クラス特有の例外が発生した場合
  - getKeys
```
public Set<K> getKeys(ObjectId upper)
```
    定義:
    
    getKeys インタフェース内 Overlay<D extends Destination,K extends ComparableKey<?>>
    
    オーバーライド:
    
    getKeys クラス内 OverlayImpl<D extends Destination,K extends ComparableKey<?>>
  - request
```
public FutureQueue<?> request(ObjectId sender,
                              ObjectId receiver,
                              D dst,
                              Object msg,
                              int timeout)
                       throws ProtocolUnsupportedException,
                              IOException
```
    インタフェースからコピーされた説明: RequestTransport
    
    Send a request message. FutureQueue object is returned to access arrived responses.
    
    定義:
    
    request インタフェース内 RequestTransport<D extends Destination>
    
    オーバーライド:
    
    request クラス内 RequestTransportImpl<D extends Destination>
    
    パラメータ:
    
    sender - the object ID of the sender.
    
    receiver - the object ID of the receiver.
    
    dst - the destination.
    
    msg - the request message.
    
    timeout - the timeout.
    
    戻り値:
    
    the future queue to access responses.
    
    例外:
    
    ProtocolUnsupportedException - thrown when the protocol is not supported.
    
    IOException - thrown when an I/O error occurs.
  - getAll
```
public Link[] getAll()
```
    定義:
    
    getAll インタフェース内 RoutingTableAccessor
  - getLocal
```
public Link getLocal(Comparable<?> key)
```
    定義:
    
    getLocal インタフェース内 RoutingTableAccessor
  - getRight
```
public Link getRight(Comparable<?> key)
```
    定義:
    
    getRight インタフェース内 RoutingTableAccessor
  - getLeft
```
public Link getLeft(Comparable<?> key)
```
    定義:
    
    getLeft インタフェース内 RoutingTableAccessor
  - getRight
```
public Link getRight(Comparable<?> key,
                     int level)
```
    定義:
    
    getRight インタフェース内 RoutingTableAccessor
  - getLeft
```
public Link getLeft(Comparable<?> key,
                    int level)
```
    定義:
    
    getLeft インタフェース内 RoutingTableAccessor
  - getRights
```
public Link[] getRights(Comparable<?> key)
```
    定義:
    
    getRights インタフェース内 RoutingTableAccessor
  - getLefts
```
public Link[] getLefts(Comparable<?> key)
```
    定義:
    
    getLefts インタフェース内 RoutingTableAccessor
  - getRights
```
public Link[] getRights(Comparable<?> key,
                        int level)
```
    定義:
    
    getRights インタフェース内 RoutingTableAccessor
  - getLefts
```
public Link[] getLefts(Comparable<?> key,
                       int level)
```
    定義:
    
    getLefts インタフェース内 RoutingTableAccessor
  - getHeight
```
public int getHeight(Comparable<?> key)
```
    定義:
    
    getHeight インタフェース内 RoutingTableAccessor

クラス MSkipGraph<D extends Destination,K extends ComparableKey<?>>

フィールドのサマリー

クラスから継承されたフィールド 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.ov.RoutingTableAccessor

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

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

フィールドの詳細

DEFAULT_TRANSPORT_ID

コンストラクタの詳細

MSkipGraph

MSkipGraph

メソッドの詳細

fin

getEndpoint

request1

request2

request3

request

forwardQueryToMaxLessThan

sgExecQuery

onReceiveRequest

join

leave

getAvailableKeyType

lowerAddKey

addKey

lowerRemoveKey

removeKey

getKeys

request

getAll

getLocal

getRight

getLeft

getRight

getLeft

getRights

getLefts

getRights

getLefts

getHeight