XMemcachedClientBuilder (xmemcached 2.0.0 API)

java.lang.Object
- net.rubyeye.xmemcached.XMemcachedClientBuilder

所有已实现的接口:

MemcachedClientBuilder
```
public class XMemcachedClientBuilder
extends Object
implements MemcachedClientBuilder
```
Builder pattern.Configure XmemcachedClient's options,then build it

作者:

dennis

构造器概要

构造器
构造器和说明
`XMemcachedClientBuilder()`
`XMemcachedClientBuilder(List<InetSocketAddress> addressList)`
`XMemcachedClientBuilder(List<InetSocketAddress> addressList, int[] weights)`
`XMemcachedClientBuilder(Map<InetSocketAddress,InetSocketAddress> addressMap)`
`XMemcachedClientBuilder(Map<InetSocketAddress,InetSocketAddress> addressMap, int[] weights)`
`XMemcachedClientBuilder(String addressList)`

方法概要

方法
限定符和类型	方法和说明
`void`	`addAuthInfo(InetSocketAddress address, AuthInfo authInfo)` Add auth info for memcached server
`void`	`addStateListener(MemcachedClientStateListener stateListener)` Add a state listener
`MemcachedClient`	`build()` Build MemcachedClient by current options.
`Map<InetSocketAddress,AuthInfo>`	`getAuthInfoMap()` return current all auth info
`BufferAllocator`	`getBufferAllocator()`
`CommandFactory`	`getCommandFactory()` get xmemcached's command factory
`Configuration`	`getConfiguration()` Return the default networking's configuration,you can change them.
`long`	`getConnectTimeout()` Returns connect timeout in milliseconds
`static Configuration`	`getDefaultConfiguration()`
`static Map<SocketOption,Object>`	`getDefaultSocketOptions()`
`long`	`getHealSessionInterval()`
`int`	`getMaxQueuedNoReplyOperations()`
`String`	`getName()` Return the cache instance name
`long`	`getOpTimeout()` Returns the default operation timeout in milliseconds.
`MemcachedSessionLocator`	`getSessionLocator()`
`Map<SocketOption,Object>`	`getSocketOptions()` Get all tcp socket options
`Transcoder`	`getTranscoder()` Set xmemcached's transcoder,it is used for seriailizing
`boolean`	`isEnableHealSession()`
`boolean`	`isFailureMode()` Returns if client is in failure mode.
`void`	`removeAuthInfo(InetSocketAddress address)` Remove auth info for memcached server
`void`	`removeStateListener(MemcachedClientStateListener stateListener)` Remove a state listener
`void`	`setAuthInfoMap(Map<InetSocketAddress,AuthInfo> authInfoMap)` Configure auth info
`void`	`setBufferAllocator(BufferAllocator bufferAllocator)` Set nio ByteBuffer's allocator.Use SimpleBufferAllocator by default.You can choose CachedBufferAllocator.
`void`	`setCommandFactory(CommandFactory commandFactory)` set xmemcached's command factory.Default is TextCommandFactory,which implements memcached text protocol.
`void`	`setConfiguration(Configuration configuration)` Set the XmemcachedClient's networking configuration(reuseAddr,receiveBufferSize,tcpDelay etc.)
`void`	`setConnectionPoolSize(int poolSize)` In a high concurrent enviroment,you may want to pool memcached clients.But a xmemcached client has to start a reactor thread and some thread pools,if you create too many clients,the cost is very large.
`void`	`setConnectTimeout(long connectTimeout)` Set connect timeout in milliseconds
`void`	`setEnableHealSession(boolean enableHealSession)` If the memcached dump or network error cause connection closed,xmemcached would try to heal the connection.You can disable this behaviour by using this method: `client.setEnableHealSession(false);` The default value is true.
`void`	`setFailureMode(boolean failureMode)` Configure wheather to set client in failure mode.If set it to true,that means you want to configure client in failure mode.
`void`	`setHealSessionInterval(long healSessionInterval)` If the memcached dump or network error cause connection closed,xmemcached would try to heal the connection.The interval between reconnections is 2 seconds by default.
`void`	`setKeyProvider(KeyProvider keyProvider)` Set a key provider for pre-processing keys before sending them to memcached.
`void`	`setMaxQueuedNoReplyOperations(int maxQueuedNoReplyOperations)` Set max queued noreply operations number
`void`	`setName(String name)` Set cache instance name
`void`	`setOpTimeout(long opTimeout)` Set default operation timeout.
`void`	`setSanitizeKeys(boolean sanitizeKeys)` Enables/disables sanitizing keys by URLEncoding.
`void`	`setSessionLocator(MemcachedSessionLocator sessionLocator)` Set the XmemcachedClient's session locator.Use ArrayMemcachedSessionLocator by default.If you want to choose consistent hash strategy,set it to KetamaMemcachedSessionLocator
`void`	`setSocketOption(SocketOption socketOption, Object value)` Set tcp socket option
`void`	`setStateListeners(List<MemcachedClientStateListener> stateListeners)` Set state listeners,replace current list
`void`	`setTranscoder(Transcoder transcoder)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - XMemcachedClientBuilder
```
public XMemcachedClientBuilder(String addressList)
```
  - XMemcachedClientBuilder
```
public XMemcachedClientBuilder(List<InetSocketAddress> addressList)
```
  - XMemcachedClientBuilder
```
public XMemcachedClientBuilder(List<InetSocketAddress> addressList,
                       int[] weights)
