Node (PIAX GTrans 3.1.0 API)

java.lang.Object
- org.piax.gtrans.ov.ddll.Node

```
public class Node
extends Object
```
a DDLL node.
this class contains an implementation of DDLL protocol.

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

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`Node.InsertionResult` a class representing a result of insertion.
`static class`	`Node.InsertPoint` a class representing an insertion point in a linked-list.
`static class`	`Node.Mode` DDLL node state

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`DEFAULT_CHECK_PERIOD` fix処理を定期実行するための基準となる周期 (msec)
`static int`	`DEFAULT_TIMEOUT`
`static int`	`DELETE_OP_TIMEOUT`
`static int`	`GETSTAT_OP_TIMEOUT` timeout for a response of GetStat message in msec. if the left node does not respond within this period, the left node is considered failed.
`static int`	`INS_DEL_RETRY_INTERVAL_BASE`
`static int`	`MIN_FIX_INTERVAL` minimum interval of fixing To avoid rush of fixing, make minimum interval between fixing.
`static int`	`SEARCH_OP_TIMEOUT`
`static int`	`SETR_TIMEOUT`

メソッドのサマリー

All Methods Static Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`boolean`	`delete(int maxRetry)` delete this node from the linked-list.
`protected boolean`	`delete0()` delete this node from the linked-list.
`void`	`fin()`
`void`	`findNearest(Link sender, int reqNo, DdllKey searchKey, Link prevKey)`
`DdllKey`	`getKey()`
`Link`	`getLeft()`
`Node.Mode`	`getMode()`
`Link`	`getMyLink()`
`List<Link>`	`getNeighborSet()`
`Link`	`getRight()`
`void`	`getStat(Link sender, int reqNo)`
`static void`	`initializeConnectedNodes(List<Node> list)`
`Node.InsertionResult`	`insert(Link introducer, int maxRetry)` insert this node to a linked-list by specifying an introducer node, which is an arbitrary node that has been inserted to the linked-list.
`Node.InsertionResult`	`insert(Node.InsertPoint pos)` insert this node to a linked-list by specifying the immediate left and right nodes.
`protected Node.InsertionResult`	`insert0(Node.InsertPoint p)` insert a node between two nodes specified by an `Node.InsertPoint` instance.
`void`	`insertAsInitialNode()` Insert this node as the initial node.
`boolean`	`isBetween(DdllKey a, DdllKey c)`
`boolean`	`isOnline()`
`static boolean`	`isOrdered(Comparable<?> from, boolean fromInclusive, Comparable<?> val, Comparable<?> to, boolean toInclusive)`
`static boolean`	`isOrdered(Comparable<?> a, Comparable<?> b, Comparable<?> c)`
`void`	`lock()`
`void`	`offline()` inactivate the protocol.
`void`	`online()` activate the protocol.
`void`	`reset()` forcibly delete this node without notifying other nodes
`void`	`setCheckPeriod(int period)`
`void`	`setFindNext(int reqNo, Link next, Link prevKey)`
`void`	`setFindResult(int reqNo, Link left, Link right)`
`void`	`setL(Link lNew, LinkNum lNewNum, Link prevL, Set<Link> nbrs)`
`protected void`	`setLeft(Link left)`
`protected void`	`setLeftNum(LinkNum lNum)`
`protected void`	`setMode(Node.Mode mode)`
`void`	`setR(Link sender, int reqNo, Link rNew, Link rCur, LinkNum rNewNum, int type, Object payload)` SetR message handler.
`void`	`setRAck(Link sender, int reqNo, LinkNum zNum, Set<Link> nbrs)` SetRAck message handler.
`protected void`	`setRef(int r)`
`protected void`	`setRight(Link right)`
`protected void`	`setRightNum(LinkNum rNum)`
`void`	`setRNak(Link sender, int reqNo, Link curR)` SetRNak message handler.
`void`	`startFix(Collection<Link> failedLinks)` start fixing set of failed links.
`void`	`startfix(Collection<Link> failedLinks, Object payload)`
`void`	`startfix(Collection<Link> failedLinks, Object payload, boolean force)` start fixing `failedLinks'.
`void`	`startFix(Link failed)`
`void`	`startFix(Link failed, boolean force)` start fixing a single failed link.
`String`	`toString()`
`void`	`unlock()`
`void`	`unrefL(Link sender)`

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

フィールドの詳細
- DEFAULT_TIMEOUT
```
public static int DEFAULT_TIMEOUT
```
- SETR_TIMEOUT
```
public static int SETR_TIMEOUT
```
- DELETE_OP_TIMEOUT
```
public static int DELETE_OP_TIMEOUT
```
- SEARCH_OP_TIMEOUT
```
public static int SEARCH_OP_TIMEOUT
```
- GETSTAT_OP_TIMEOUT
```
public static int GETSTAT_OP_TIMEOUT
```
  timeout for a response of GetStat message in msec. if the left node does not respond within this period, the left node is considered failed. TODO: change timeout adaptively
- INS_DEL_RETRY_INTERVAL_BASE
```
public static final int INS_DEL_RETRY_INTERVAL_BASE
```
  関連項目:
  
  定数フィールド値
- MIN_FIX_INTERVAL
```
public static int MIN_FIX_INTERVAL
```
  minimum interval of fixing To avoid rush of fixing, make minimum interval between fixing.
- DEFAULT_CHECK_PERIOD
```
public static int DEFAULT_CHECK_PERIOD
```
  fix処理を定期実行するための基準となる周期 (msec)

メソッドの詳細

online
```
public void online()
```
activate the protocol.

offline
```
public void offline()
```
inactivate the protocol.

isOnline
```
public boolean isOnline()
```

fin
```
public void fin()
```

getMyLink
```
public Link getMyLink()
```

getKey
```
public DdllKey getKey()
```

getMode
```
public Node.Mode getMode()
```

setMode

protected void setMode(Node.Mode mode)

setCheckPeriod

public void setCheckPeriod(int period)

setLeft
```
protected void setLeft(Link left)
```

setLeftNum

protected void setLeftNum(LinkNum lNum)

getLeft
```
public Link getLeft()
```

getRight
```
public Link getRight()
```

setRight
```
protected void setRight(Link right)
```

setRightNum

protected void setRightNum(LinkNum rNum)

setRef
```
protected void setRef(int r)
```

getNeighborSet
```
public List<Link> getNeighborSet()
```

toString
```
public String toString()
```
オーバーライド:

toString クラス内 Object

reset
```
public void reset()
```
forcibly delete this node without notifying other nodes

lock
```
public void lock()
```

unlock
```
public void unlock()
```

isOrdered

public static boolean isOrdered(Comparable<?> a,
                                Comparable<?> b,
                                Comparable<?> c)

isOrdered

public static boolean isOrdered(Comparable<?> from,
                                boolean fromInclusive,
                                Comparable<?> val,
                                Comparable<?> to,
                                boolean toInclusive)

isBetween

public boolean isBetween(DdllKey a,
                         DdllKey c)

insertAsInitialNode
```
public void insertAsInitialNode()
```
Insert this node as the initial node. This node becomes the first node in the network.

initializeConnectedNodes

public static void initializeConnectedNodes(List<Node> list)

insert
```
public Node.InsertionResult insert(Link introducer,
                                   int maxRetry)
                            throws IllegalStateException
