RingVNode (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.gtrans.ov.ring.RingVNode<E>

型パラメータ:

E - the type of Endpoint in the underlying network.

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

NodeObserver

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

RQVNode
```
public class RingVNode<E extends Endpoint>
extends Object
implements NodeObserver
```
a virtual node in simple ring network.

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

ネストされたクラス
修飾子とタイプクラスと説明

static class RingVNode.VNodeMode
mode of DdllRingVNode

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`RingVNode.VNodeMode` mode of DdllRingVNode

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static boolean`	`DDLL_OPT` true to turn on DDLL-OPT
`static int`	`DDLL_RETRY_INTERVAL`
`protected Node`	`ddllNode`
`static int`	`DEFAULT_DDLL_CHECK_PERIOD`
`protected DdllKey`	`key`
`protected RingManager<E>`	`manager`
`protected RingVNode.VNodeMode`	`mode`
`static int`	`NUMBER_OF_DDLL_RETRY`

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

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

RingVNode(RingManager<E> rman, Comparable<?> rawkey)
create a RingVNode instance.

コンストラクタ
コンストラクタと説明
`RingVNode(RingManager<E> rman, Comparable<?> rawkey)` create a RingVNode instance.

メソッドのサマリー

All Methods Static Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected boolean`	`addKey(E introducer)` insert a key into a ring.
`void`	`fixLeftLinks(Link link, List<Link> failedLinks, RQMessage msg, List<CircularRange<DdllKey>> failedRanges)`
`Link[]`	`getAllLinks()`
`protected static int`	`getCheckPeriod()`
`Node`	`getDdllNode()`
`DdllKey`	`getKey()` get DdllKey
`Link`	`getLocalLink()`
`RingManager<E>`	`getManager()`
`RingVNode.VNodeMode`	`getMode()`
`Link`	`getPredecessor()`
`Comparable<?>`	`getRawKey()` get raw key
`Link`	`getSuccessor()`
`boolean`	`isInserted()`
`boolean`	`onNodeFailure(Collection<Link> failedLinks)` called when node failure is detected by DDLL's node monitor.
`void`	`onRightNodeChange(Link prevRight, Link newRight, Object payload)` called when the right link is changed by receiving a SetR message.
`void`	`payloadNotSent(Object payload)` called when the payload given via `Node.setR(Link, int, Link, Link, LinkNum, int, Object)` is not passed to the specified remote node.
`protected boolean`	`removeKey()`
`protected void`	`rtLockR()`
`protected void`	`rtLockW()`
`protected void`	`rtUnlockR()`
`protected void`	`rtUnlockW()`
`List<Link>`	`suppplyLeftCandidatesForFix()`
`String`	`toString()`
`String`	`toStringRoutingTable()`

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

- フィールドの詳細
  - DEFAULT_DDLL_CHECK_PERIOD
```
public static final int DEFAULT_DDLL_CHECK_PERIOD
```
    関連項目:
    
    定数フィールド値
  - NUMBER_OF_DDLL_RETRY
```
public static final int NUMBER_OF_DDLL_RETRY
```
    関連項目:
    
    定数フィールド値
  - DDLL_RETRY_INTERVAL
```
public static final int DDLL_RETRY_INTERVAL
```
    関連項目:
    
    定数フィールド値
  - DDLL_OPT
```
public static final boolean DDLL_OPT
```
    true to turn on DDLL-OPT
    
    関連項目:
    
    定数フィールド値
  - manager
```
protected final RingManager<E extends Endpoint> manager
```
  - key
```
protected final DdllKey key
```
  - ddllNode
```
protected Node ddllNode
```
  - mode
```
protected RingVNode.VNodeMode mode
```
- コンストラクタの詳細
  - RingVNode
```
public RingVNode(RingManager<E> rman,
                 Comparable<?> rawkey)
```
    create a RingVNode instance.
    
    パラメータ:
    
    rman - the p2p network instance that manages this node
    
    rawkey - the key
- メソッドの詳細
  - getCheckPeriod
```
protected static int getCheckPeriod()
```
  - getDdllNode
```
public Node getDdllNode()
```
  - getMode
```
public RingVNode.VNodeMode getMode()
```
  - getLocalLink
```
public Link getLocalLink()
```
  - getSuccessor
```
public Link getSuccessor()
```
  - getPredecessor
```
public Link getPredecessor()
```
  - getAllLinks
```
public Link[] getAllLinks()
```
  - rtLockR
```
protected void rtLockR()
```
  - rtUnlockR
```
protected void rtUnlockR()
```
  - rtLockW
```
protected void rtLockW()
```
  - rtUnlockW
```
protected void rtUnlockW()
```
  - addKey
```
protected boolean addKey(E introducer)
                  throws UnavailableException,
                         IOException
```
    insert a key into a ring.
    
    パラメータ:
    
    introducer - 既に挿入済みのノード
    
    戻り値:
    
    成功したらtrue
    
    例外:
    
    UnavailableException - introducerにkeyが存在しない
    
    IOException - introducerとの通信でエラー or insertion failure
  - removeKey
```
protected boolean removeKey()
```
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - toStringRoutingTable
```
public String toStringRoutingTable()
```
  - isInserted
```
public boolean isInserted()
```
  - getRawKey
```
public Comparable<?> getRawKey()
```
    get raw key
    
    戻り値:
    
    raw key
  - getKey
```
public DdllKey getKey()
```
    get DdllKey
    
    戻り値:
    
    DdllKey
  - getManager
```
public RingManager<E> getManager()
```
  - fixLeftLinks
```
public void fixLeftLinks(Link link,
                         List<Link> failedLinks,
                         RQMessage msg,
                         List<CircularRange<DdllKey>> failedRanges)
```
  - onRightNodeChange
```
public void onRightNodeChange(Link prevRight,
                              Link newRight,
                              Object payload)
```
    インタフェースからコピーされた説明: NodeObserver
    
    called when the right link is changed by receiving a SetR message.
    
    定義:
    
    onRightNodeChange インタフェース内 NodeObserver
    
    パラメータ:
    
    prevRight - the previous right link
    
    newRight - the new right link
    
    payload - an Object passed with SetR message.
    
    関連項目:
    
    Node.setR(Link, int, Link, Link, LinkNum, int, Object)
  - payloadNotSent
```
public void payloadNotSent(Object payload)
```
    インタフェースからコピーされた説明: NodeObserver
    
    called when the payload given via Node.setR(Link, int, Link, Link, LinkNum, int, Object) is not passed to the specified remote node. typically this happens when the SetR request fails.
    
    定義:
    
    payloadNotSent インタフェース内 NodeObserver
    
    パラメータ:
    
    payload - the payload not has been sent
  - onNodeFailure
```
public boolean onNodeFailure(Collection<Link> failedLinks)
```
    インタフェースからコピーされた説明: NodeObserver
    
    called when node failure is detected by DDLL's node monitor. if this method returns true, the DDLL link fixing procedure is executed just after returning from this method. when false is returned, it is application's responsibility to repair the failed link.
    
    定義:
    
    onNodeFailure インタフェース内 NodeObserver
    
    パラメータ:
    
    failedLinks - the collection of failed links.
    
    戻り値:
    
    true to execute DDLL's link fixing procedure
  - suppplyLeftCandidatesForFix
```
public List<Link> suppplyLeftCandidatesForFix()
```
    定義:
    
    suppplyLeftCandidatesForFix インタフェース内 NodeObserver

クラス RingVNode<E extends Endpoint>

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

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

DEFAULT_DDLL_CHECK_PERIOD

NUMBER_OF_DDLL_RETRY

DDLL_RETRY_INTERVAL

DDLL_OPT

manager

key

ddllNode

mode

コンストラクタの詳細

RingVNode

メソッドの詳細

getCheckPeriod

getDdllNode

getMode

getLocalLink

getSuccessor

getPredecessor

getAllLinks

rtLockR

rtUnlockR

rtLockW

rtUnlockW

addKey

removeKey

toString

toStringRoutingTable

isInserted

getRawKey

getKey

getManager

fixLeftLinks

onRightNodeChange

payloadNotSent

onNodeFailure

suppplyLeftCandidatesForFix