```
  - XMemcachedClientBuilder
```
public XMemcachedClientBuilder(Map<InetSocketAddress,InetSocketAddress> addressMap)
```
  - XMemcachedClientBuilder
```
public XMemcachedClientBuilder(Map<InetSocketAddress,InetSocketAddress> addressMap,
                       int[] weights)
```
  - XMemcachedClientBuilder
```
public XMemcachedClientBuilder()
```
- 方法详细资料
  - getOpTimeout
```
public long getOpTimeout()
```
    从接口复制的说明: MemcachedClientBuilder
    
    Returns the default operation timeout in milliseconds.
    
    指定者:
    
    getOpTimeout 在接口中 MemcachedClientBuilder
    
    返回:
  - setOpTimeout
```
public void setOpTimeout(long opTimeout)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set default operation timeout.
    
    指定者:
    
    setOpTimeout 在接口中 MemcachedClientBuilder
    
    参数:
    opTimeout - Operation timeout value in milliseconds.
  - getMaxQueuedNoReplyOperations
```
public int getMaxQueuedNoReplyOperations()
```
  - getHealSessionInterval
```
public long getHealSessionInterval()
```
  - setHealSessionInterval
```
public void setHealSessionInterval(long healSessionInterval)
```
    从接口复制的说明: MemcachedClientBuilder
    
    If the memcached dump or network error cause connection closed,xmemcached would try to heal the connection.The interval between reconnections is 2 seconds by default. You can change that value by this method.
    
    指定者:
    
    setHealSessionInterval 在接口中 MemcachedClientBuilder
    
    参数:
    healSessionInterval - MILLISECONDS
  - isEnableHealSession
```
public boolean isEnableHealSession()
```
  - setEnableHealSession
```
public void setEnableHealSession(boolean enableHealSession)
```
    从接口复制的说明: MemcachedClientBuilder
    
    If the memcached dump or network error cause connection closed,xmemcached would try to heal the connection.You can disable this behaviour by using this method:
    client.setEnableHealSession(false);
    The default value is true.
    
    指定者:
    
    setEnableHealSession 在接口中 MemcachedClientBuilder
  - setMaxQueuedNoReplyOperations
```
public void setMaxQueuedNoReplyOperations(int maxQueuedNoReplyOperations)
```
    Set max queued noreply operations number
    
    指定者:
    
    setMaxQueuedNoReplyOperations 在接口中 MemcachedClientBuilder
    
    参数:
    maxQueuedNoReplyOperations -
    从以下版本开始:
    
    1.3.8
    
    另请参阅:
    MemcachedClient.DEFAULT_MAX_QUEUED_NOPS
  - setSanitizeKeys
```
public void setSanitizeKeys(boolean sanitizeKeys)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Enables/disables sanitizing keys by URLEncoding.
    
    指定者:
    
    setSanitizeKeys 在接口中 MemcachedClientBuilder
  - addStateListener
```
public void addStateListener(MemcachedClientStateListener stateListener)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Add a state listener
    
    指定者:
    
    addStateListener 在接口中 MemcachedClientBuilder
  - setSocketOption