```
insert this node to a linked-list by specifying an introducer node, which is an arbitrary node that has been inserted to the linked-list.
note that this method may take O(N) steps for finding proper insertion point and thus, should not be used for large linked-list.

パラメータ:

introducer - some node that has been inserted to a linked-list

maxRetry - max retry count

戻り値:

insertion result

例外:

IllegalStateException - thrown if the node is already inserted

insert
```
public Node.InsertionResult insert(Node.InsertPoint pos)
                            throws IllegalStateException
```
insert this node to a linked-list by specifying the immediate left and right nodes.
note that this method does not retry insertion when failed.

パラメータ:

pos - the insert point, which contains the immediate left and right node of this node.

戻り値:

insertion result

例外:

IllegalStateException - thrown if the node is already inserted

insert0
```
protected Node.InsertionResult insert0(Node.InsertPoint p)
```
insert a node between two nodes specified by an Node.InsertPoint instance.

パラメータ:

p - insertion point

戻り値:

true if successfully inserted, false otherwise

delete
```
public boolean delete(int maxRetry)
               throws IllegalStateException
```
delete this node from the linked-list. if the DDLL protocol fails to delete this node after maxRetry retries, the node is forcibly deleted and returns false.

パラメータ:

maxRetry - max retry

戻り値:

true if successfully deleted

例外:

IllegalStateException - thrown if node is not inserted

delete0
```
protected boolean delete0()
                   throws OfflineSendException
