From commits-return-6596-archive-asf-public=cust-asf.ponee.io@zookeeper.apache.org Mon Jul 16 06:30:07 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id 6F3BA1807B4 for ; Mon, 16 Jul 2018 06:30:05 +0200 (CEST) Received: (qmail 65715 invoked by uid 500); 16 Jul 2018 04:30:03 -0000 Mailing-List: contact commits-help@zookeeper.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@zookeeper.apache.org Delivered-To: mailing list commits@zookeeper.apache.org Received: (qmail 63659 invoked by uid 99); 16 Jul 2018 04:30:01 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 16 Jul 2018 04:30:01 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id E7BB0E10B5; Mon, 16 Jul 2018 04:30:00 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: hanm@apache.org To: commits@zookeeper.apache.org Date: Mon, 16 Jul 2018 04:30:15 -0000 Message-Id: <9da980236a4c42258fd35d2e6a4f956f@git.apache.org> In-Reply-To: <3c3ee512583b41229bdb3c29e4baa35f@git.apache.org> References: <3c3ee512583b41229bdb3c29e4baa35f@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [16/51] [partial] zookeeper git commit: Website update for release 3.4.13. http://git-wip-us.apache.org/repos/asf/zookeeper/blob/c9914857/content/build/docs/api/org/apache/zookeeper/client/StaticHostProvider.html ---------------------------------------------------------------------- diff --git a/content/build/docs/api/org/apache/zookeeper/client/StaticHostProvider.html b/content/build/docs/api/org/apache/zookeeper/client/StaticHostProvider.html new file mode 100644 index 0000000..1be8684 --- /dev/null +++ b/content/build/docs/api/org/apache/zookeeper/client/StaticHostProvider.html @@ -0,0 +1,372 @@ + + + + + +StaticHostProvider (ZooKeeper 3.4.13 API) + + + + + + + + +

+ + +

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.zookeeper.client.StaticHostProvider
+

+
+
All Implemented Interfaces:
+
HostProvider
+
+
+
+
```
@InterfaceAudience.Public
+public final class StaticHostProvider
+extends java.lang.Object
+implements HostProvider
```
+
Most simple HostProvider, resolves on every next() call. + + Please be aware that although this class doesn't do any DNS caching, there're multiple levels of caching already + present across the stack like in JVM, OS level, hardware, etc. The best we could do here is to get the most recent + address from the underlying system which is considered up-to-date.
+

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + +

Constructors
Constructor and Description
`StaticHostProvider(java.util.Collection<java.net.InetSocketAddress> serverAddresses)` + Constructs a SimpleHostSet. +
`StaticHostProvider(java.util.Collection<java.net.InetSocketAddress> serverAddresses, + org.apache.zookeeper.client.StaticHostProvider.Resolver resolver)` + Introduced for testing purposes. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.net.InetSocketAddress`	`next(long spinDelay)` + The next host to try to connect to. +
`void`	`onConnected()` + Notify the HostProvider of a successful connection. +
`int`	`size()`

+ + +
Methods inherited from class java.lang.Object
+equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    StaticHostProvider
    +
```
public StaticHostProvider(java.util.Collection<java.net.InetSocketAddress> serverAddresses)
```
    +
    Constructs a SimpleHostSet.
    +
    +
    Parameters:
    +
    serverAddresses - possibly unresolved ZooKeeper server addresses
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if serverAddresses is empty or resolves to an empty list
    +
    +
  + + + +
  - +
    StaticHostProvider
    +
```
public StaticHostProvider(java.util.Collection<java.net.InetSocketAddress> serverAddresses,
+                          org.apache.zookeeper.client.StaticHostProvider.Resolver resolver)
```
    +
    Introduced for testing purposes. getAllByName() is a static method of InetAddress, therefore cannot be easily mocked. + By abstraction of Resolver interface we can easily inject a mocked implementation in tests.
    +
    +
    Parameters:
    +
    serverAddresses - possibly unresolved ZooKeeper server addresses
    +
    resolver - custom resolver implementation
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if serverAddresses is empty or resolves to an empty list
    +
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    size
    +
```
public int size()
```
    +
    +
    Specified by:
    +
    size in interface HostProvider
    +
    +
  + + + +
  - +
    next
    +
```
public java.net.InetSocketAddress next(long spinDelay)
```
    +
    Description copied from interface: HostProvider
    +
    The next host to try to connect to. + + For a spinDelay of 0 there should be no wait.
    +
    +
    Specified by:
    +
    next in interface HostProvider
    +
    Parameters:
    +
    spinDelay - Milliseconds to wait if all hosts have been tried once.
    +
    Returns:
    +
    The next host to try to connect to with resolved address. If the host is not resolvable, the unresolved + address will be returned.
    +
    +
  + + + +
  - +
    onConnected
    +
```
public void onConnected()
```
    +
    Description copied from interface: HostProvider
    +
    Notify the HostProvider of a successful connection. + + The HostProvider may use this notification to reset it's inner state.
    +
    +
    Specified by:
    +
    onConnected in interface HostProvider
    +
    +
  +
+

+ + +

Class	Description
FourLetterWordMain
StaticHostProvider	+ Most simple HostProvider, resolves on every next() call. +

Modifier and Type	Method and Description
`int`	`compareTo(java.lang.Object peer_)`
`void`	`deserialize(org.apache.jute.InputArchive a_, + java.lang.String tag)`
`boolean`	`equals(java.lang.Object peer_)`
`Id`	`getId()`
`int`	`getPerms()`
`int`	`hashCode()`
`void`	`readFields(java.io.DataInput in)`
`void`	`serialize(org.apache.jute.OutputArchive a_, + java.lang.String tag)`
`void`	`setId(Id m_)`
`void`	`setPerms(int m_)`
`static java.lang.String`	`signature()`
`java.lang.String`	`toString()`
`void`	`write(java.io.DataOutput out)`

Constructors
Constructor and Description
`ACL()`
`ACL(int perms, + Id id)`

Class StaticHostProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StaticHostProvider

StaticHostProvider

Method Detail

size

next

onConnected

Uses of Classorg.apache.zookeeper.client.FourLetterWordMain

Uses of Interfaceorg.apache.zookeeper.client.HostProvider

Uses of HostProvider in org.apache.zookeeper.client

Uses of Classorg.apache.zookeeper.client.StaticHostProvider

org.apache.zookeeper.client

Interfaces

Classes

Package org.apache.zookeeper.client

Hierarchy For Package org.apache.zookeeper.client

Class Hierarchy

Interface Hierarchy

Uses of Packageorg.apache.zookeeper.client

org.apache.zookeeper.common

Package org.apache.zookeeper.common

Hierarchy For Package org.apache.zookeeper.common

Uses of Packageorg.apache.zookeeper.common

Class ACL

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ACL

ACL

Method Detail

getPerms

setPerms

getId

setId

serialize

deserialize

toString

write

readFields

compareTo

equals

hashCode

signature

Uses of Class
org.apache.zookeeper.client.FourLetterWordMain

Uses of Interface
org.apache.zookeeper.client.HostProvider

Uses of Class
org.apache.zookeeper.client.StaticHostProvider

Uses of Package
org.apache.zookeeper.client

Uses of Package
org.apache.zookeeper.common