```
public void setSocketOption(SocketOption socketOption,
                   Object value)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set tcp socket option
    
    指定者:
    
    setSocketOption 在接口中 MemcachedClientBuilder
  - getSocketOptions
```
public Map<SocketOption,Object> getSocketOptions()
```
    从接口复制的说明: MemcachedClientBuilder
    
    Get all tcp socket options
    
    指定者:
    
    getSocketOptions 在接口中 MemcachedClientBuilder
    
    返回:
  - setConnectionPoolSize
```
public final void setConnectionPoolSize(int poolSize)
```
    从接口复制的说明: MemcachedClientBuilder
    
    In a high concurrent enviroment,you may want to pool memcached clients.But a xmemcached client has to start a reactor thread and some thread pools,if you create too many clients,the cost is very large. Xmemcached supports connection pool instreadof client pool.you can create more connections to one or more memcached servers,and these connections share the same reactor and thread pools,it will reduce the cost of system.
    
    指定者:
    
    setConnectionPoolSize 在接口中 MemcachedClientBuilder
    
    参数:
    poolSize - pool size,default is 1
  - removeStateListener
```
public void removeStateListener(MemcachedClientStateListener stateListener)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Remove a state listener
    
    指定者:
    
    removeStateListener 在接口中 MemcachedClientBuilder
  - getConnectTimeout
```
public long getConnectTimeout()
```
    从接口复制的说明: MemcachedClientBuilder
    
    Returns connect timeout in milliseconds
    
    指定者:
    
    getConnectTimeout 在接口中 MemcachedClientBuilder
    
    返回:
    connect timeout
  - setConnectTimeout
```
public void setConnectTimeout(long connectTimeout)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set connect timeout in milliseconds
    
    指定者:
    
    setConnectTimeout 在接口中 MemcachedClientBuilder
    
    另请参阅:
    MemcachedClient.DEFAULT_CONNECT_TIMEOUT
  - setStateListeners
```
public void setStateListeners(List<MemcachedClientStateListener> stateListeners)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set state listeners,replace current list
    
    指定者:
    
    setStateListeners 在接口中 MemcachedClientBuilder
  - getDefaultSocketOptions
```
public static final Map<SocketOption,Object> getDefaultSocketOptions()
```
  - getDefaultConfiguration
```
public static final Configuration getDefaultConfiguration()
```
  - isFailureMode
```
public boolean isFailureMode()
```
    从接口复制的说明: MemcachedClientBuilder
    
    Returns if client is in failure mode.
    
    指定者:
    
    isFailureMode 在接口中 MemcachedClientBuilder
    
    返回:
  - setFailureMode
```
public void setFailureMode(boolean failureMode)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Configure wheather to set client in failure mode.If set it to true,that means you want to configure client in failure mode. Failure mode is that when a memcached server is down,it would not taken from the server list but marked as unavailable,and then further requests to this server will be transformed to standby node if configured or throw an exception until it comes back up.
    
    指定者:
    
    setFailureMode 在接口中 MemcachedClientBuilder
    
    参数:
    failureMode - true is to configure client in failure mode.
  - getCommandFactory
```
public final CommandFactory getCommandFactory()
```
    从接口复制的说明: MemcachedClientBuilder
    
    get xmemcached's command factory
    
    指定者:
    
    getCommandFactory 在接口中 MemcachedClientBuilder
    
    返回:
  - setCommandFactory
```
public final void setCommandFactory(CommandFactory commandFactory)
```
    从接口复制的说明: MemcachedClientBuilder
    
    set xmemcached's command factory.Default is TextCommandFactory,which implements memcached text protocol.
    
    指定者:
    
    setCommandFactory 在接口中 MemcachedClientBuilder
  - getSessionLocator
```
public MemcachedSessionLocator getSessionLocator()
```
    指定者:
    
    getSessionLocator 在接口中 MemcachedClientBuilder
    
    返回:
    net.rubyeye.xmemcached.MemcachedSessionLocator
  - setSessionLocator
```
public void setSessionLocator(MemcachedSessionLocator sessionLocator)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set the XmemcachedClient's session locator.Use ArrayMemcachedSessionLocator by default.If you want to choose consistent hash strategy,set it to KetamaMemcachedSessionLocator
    
    指定者:
    
    setSessionLocator 在接口中 MemcachedClientBuilder
  - getBufferAllocator
```
public BufferAllocator getBufferAllocator()
```
    指定者:
    
    getBufferAllocator 在接口中 MemcachedClientBuilder
  - setBufferAllocator
