SkipGraph (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.gtrans.RPCInvoker<SkipGraphIf<E>,E>
- - org.piax.gtrans.ov.sg.SkipGraph<E>

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

SkipGraphIf<E>, RPCIf
```
public class SkipGraph<E extends Endpoint>
extends RPCInvoker<SkipGraphIf<E>,E>
implements SkipGraphIf<E>
```
Skip graphクラス．Skip graphに参加する単一物理ピアに対応する．複数のキーを登録できるが，メンバシップベクタは複数のキーで共通である．

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`SkipGraph.BestLink` A class used for passing a link to the closest node.
`static class`	`SkipGraph.ExecQueryReturn` an execQuery return value used by (non-scalable) range queries
`static class`	`SkipGraph.LvState` A state for each level of a skip graph.
`static class`	`SkipGraph.RightNodeMismatch`
`static class`	`SkipGraph.SGNodeInfo` This is a class used as a return type for SkipGraph#getSGNodeInfo

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

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`DDLL_CHECK_PERIOD_L0` DDLL's left node check period for level 0 (msec)
`static int`	`DDLL_CHECK_PERIOD_L1` DDLL's left node check period for level 1 and above (msec)
`static TransportId`	`DEFAULT_TRANSPORT_ID`
`static int`	`FIND_INSERT_POINT_TIMEOUT` timeout for `find(Endpoint, DdllKey, boolean)`
`static int`	`QID_EXPIRATION_TASK_PERIOD` period for executing a task for purging stale QueryIDs
`static int`	`QID_EXPIRE` expiration time for purging stale QueryIDs
`static String`	`QUERY_INSERT_POINT_SPECIAL` used as the query string for finding insert points.
`static int`	`RPC_TIMEOUT`
`static int`	`RQ_EXPIRATION_GRACE` additional grace time before removing RQReturn in intermediate nodes
`static int`	`RQ_FLUSH_PERIOD` the period for flushing partial results in intermediate nodes
`static int`	`RQ_NRECENT` Range Queryでトラバース中に通信エラーが起きた場合に戻れるノード数
`static int`	`RQ_RETRANS_PERIOD` range query retransmission period

クラスから継承されたフィールド org.piax.gtrans.RPCInvoker
channelPool, isActive, objId, POOL_CHANNEL, POOL_CHANNEL_SIZE, trans, transId, USE_CHANNEL_FOR_ONEWAY

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

コンストラクタ
コンストラクタと説明
`SkipGraph(ChannelTransport<E> trans, SGExecQueryCallback execQueryCallback)` create a SkipGraph instance.
`SkipGraph(TransportId transId, ChannelTransport<E> trans, SGExecQueryCallback execQueryCallback)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods 非推奨のメソッド
修飾子とタイプ	メソッドと説明
`void`	`ackReceived(int msgId)`
`boolean`	`addKey(Comparable<?> rawkey)` add a key to the skip graph.
`boolean`	`addKey(E introducer, Comparable<?> rawkey)` add a key to the skip graph.
`void`	`fin()`
`Node.InsertPoint`	`find(E introducer, DdllKey key, boolean accurate)` find a location to insert `key'.
`SkipGraph.BestLink`	`findClosestLocal(DdllKey key, boolean accurate)` 非推奨です。
`Node.InsertPoint`	`findOld(E introducer, DdllKey key, boolean accurate)` 非推奨です。
`void`	`fixAndPropagateSingle(Comparable<?> target, Link failedLink, Collection<Link> failedLinks, DdllKey rLimit)`
`List<RemoteValue<?>>`	`forwardQuery(boolean isPlusDir, Range<?> range, int maxNum, Object query)` 指定されたkeyとNavigableCondの条件を満たすキーを持つピア（最大num個）にクエリを転送し、得られた結果（リスト）を返す。
`List<RemoteValue<?>>`	`forwardQuery(Collection<? extends Range<?>> ranges, Object query)` 指定された複数の範囲にクエリを転送し、得られた結果（リスト）を返す。
`int`	`getHeight()` 経路表の高さを返す．
`Link[]`	`getLocalLinks()`
`PeerId`	`getPeerId()` get PeerId
`SGNode<E>`	`getSGNode(Comparable<?> rawkey)` get SGNode instance (for debugging only)
`SkipGraph.SGNodeInfo`	`getSGNodeInfo(Comparable<?> target, int level, MembershipVector mv, int nTraversed)`
`SkipGraph.ExecQueryReturn`	`invokeExecQuery(Comparable<?> rawkey, Link curRight, org.piax.gtrans.ov.sg.SkipGraph.QueryId qid, boolean doAction, Object query)` Range Query実行時にRPCで呼び出されるメソッド．
`boolean`	`removeKey(Comparable<?> rawkey)` remove a key from the skip graph.
`void`	`replyMsgReceived(SGMessagingFramework.SGReplyMessage<E> sgReplyMessage)`
`void`	`requestMsgReceived(SGMessagingFramework.SGRequestMessage<E> sgMessage)` one-way RPCs
`FutureQueue<?>`	`scalableRangeQuery(Collection<? extends Range<?>> ranges, Object query, TransOptions opts)` Perform a range query.
`String`	`showTable()` get a the routing table in plain text format.
`String`	`toString()`
`String`	`toStringShort()`

クラスから継承されたメソッド org.piax.gtrans.RPCInvoker
changeRPCTimeout, changeTransport, checkActive, getEndpoint, getRPCObject, getSrcPeerId, getStub, getStub, getStub, getStub, getStub, getStub, getStub, getStub, getStub, getStub, getTransport, invokeInReceive, isOnline, newMethodCall, offline, online, rcall, rcall, rcall, rcall, rcall, rcall, rcall, rcall, receiveOneway, receiveSync, registerRPCObject, sendInvoke, sendOnewayInvoke, unregisterRPCObject

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - DEFAULT_TRANSPORT_ID
```
public static TransportId DEFAULT_TRANSPORT_ID
```
  - DDLL_CHECK_PERIOD_L0
```
public static int DDLL_CHECK_PERIOD_L0
```
    DDLL's left node check period for level 0 (msec)
  - DDLL_CHECK_PERIOD_L1
```
public static int DDLL_CHECK_PERIOD_L1
```
    DDLL's left node check period for level 1 and above (msec)
  - RQ_NRECENT
```
public static int RQ_NRECENT
```
    Range Queryでトラバース中に通信エラーが起きた場合に戻れるノード数
  - RPC_TIMEOUT
```
public static int RPC_TIMEOUT
```
  - QID_EXPIRE
```
public static int QID_EXPIRE
```
    expiration time for purging stale QueryIDs
  - QID_EXPIRATION_TASK_PERIOD
```
public static int QID_EXPIRATION_TASK_PERIOD
```
    period for executing a task for purging stale QueryIDs
  - RQ_FLUSH_PERIOD
```
public static int RQ_FLUSH_PERIOD
```
    the period for flushing partial results in intermediate nodes
  - RQ_EXPIRATION_GRACE
```
public static int RQ_EXPIRATION_GRACE
```
    additional grace time before removing RQReturn in intermediate nodes
  - RQ_RETRANS_PERIOD
```
public static int RQ_RETRANS_PERIOD
```
    range query retransmission period
  - QUERY_INSERT_POINT_SPECIAL
```
public static String QUERY_INSERT_POINT_SPECIAL
```
    used as the query string for finding insert points. see find(Endpoint, DdllKey, boolean)
  - FIND_INSERT_POINT_TIMEOUT
```
public static int FIND_INSERT_POINT_TIMEOUT
```
    timeout for find(Endpoint, DdllKey, boolean)
- コンストラクタの詳細
  - SkipGraph
```
public SkipGraph(ChannelTransport<E> trans,
                 SGExecQueryCallback execQueryCallback)
          throws IdConflictException,
                 IOException
```
    create a SkipGraph instance.
    
    パラメータ:
    
    trans - underlying transport
    
    execQueryCallback - a callback object called when #execQuery(Deque, Comparable, QueryCondition, Object) is called
    
    例外:
    
    IdConflictException - an exception occurs when the default transport id is registered.
    
    IOException - an exception thrown when an I/O error occurred.
  - SkipGraph
```
public SkipGraph(TransportId transId,
                 ChannelTransport<E> trans,
                 SGExecQueryCallback execQueryCallback)
          throws IdConflictException,
                 IOException
```
    例外:
    
    IdConflictException
    
    IOException
- メソッドの詳細
  - fin
```
public void fin()
```
    オーバーライド:
    
    fin クラス内 RPCInvoker<SkipGraphIf<E extends Endpoint>,E extends Endpoint>
  - getSGNode
```
public SGNode<E> getSGNode(Comparable<?> rawkey)
```
    get SGNode instance (for debugging only)
    
    パラメータ:
    
    rawkey - the raw key.
    
    戻り値:
    
    the corresponding SGNode object.
  - getPeerId
```
public PeerId getPeerId()
```
    get PeerId
    
    戻り値:
    
    PeerId
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - toStringShort
```
public String toStringShort()
```
  - showTable
```
public String showTable()
```
    get a the routing table in plain text format.
    
    戻り値:
    
    routing table
  - addKey
```
public boolean addKey(Comparable<?> rawkey)
               throws IOException,
                      UnavailableException
```
    add a key to the skip graph.
    
    パラメータ:
    
    rawkey - the key
    
    戻り値:
    
    true if the key was successfully added
    
    例外:
    
    IOException - thrown when some I/O error occurred in communicating with the introducer
    
    UnavailableException - thrown when the introducer has no key
  - addKey
```
public boolean addKey(E introducer,
                      Comparable<?> rawkey)
               throws UnavailableException,
                      IOException
```
    add a key to the skip graph.
    同一キーは複数登録できない． 1物理ノード上に複数キーを並行挿入できるようにすることが困難だったので，synchronized method としている．
    
    パラメータ:
    
    introducer - some node that has been inserted to the skip graph
    
    rawkey - the key
    
    戻り値:
    
    true if the key was successfully added
    
    例外:
    
    IOException - thrown when some I/O error occurred in communicating with the introducer
    
    UnavailableException - thrown when the introducer has no key
  - removeKey
```
public boolean removeKey(Comparable<?> rawkey)
                  throws IOException
```
    remove a key from the skip graph.
    
    パラメータ:
    
    rawkey - the key
    
    戻り値:
    
    true if the key was successfully removed
    
    例外:
    
    IOException - thrown if some I/O error occurred.
  - getLocalLinks
```
public Link[] getLocalLinks()
```
    定義:
    
    getLocalLinks インタフェース内 SkipGraphIf<E extends Endpoint>
  - findClosestLocal
```
@Deprecated
public SkipGraph.BestLink findClosestLocal(DdllKey key,
                                                       boolean accurate)
                                                throws UnavailableException
```
    非推奨です。
    
    ローカルの経路表からkeyに最も近いリンクを検索する． RPCで呼ばれる．返される BestLink u は，isOrdered(u.link.key, key, u.rightLink.key) を満たす．
    
    定義:
    
    findClosestLocal インタフェース内 SkipGraphIf<E extends Endpoint>
    
    パラメータ:
    
    key - 検索するキー
    
    accurate - 正確な値が必要ならばtrue (左リンクを信用しない)
    
    戻り値:
    
    BestLink
    
    例外:
    
    UnavailableException - ローカルの経路表にキーが1つも登録されていない場合
  - getSGNodeInfo
```
public SkipGraph.SGNodeInfo getSGNodeInfo(Comparable<?> target,
                                          int level,
                                          MembershipVector mv,
                                          int nTraversed)
                                   throws NoSuchKeyException
```
    定義:
    
    getSGNodeInfo インタフェース内 SkipGraphIf<E extends Endpoint>
    
    例外:
    
    NoSuchKeyException
  - findOld
```
@Deprecated
public Node.InsertPoint findOld(E introducer,
                                            DdllKey key,
                                            boolean accurate)
                                     throws UnavailableException,
                                            IOException
```
    非推奨です。
    find a location to insert `key'.
    iterative routingを使用．
```
 アルゴリズム: 
 ・introducerからBestLinkを得る (findBestの呼び出し)．
   introducer==nullの場合，自ノードの経路表を使う．
 ・introducerとの通信で通信エラーが発生した場合はIOExceptionをthrowする．
 ・エラーでなければ再帰的に自分自身を呼び出す．
 ・IOExceptionをキャッチしたら，introducerからBestLinkを再度得てやりなおす．
 
```
    パラメータ:
    
    introducer - the node to communicate with.
    
    key - the query key
    
    accurate - true if accurate location is required (do not trust left links of DDLL node)
    
    戻り値:
    
    the insertion point for `key'
    
    例外:
    
    UnavailableException - 自ノードあるいはseedにkeyが登録されていない
    
    IOException - seedと通信する際にエラーが発生
  - find
```
public Node.InsertPoint find(E introducer,
                             DdllKey key,
                             boolean accurate)
                      throws UnavailableException,
                             IOException
```
    find a location to insert `key'.
    
    パラメータ:
    
    introducer - the node to communicate with.
    
    key - the query key
    
    accurate - true if accurate location is required (do not trust left links of DDLL node)
    
    戻り値:
    
    the insertion point for `key'
    
    例外:
    
    UnavailableException - 自ノードあるいはseedにkeyが登録されていない
    
    IOException - communication error
  - getHeight
```
public int getHeight()
```
    経路表の高さを返す． Level0しかない経路表の高さは1． INSERTEDであるノードの経路表高さは一致していなければならない．
    
    戻り値:
    
    the height of the routing tables
  - forwardQuery
```
public List<RemoteValue<?>> forwardQuery(Collection<? extends Range<?>> ranges,
                                         Object query)
```
    指定された複数の範囲にクエリを転送し、得られた結果（リスト）を返す。
    
    パラメータ:
    
    ranges - 範囲のリスト
    
    query - クエリ
    
    戻り値:
    
    クエリ結果のリスト
  - forwardQuery
```
public List<RemoteValue<?>> forwardQuery(boolean isPlusDir,
                                         Range<?> range,
                                         int maxNum,
                                         Object query)
```
    指定されたkeyとNavigableCondの条件を満たすキーを持つピア（最大num個）にクエリを転送し、得られた結果（リスト）を返す。
    例えば、keyが10、NavigableCondがLOWER、numが5の場合、10を越えなくて、 10の近傍にある最大5個のキーが探索対象となる。 numに2以上をセットする用途としては、 DHTのように特定のkeyの近傍集合にアクセスするケースがある。尚、探索対象となるキーは、指定されたkeyと同じ型を持つ必要がある。
    
    パラメータ:
    
    isPlusDir - +方向にrangeにサーチする場合はtrue
    
    range - 探索対象となるRange
    
    maxNum - 条件を満たす最大個数
    
    query - the query passed to execQuery()
    
    戻り値:
    
    クエリ結果のリスト
  - invokeExecQuery
```
public SkipGraph.ExecQueryReturn invokeExecQuery(Comparable<?> rawkey,
                                                 Link curRight,
                                                 org.piax.gtrans.ov.sg.SkipGraph.QueryId qid,
                                                 boolean doAction,
                                                 Object query)
                                          throws NoSuchKeyException,
                                                 SkipGraph.RightNodeMismatch
```
    Range Query実行時にRPCで呼び出されるメソッド．指定されたパラメータで execQuery を実行する． curRight != null の場合，レベル0の右リンクがcurRightと等しい場合にのみ実行． execQueryの結果(RemoteValue)と，レベル0での左右のリンクを SkipGraph.ExecQueryReturn に詰めて返す．
    
    定義:
    
    invokeExecQuery インタフェース内 SkipGraphIf<E extends Endpoint>
    
    例外:
    
    NoSuchKeyException - rawkeyが存在しない
    
    SkipGraph.RightNodeMismatch - curRightがマッチしない
  - scalableRangeQuery
```
public FutureQueue<?> scalableRangeQuery(Collection<? extends Range<?>> ranges,
                                         Object query,
                                         TransOptions opts)
```
    Perform a range query.
    this procedure tries to send a query message to all the nodes within the specified ranges. this method is asynchronous; this method returns immediately and results are returned asynchronously via ReturnSet.
    if some results could not be obtained within RQ_RETRANS_PERIOD, the originating node retransmits a range query message that covers the missing ranges until it exceeds the timeout.
    
    パラメータ:
    
    ranges - set of query ranges
    
    query - the object passed to the nodes in the query range
    
    opts - the options.
    
    戻り値:
    
    ReturnSet to obtain query results
  - requestMsgReceived
```
public void requestMsgReceived(SGMessagingFramework.SGRequestMessage<E> sgMessage)
```
    one-way RPCs
    
    定義:
    
    requestMsgReceived インタフェース内 SkipGraphIf<E extends Endpoint>
  - replyMsgReceived
```
public void replyMsgReceived(SGMessagingFramework.SGReplyMessage<E> sgReplyMessage)
```
    定義:
    
    replyMsgReceived インタフェース内 SkipGraphIf<E extends Endpoint>
  - ackReceived
```
public void ackReceived(int msgId)
```
    定義:
    
    ackReceived インタフェース内 SkipGraphIf<E extends Endpoint>
  - fixAndPropagateSingle
```
public void fixAndPropagateSingle(Comparable<?> target,
                                  Link failedLink,
                                  Collection<Link> failedLinks,
                                  DdllKey rLimit)
```
    定義:
    
    fixAndPropagateSingle インタフェース内 SkipGraphIf<E extends Endpoint>

クラス SkipGraph<E extends Endpoint>

ネストされたクラスのサマリー

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

フィールドのサマリー

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

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

メソッドのサマリー

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

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

フィールドの詳細

DEFAULT_TRANSPORT_ID

DDLL_CHECK_PERIOD_L0

DDLL_CHECK_PERIOD_L1

RQ_NRECENT

RPC_TIMEOUT

QID_EXPIRE

QID_EXPIRATION_TASK_PERIOD

RQ_FLUSH_PERIOD

RQ_EXPIRATION_GRACE

RQ_RETRANS_PERIOD

QUERY_INSERT_POINT_SPECIAL

FIND_INSERT_POINT_TIMEOUT

コンストラクタの詳細

SkipGraph

SkipGraph

メソッドの詳細

fin

getSGNode

getPeerId

toString

toStringShort

showTable

addKey

addKey

removeKey

getLocalLinks

findClosestLocal

getSGNodeInfo

findOld

find

getHeight

forwardQuery

forwardQuery

invokeExecQuery

scalableRangeQuery

requestMsgReceived

replyMsgReceived

ackReceived

fixAndPropagateSingle