RingManager (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.gtrans.RPCInvoker<RingIf,E>
- - org.piax.gtrans.ov.ring.RingManager<E>

型パラメータ:

E - the type of Endpoint in the underlying network.

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

RingIf, RPCIf

直系の既知のサブクラス:

RQManager
```
public class RingManager<E extends Endpoint>
extends RPCInvoker<RingIf,E>
implements RingIf
```
simple ring network over DDLL protocol. this class may be used as a base class of ring-based structured P2P networks. this class can handle multiple keys.

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

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`RingManager.ExecQueryReturn` an execQuery return value used by (non-scalable) range queries
`static class`	`RingManager.LinkContainer` A class used for passing a link to the closest node.
`static class`	`RingManager.RightNodeMismatch`

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

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`DDLL_CHECK_PERIOD_L0` DDLL's left node check period for level 0 (msec)
`static TransportId`	`DEFAULT_TRANSPORT_ID`
`protected static KeyComparator`	`keyComp`
`protected NavigableMap<Comparable<?>,RingVNode<E>>`	`keyHash`
`protected static org.slf4j.Logger`	`logger`
`protected NodeManager`	`manager` DDLL node manager
`protected MessagingFramework`	`msgframe`
`protected E`	`myLocator`
`protected PeerId`	`peerId`
`protected Random`	`rand`
`static int`	`RPC_TIMEOUT`
`protected StatManager`	`statman`
`TransportId`	`transId`

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

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

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

RingManager(TransportId transId, ChannelTransport<E> trans)
create a Chord# instance.

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

メソッドのサマリー

All Methods Instance Methods Concrete Methods 非推奨のメソッド
修飾子とタイプ	メソッドと説明
`void`	`ackReceived(int msgId, AckMessage ackMessage)`
`protected boolean`	`addKey(Comparable<?> rawkey)` add a key to the ring.
`boolean`	`addKey(E introducer, Comparable<?> rawkey)` add a key to the ring.
`protected boolean`	`addKey(E introducer, Comparable<?> rawkey, Object... vnodeParams)`
`List<? extends RingVNode<E>>`	`allValidVNodes()` get all inserted RingVNode instances
`Collection<? extends RingVNode<E>>`	`allVNodes()` get all RingVNode instances
`void`	`checkLocked()`
`void`	`fin()`
`Node.InsertPoint`	`find(E introducer, DdllKey key, boolean accurate, Object query, TransOptions opts)` find a location to insert `key'.
`Node.InsertPoint`	`findImmedNeighbors(E introducer, DdllKey key, Object query, TransOptions opts)` Find the contact nodes (the immediate left and right node) for inserting a node.
`Link`	`findLeftLink(DdllKey key)` find the closest left link of `key' from the local routing table.
`void`	`fixRoutingTables(Collection<Link> failedNodes, RQMessage parentMsg, Collection<CircularRange<DdllKey>> ranges)`
`protected NavigableMap<DdllKey,Link>`	`getAvailableLinks()` gather all links from all virtual nodes.
`Link[]`	`getClosestLinks(DdllKey key)` get the closest left and right links of `key' in the local routing table.
`Link[]`	`getLocalLinks()`
`PeerId`	`getPeerId()` get PeerId
`RequestMessage`	`getRequestMessageById(int replyId)`
`RingIf`	`getStub(E addr, int rpcTimeout)` リモートピア上のこのオブジェクトに対応するRPCInvokerオブジェクトのメソッドを呼び出すためのstubを返す。
`RingIf`	`getStub(Endpoint dst)` リモートピア上のこのオブジェクトに対応するRPCInvokerオブジェクトのメソッドを呼び出すためのstubを返す。
`RingVNode<E>`	`getVNode(Comparable<?> rawkey)` get RingVNode instance (for debugging only)
`boolean`	`isActive()`
`Condition`	`newCondition()`
`protected RingVNode<E>`	`newVNode(Comparable<?> rawkey, Object... params)`
`void`	`offline()`
`void`	`online()`
`boolean`	`removeKey(Comparable<?> rawkey)` remove a key from the ring.
`void`	`replyMsgReceived(ReplyMessage sgReplyMessage)`
`void`	`requestMsgReceived(RequestMessage sgMessage)` one-way RPCs
`void`	`rtLockR()`
`void`	`rtLockW()`
`void`	`rtUnlockR()`
`void`	`rtUnlockW()`
`ScheduledFuture<?>`	`schedule(Runnable task, long delay)`
`ScheduledFuture<?>`	`schedule(Runnable task, long delay, long period)`
`void`	`schedule(TimerTask task, long delay)` 非推奨です。
`void`	`schedule(TimerTask task, long delay, long period)` 非推奨です。
`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, getTransport, invokeInReceive, isOnline, newMethodCall, 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

- フィールドの詳細
  - logger
```
protected static final org.slf4j.Logger logger
```
  - DEFAULT_TRANSPORT_ID
```
public static TransportId DEFAULT_TRANSPORT_ID
```
  - transId
```
public final TransportId transId
```
  - keyComp
```
protected static final KeyComparator keyComp
```
  - manager
```
protected NodeManager manager
```
    DDLL node manager
  - myLocator
```
protected E extends Endpoint myLocator
```
  - peerId
```
protected final PeerId peerId
```
  - keyHash
```
protected NavigableMap<Comparable<?>,RingVNode<E extends Endpoint>> keyHash
```
  - rand
```
protected Random rand
```
  - msgframe
```
protected final MessagingFramework msgframe
```
  - statman
```
protected final StatManager statman
```
  - DDLL_CHECK_PERIOD_L0
```
public static int DDLL_CHECK_PERIOD_L0
```
    DDLL's left node check period for level 0 (msec)
  - RPC_TIMEOUT
```
public static int RPC_TIMEOUT
```
- コンストラクタの詳細
  - RingManager
```
public RingManager(TransportId transId,
                   ChannelTransport<E> trans)
            throws IdConflictException,
                   IOException
```
    create a Chord# instance.
    
    パラメータ:
    
    transId - transportId
    
    trans - underlying transport
    
    例外:
    
    IdConflictException - the exception for id confliction.
    
    IOException - the exeption for I/O error.
- メソッドの詳細
  - online
```
public void online()
```
    オーバーライド:
    
    online クラス内 RPCInvoker<RingIf,E extends Endpoint>
  - offline
```
public void offline()
```
    オーバーライド:
    
    offline クラス内 RPCInvoker<RingIf,E extends Endpoint>
  - fin
```
public void fin()
```
    オーバーライド:
    
    fin クラス内 RPCInvoker<RingIf,E extends Endpoint>
  - isActive
```
public boolean isActive()
```
  - rtLockR
```
public void rtLockR()
```
  - rtUnlockR
```
public void rtUnlockR()
```
  - rtLockW
```
public void rtLockW()
```
  - rtUnlockW
```
public void rtUnlockW()
```
  - newCondition
```
public Condition newCondition()
```
  - checkLocked
```
public void checkLocked()
```
  - getStub
```
public RingIf getStub(E addr,
                      int rpcTimeout)
```
    クラスからコピーされた説明: RPCInvoker
    
    リモートピア上のこのオブジェクトに対応するRPCInvokerオブジェクトのメソッドを呼び出すためのstubを返す。
    
    オーバーライド:
    
    getStub クラス内 RPCInvoker<RingIf,E extends Endpoint>
    
    パラメータ:
    
    addr - リモートピアを示すEndpoint
    
    rpcTimeout - timeout値（msec）
    
    戻り値:
    
    RPCのためのstub
  - getStub
```
public RingIf getStub(Endpoint dst)
```
    クラスからコピーされた説明: RPCInvoker
    
    リモートピア上のこのオブジェクトに対応するRPCInvokerオブジェクトのメソッドを呼び出すためのstubを返す。
    
    オーバーライド:
    
    getStub クラス内 RPCInvoker<RingIf,E extends Endpoint>
    
    パラメータ:
    
    dst - リモートピアを示すEndpoint
    
    戻り値:
    
    RPCのためのstub
  - schedule
```
@Deprecated
public void schedule(TimerTask task,
                                 long delay)
```
    非推奨です。
  - schedule
```
public ScheduledFuture<?> schedule(Runnable task,
                                   long delay)
```
  - schedule
```
@Deprecated
public void schedule(TimerTask task,
                                 long delay,
                                 long period)
```
    非推奨です。
  - schedule
```
public ScheduledFuture<?> schedule(Runnable task,
                                   long delay,
                                   long period)
```
  - getPeerId
```
public PeerId getPeerId()
```
    get PeerId
    
    戻り値:
    
    PeerId
  - allVNodes
```
public Collection<? extends RingVNode<E>> allVNodes()
```
    get all RingVNode instances
    
    戻り値:
    
    collection of RingVNode
  - allValidVNodes
```
public List<? extends RingVNode<E>> allValidVNodes()
```
    get all inserted RingVNode instances
    
    戻り値:
    
    collection of RingVNode
  - getVNode
```
public RingVNode<E> getVNode(Comparable<?> rawkey)
```
    get RingVNode instance (for debugging only)
    
    パラメータ:
    
    rawkey - the raw key.
    
    戻り値:
    
    RingVNode the ring node.
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - toStringShort
```
public String toStringShort()
```
  - newVNode
```
protected RingVNode<E> newVNode(Comparable<?> rawkey,
                                Object... params)
```
    パラメータ:
    
    rawkey - the rawkey
    
    params - parameters.
    
    戻り値:
    
    the RingVNode object.
  - showTable
```
public String showTable()
```
    get a the routing table in plain text format.
    
    戻り値:
    
    routing table
  - getAvailableLinks
```
protected NavigableMap<DdllKey,Link> getAvailableLinks()
```
    gather all links from all virtual nodes.
    
    戻り値:
    
    all links from all SGNodes.
  - getLocalLinks
```
public Link[] getLocalLinks()
```
    定義:
    
    getLocalLinks インタフェース内 RingIf
  - addKey
```
protected boolean addKey(Comparable<?> rawkey)
                  throws IOException,
                         UnavailableException
```
    add a key to the ring.
    
    パラメータ:
    
    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 ring.
    同一キーは複数登録できない． 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
  - addKey
```
protected boolean addKey(E introducer,
                         Comparable<?> rawkey,
                         Object... vnodeParams)
                  throws UnavailableException,
                         IOException
```
    例外:
    
    UnavailableException
    
    IOException
  - removeKey
```
public boolean removeKey(Comparable<?> rawkey)
                  throws IOException
```
    remove a key from the ring.
    
    パラメータ:
    
    rawkey - the key
    
    戻り値:
    
    true if the key was successfully removed
    
    例外:
    
    IOException - thrown if some I/O error occurred.
  - find
```
public Node.InsertPoint find(E introducer,
                             DdllKey key,
                             boolean accurate,
                             Object query,
                             TransOptions opts)
                      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)
    
    query - non-null if NO_RESPONSE
    
    opts - the transport options.
    
    戻り値:
    
    the insertion point for `key'
    
    例外:
    
    UnavailableException - 自ノードあるいはseedにkeyが登録されていない
    
    IOException - communication error
  - findImmedNeighbors
```
public Node.InsertPoint findImmedNeighbors(E introducer,
                                           DdllKey key,
                                           Object query,
                                           TransOptions opts)
                                    throws UnavailableException,
                                           IOException
```
    Find the contact nodes (the immediate left and right node) for inserting a node.
    
    パラメータ:
    
    introducer - an introducer node
    
    key - a DDLL key to be searched
    
    query - the query object.
    
    opts - the transport options.
    
    戻り値:
    
    an InsertPoint. null if there's no existing node.
    
    例外:
    
    IOException - the exception thrown when an I/O error occurred.
    
    UnavailableException - the exception thrown when the insert point is unavailable.
  - getClosestLinks
```
public Link[] getClosestLinks(DdllKey key)
                       throws UnavailableException
```
    get the closest left and right links of `key' in the local routing table.
    
    定義:
    
    getClosestLinks インタフェース内 RingIf
    
    パラメータ:
    
    key - the key
    
    戻り値:
    
    the immediate left and right links of `key'
    
    例外:
    
    UnavailableException - thrown if no key is available at the local routing table
  - findLeftLink
```
public Link findLeftLink(DdllKey key)
                  throws UnavailableException
```
    find the closest left link of `key' from the local routing table.
    
    パラメータ:
    
    key - the key
    
    戻り値:
    
    the immediate left link of `key'
    
    例外:
    
    UnavailableException - thrown if no key is available at the local routing table
  - fixRoutingTables
```
public void fixRoutingTables(Collection<Link> failedNodes,
                             RQMessage parentMsg,
                             Collection<CircularRange<DdllKey>> ranges)
```
  - getRequestMessageById
```
public RequestMessage getRequestMessageById(int replyId)
```
  - requestMsgReceived
```
public void requestMsgReceived(RequestMessage sgMessage)
```
    one-way RPCs
    
    定義:
    
    requestMsgReceived インタフェース内 RingIf
  - replyMsgReceived
```
public void replyMsgReceived(ReplyMessage sgReplyMessage)
```
    定義:
    
    replyMsgReceived インタフェース内 RingIf
  - ackReceived
```
public void ackReceived(int msgId,
                        AckMessage ackMessage)
```
    定義:
    
    ackReceived インタフェース内 RingIf

クラス RingManager<E extends Endpoint>

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

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

フィールドのサマリー

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

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

メソッドのサマリー

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

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

フィールドの詳細

logger

DEFAULT_TRANSPORT_ID

transId

keyComp

manager

myLocator

peerId

keyHash

rand

msgframe

statman

DDLL_CHECK_PERIOD_L0

RPC_TIMEOUT

コンストラクタの詳細

RingManager

メソッドの詳細

online

offline

fin

isActive

rtLockR

rtUnlockR

rtLockW

rtUnlockW

newCondition

checkLocked

getStub

getStub

schedule

schedule

schedule

schedule

getPeerId

allVNodes

allValidVNodes

getVNode

toString

toStringShort

newVNode

showTable

getAvailableLinks

getLocalLinks

addKey

addKey

addKey

removeKey

find

findImmedNeighbors

getClosestLinks

findLeftLink

fixRoutingTables

getRequestMessageById

requestMsgReceived

replyMsgReceived

ackReceived