```
public void setBufferAllocator(BufferAllocator bufferAllocator)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set nio ByteBuffer's allocator.Use SimpleBufferAllocator by default.You can choose CachedBufferAllocator.
    
    指定者:
    
    setBufferAllocator 在接口中 MemcachedClientBuilder
  - getConfiguration
```
public Configuration getConfiguration()
```
    从接口复制的说明: MemcachedClientBuilder
    
    Return the default networking's configuration,you can change them.
    
    指定者:
    
    getConfiguration 在接口中 MemcachedClientBuilder
    
    返回:
  - setConfiguration
```
public void setConfiguration(Configuration configuration)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set the XmemcachedClient's networking configuration(reuseAddr,receiveBufferSize,tcpDelay etc.)
    
    指定者:
    
    setConfiguration 在接口中 MemcachedClientBuilder
  - build
```
public MemcachedClient build()
                      throws IOException
```
    从接口复制的说明: MemcachedClientBuilder
    
    Build MemcachedClient by current options.
    
    指定者:
    
    build 在接口中 MemcachedClientBuilder
    
    返回:
    
    抛出:
    
    IOException
  - getTranscoder
```
public Transcoder getTranscoder()
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set xmemcached's transcoder,it is used for seriailizing
    
    指定者:
    
    getTranscoder 在接口中 MemcachedClientBuilder
    
    返回:
  - setTranscoder
```
public void setTranscoder(Transcoder transcoder)
```
    指定者:
    
    setTranscoder 在接口中 MemcachedClientBuilder
  - getAuthInfoMap
```
public Map<InetSocketAddress,AuthInfo> getAuthInfoMap()
```
    从接口复制的说明: MemcachedClientBuilder
    
    return current all auth info
    
    指定者:
    
    getAuthInfoMap 在接口中 MemcachedClientBuilder
    
    返回:
    Auth info map,key is memcached server address,and value is the auth info for the key.
  - setKeyProvider
```
public void setKeyProvider(KeyProvider keyProvider)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set a key provider for pre-processing keys before sending them to memcached.
    
    指定者:
    
    setKeyProvider 在接口中 MemcachedClientBuilder
  - addAuthInfo
```
public void addAuthInfo(InetSocketAddress address,
               AuthInfo authInfo)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Add auth info for memcached server
    
    指定者:
    
    addAuthInfo 在接口中 MemcachedClientBuilder
  - removeAuthInfo
```
public void removeAuthInfo(InetSocketAddress address)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Remove auth info for memcached server
    
    指定者:
    
    removeAuthInfo 在接口中 MemcachedClientBuilder
  - setAuthInfoMap
```
public void setAuthInfoMap(Map<InetSocketAddress,AuthInfo> authInfoMap)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Configure auth info
    
    指定者:
    
    setAuthInfoMap 在接口中 MemcachedClientBuilder
    
    参数:
    authInfoMap - Auth info map,key is memcached server address,and value is the auth info for the key.
  - getName
```
public String getName()
```
    从接口复制的说明: MemcachedClientBuilder
    
    Return the cache instance name
    
    指定者:
    
    getName 在接口中 MemcachedClientBuilder
    
    返回:
  - setName
```
public void setName(String name)
```
    从接口复制的说明: MemcachedClientBuilder
    
    Set cache instance name
    
    指定者:
    
    setName 在接口中 MemcachedClientBuilder

类 XMemcachedClientBuilder

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

XMemcachedClientBuilder

XMemcachedClientBuilder

XMemcachedClientBuilder

XMemcachedClientBuilder

XMemcachedClientBuilder

XMemcachedClientBuilder

方法详细资料

getOpTimeout

setOpTimeout

getMaxQueuedNoReplyOperations

getHealSessionInterval

setHealSessionInterval

isEnableHealSession

setEnableHealSession

setMaxQueuedNoReplyOperations

setSanitizeKeys

addStateListener

setSocketOption

getSocketOptions

setConnectionPoolSize

removeStateListener

getConnectTimeout

setConnectTimeout

setStateListeners

getDefaultSocketOptions

getDefaultConfiguration

isFailureMode

setFailureMode

getCommandFactory

setCommandFactory

getSessionLocator

setSessionLocator

getBufferAllocator

setBufferAllocator

getConfiguration

setConfiguration

build

getTranscoder

setTranscoder

getAuthInfoMap

setKeyProvider

addAuthInfo

removeAuthInfo

setAuthInfoMap

getName

setName