Uses of Class de.zib.scalaris.PeerNode
Date: 2016-02-29

## Uses of Class
de.zib.scalaris.PeerNode

- Packages that use PeerNode
  Package | Description
  --- | ---
  de.zib.scalaris | This package contains means to communicate with the erlang scalaris ring from Java.

- - ### Uses of PeerNode in de.zib.scalaris

    Methods in de.zib.scalaris that return PeerNode
    Modifier and Type | Method and Description
    --- | ---
    `PeerNode` | Connection.`getRemote()` Gets the remote node connected to.
    `PeerNode` | ConnectionPolicy.`selectNode()` Selects the node to connect with when establishing a connection (no failed node, no exception that has already been thrown).
    `abstract <E extends Exception> PeerNode` | ConnectionPolicy.`selectNode(int retry, PeerNode failedNode, E e)` Selects the node to (re-)connect with.
    `<E extends Exception> PeerNode` | DefaultConnectionPolicy.`selectNode(int retry, PeerNode failedNode, E e)` Selects the node to (re-)connect with until the maximal number of `DefaultConnectionPolicy.maxRetries` has been reached.
    `<E extends Exception> PeerNode` | FixedNodeConnectionPolicy.`selectNode(int retry, PeerNode failedNode, E e)`

    Methods in de.zib.scalaris that return types with arguments of type PeerNode
    Modifier and Type | Method and Description
    --- | ---
    `List<PeerNode>` | DefaultConnectionPolicy.`getBadNodes()` Gets a copy of the list of good nodes (contains references to the `PeerNode` objects).
    `List<PeerNode>` | DefaultConnectionPolicy.`getGoodNodes()` Gets a copy of the list of good nodes (contains references to the `PeerNode` objects).
    `List<PeerNode>` | ConnectionFactory.`getNodes()` Gets a copy of the list of nodes available for connections.

    Methods in de.zib.scalaris with parameters of type PeerNode
    Modifier and Type | Method and Description
    --- | ---
    `void` | ConnectionFactory.`addNode(PeerNode node)` Adds a node to the set of nodes available for connections.
    `void` | ConnectionPolicy.`availableNodeAdded(PeerNode newNode)` Signals the connection policy that the given node has been added to the list of available nodes.
    `void` | DefaultConnectionPolicy.`availableNodeAdded(PeerNode newNode)` Adds the given node to the `DefaultConnectionPolicy.goodNodes` list if it has no failures, otherwise it will be added to `DefaultConnectionPolicy.badNodes`.
    `void` | ConnectionPolicy.`availableNodeRemoved(PeerNode removedNode)` Signals the connection policy that the given node has been removed from the list of available nodes.
    `void` | DefaultConnectionPolicy.`availableNodeRemoved(PeerNode removedNode)` Removes the node from the `DefaultConnectionPolicy.goodNodes` and `DefaultConnectionPolicy.badNodes` lists.
    `void` | ConnectionPolicy.`nodeConnectSuccess(PeerNode node)` Acts upon a successful connect attempt of the given node.
    `void` | DefaultConnectionPolicy.`nodeConnectSuccess(PeerNode node)` Sets the node's last successful connect time stamp, resets its failure statistics and moves it to the `DefaultConnectionPolicy.goodNodes` list.
    `void` | ConnectionPolicy.`nodeFailed(PeerNode node)` Acts upon a failure of the given node.
    `void` | DefaultConnectionPolicy.`nodeFailed(PeerNode node)` Sets the given node's last failed connect time stamp and moves it to the `DefaultConnectionPolicy.badNodes` list.
    `void` | ConnectionPolicy.`nodeFailReset(PeerNode node)` Acts upon a failure reset of the given node.
    `void` | DefaultConnectionPolicy.`nodeFailReset(PeerNode node)` Acts upon a failure reset of the given node.
    `void` | ConnectionFactory.`removeNode(PeerNode node)` Removes a node from the set of nodes available for connections.
    `abstract <E extends Exception> PeerNode` | ConnectionPolicy.`selectNode(int retry, PeerNode failedNode, E e)` Selects the node to (re-)connect with.
    `<E extends Exception> PeerNode` | DefaultConnectionPolicy.`selectNode(int retry, PeerNode failedNode, E e)` Selects the node to (re-)connect with until the maximal number of `DefaultConnectionPolicy.maxRetries` has been reached.
    `<E extends Exception> PeerNode` | FixedNodeConnectionPolicy.`selectNode(int retry, PeerNode failedNode, E e)`
    `void` | ConnectionFactory.`setNode(PeerNode node)` Sets the name of the node to connect to.

    Method parameters in de.zib.scalaris with type arguments of type PeerNode
    Modifier and Type | Method and Description
    --- | ---
    `void` | ConnectionPool.`closeAllBut(Collection<PeerNode> remainingNodes)` Closes all available pooled connections to any node not in the given collection.

    Constructors in de.zib.scalaris with parameters of type PeerNode
    Constructor and Description
    `Connection(OtpSelf self, PeerNode remote)` Creates a new connection using the given nodes and a default connection policy.
    `ConnectionPolicy(PeerNode remoteNode)` Creates a connection policy with one available node to connect to.
    `DefaultConnectionPolicy(PeerNode remoteNode)` Creates a new connection policy working with the given remote node.
    `FixedNodeConnectionPolicy(PeerNode remoteNode)` Creates a new connection policy working with the given remote node.
    `RoundRobinConnectionPolicy(PeerNode remoteNode)` Creates a new connection policy working with the given remote node.
    `ScalarisVM(PeerNode node)` Creates a connection to the erlang VM of the given Scalaris node.

    Constructor parameters in de.zib.scalaris with type arguments of type PeerNode
    Constructor and Description
    `ConnectionPolicy(List<PeerNode> availableRemoteNodes)` Creates a connection policy with the given set of nodes available for connections.
    `DefaultConnectionPolicy(List<PeerNode> availableRemoteNodes)` Creates a new connection policy with the given remote nodes.
    `RoundRobinConnectionPolicy(List<PeerNode> availableRemoteNodes)` Creates a new connection policy with the given remote nodes.