```
delete this node from the linked-list.

戻り値:

true if successfully deleted

例外:

OfflineSendException - thrown if this node is offline

setR

public void setR(Link sender,
                 int reqNo,
                 Link rNew,
                 Link rCur,
                 LinkNum rNewNum,
                 int type,
                 Object payload)

SetR message handler.

 pseudo code:
 (A2)
 receive SetR(rnew , rcur , rnewnum , incr) from q →
   if ((s  ̸= in ∧ s  ̸= lwait) ∨ r  ̸= rcur) then send SetRNak() to q
 else send SetRAck(rnum) to q; r, rnum, ref := rnew, rnewnum, ref + incr fi

パラメータ:: sender - the sender of this SetR message; reqNo - request number; rNew - the new right link number; rCur - the current right link that this node should have; rNewNum - the new right link; type - the type of SetR; payload - the optional data transferred along with the SetR message

setRAck

public void setRAck(Link sender,
                    int reqNo,
                    LinkNum zNum,
                    Set<Link> nbrs)

SetRAck message handler.

 pseudo code:
 (A3) receive SetRAck(znum) from q →
   if (s = jng) then s, rnum, ref := in, znum.next(), 1; send SetL(u, rnum, l) to r
     elseif (s = lvg) then s := grace; send SetL(l, rnum.next(), u) to r
     elseif (s = fix) then s := in fi

パラメータ:: sender - the sender of this SetRAck message; reqNo - request number; zNum - the previous right link number of the sender node; nbrs - neighbor node set

setRNak

public void setRNak(Link sender,
                    int reqNo,
                    Link curR)

SetRNak message handler.

 pseudo code:
 (A4)
 receive SetRNak() from q →
   if (s = jng) then s := jwait
   elseif (s = lvg) then s := lwait
   elseif (fixing) then fixing := false fi

パラメータ:: sender - the sender of this SetRNak message; reqNo - request number; curR - current right link of the sender node

setL

public void setL(Link lNew,
                 LinkNum lNewNum,
                 Link prevL,
                 Set<Link> nbrs)

unrefL
```
public void unrefL(Link sender)
```

setFindResult

public void setFindResult(int reqNo,
                          Link left,
                          Link right)

setFindNext

public void setFindNext(int reqNo,
                        Link next,
                        Link prevKey)

findNearest

public void findNearest(Link sender,
                        int reqNo,
                        DdllKey searchKey,
                        Link prevKey)

getStat

public void getStat(Link sender,
                    int reqNo)

startFix
```
public void startFix(Link failed,
                     boolean force)
```
start fixing a single failed link.

パラメータ:

failed - the failed link.

force - true if you want to check the left node even if it is not equals to `failed'.

startFix
```
public void startFix(Link failed)
```

startFix
```
public void startFix(Collection<Link> failedLinks)
```
start fixing set of failed links.

パラメータ:

failedLinks - the failed links.

startfix

public void startfix(Collection<Link> failedLinks,
                     Object payload)

startfix
```
public void startfix(Collection<Link> failedLinks,
                     Object payload,
                     boolean force)
```
start fixing `failedLinks'. `payload' is piggy-backed by SetR message if it is non-null.

パラメータ:

failedLinks - the failed links.

payload - the payload object.

force - true if you want to check the left node even if it is not contained in `failedLinks'.

クラス Node

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

フィールドのサマリー

メソッドのサマリー

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

フィールドの詳細

DEFAULT_TIMEOUT

SETR_TIMEOUT

DELETE_OP_TIMEOUT

SEARCH_OP_TIMEOUT

GETSTAT_OP_TIMEOUT

INS_DEL_RETRY_INTERVAL_BASE

MIN_FIX_INTERVAL

DEFAULT_CHECK_PERIOD

メソッドの詳細

online

offline

isOnline

fin

getMyLink

getKey

getMode

setMode

setCheckPeriod

setLeft

setLeftNum

getLeft

getRight

setRight

setRightNum

setRef

getNeighborSet

toString

reset

lock

unlock

isOrdered

isOrdered

isBetween

insertAsInitialNode

initializeConnectedNodes

insert

insert

insert0

delete

delete0

setR

setRAck

setRNak

setL

unrefL

setFindResult

setFindNext

findNearest

getStat

startFix

startFix

startFix

startfix

startfix