ConnectionFactory (jnats 0.6.0 API)

java.lang.Object
- io.nats.client.ConnectionFactory

All Implemented Interfaces:

Cloneable
```
public class ConnectionFactory
extends Object
implements Cloneable
```
A ConnectionFactory object encapsulates a set of connection configuration options. A client uses it to create a connection to NATS.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_HOST` Default server host.
`static int`	`DEFAULT_MAX_PINGS_OUT` Default maximum number of pings that have not received a response.
`static int`	`DEFAULT_MAX_RECONNECT` Default maximum number of reconnect attempts.
`static int`	`DEFAULT_PING_INTERVAL` Default server ping interval.
`static int`	`DEFAULT_PORT` Default server port.
`static int`	`DEFAULT_RECONNECT_BUF_SIZE` Default of pending message buffer that is used for buffering messages that are published during a disconnect/reconnect.
`static int`	`DEFAULT_RECONNECT_WAIT` Default wait time before attempting reconnection to the same server.
`static int`	`DEFAULT_TIMEOUT` Default connection timeout.
`static String`	`DEFAULT_URL` Default server URL.
`static String`	`PROP_CLOSED_CB` This property is defined as String "io.nats.client.callback.closed".
`static String`	`PROP_CONNECTION_NAME` This property is defined as String "io.nats.client.name".
`static String`	`PROP_CONNECTION_TIMEOUT` This property is defined as String "io.nats.client.timeout".
`static String`	`PROP_DISCONNECTED_CB` This property is defined as String "io.nats.client.callback.disconnected".
`static String`	`PROP_EXCEPTION_HANDLER` This property is defined as String "io.nats.client.callback.exception".
`static String`	`PROP_HOST` This property is defined as String "io.nats.client.host".
`static String`	`PROP_MAX_PINGS` This property is defined as String "io.nats.client.maxpings".
`static String`	`PROP_MAX_RECONNECT` This property is defined as String "io.nats.client.reconnect.max".
`static String`	`PROP_NORANDOMIZE` This property is defined as String "io.nats.client.norandomize".
`static String`	`PROP_PASSWORD` This property is defined as String "io.nats.client.password".
`static String`	`PROP_PEDANTIC` This property is defined as String "io.nats.client.pedantic".
`static String`	`PROP_PING_INTERVAL` This property is defined as String "io.nats.client.pinginterval".
`static String`	`PROP_PORT` This property is defined as String "io.nats.client.port".
`static String`	`PROP_RECONNECT_ALLOWED` This property is defined as String "io.nats.client.reconnect.allowed".
`static String`	`PROP_RECONNECT_BUF_SIZE` This property is defined as String "io.nats.client.reconnect.buffer.size".
`static String`	`PROP_RECONNECT_WAIT` This property is defined as String "io.nats.client.reconnect.wait".
`static String`	`PROP_RECONNECTED_CB` This property is defined as String "io.nats.client.callback.reconnected".
`static String`	`PROP_SECURE` This property is defined as String "io.nats.client.secure".
`static String`	`PROP_SERVERS` This property is defined as String "io.nats.client.servers".
`static String`	`PROP_TLS_DEBUG` This property is defined as String "io.nats.client.tls.debug".
`static String`	`PROP_URL` This property is defined as String "io.nats.client.url".
`static String`	`PROP_USERNAME` This property is defined as String "io.nats.client.username".
`static String`	`PROP_VERBOSE` This property is defined as String "io.nats.client.verbose".

Constructor Summary

Constructors
Constructor and Description
`ConnectionFactory()` Constructs a connection factory using default parameters.
`ConnectionFactory(ConnectionFactory cf)` Constructs a `ConnectionFactory` by copying the supplied `ConnectionFactory`.
`ConnectionFactory(Properties props)` Constructs a new connection factory from a `Properties` object.
`ConnectionFactory(String url)` Constructs a connection factory using the supplied URL string as default.
`ConnectionFactory(String[] servers)` Constructs a connection factory from a list of NATS server URL strings.
`ConnectionFactory(String url, String[] servers)` Constructs a connection factory from a list of NATS server URLs, using `url` as the primary address.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ConnectionFactory`	`clone()` .
`Connection`	`createConnection()` Creates an active connection to a NATS server
`ClosedCallback`	`getClosedCallback()` Returns the `ClosedCallback`, if one is registered.
`String`	`getConnectionName()` Gets the name associated with this Connection
`int`	`getConnectionTimeout()` Returns the connection timeout interval in milliseconds.
`DisconnectedCallback`	`getDisconnectedCallback()` Returns the `DisconnectedCallback`, if one is registered.
`ExceptionHandler`	`getExceptionHandler()` Returns the `ExceptionHandler`, if one is registered.
`String`	`getHost()` Gets the default server host, if set.
`int`	`getMaxPingsOut()` Returns the maximum number of outstanding server pings
`int`	`getMaxReconnect()` Gets the maximum number of reconnection attempts for this connection.
`String`	`getPassword()` Gets the default password, or `null` if not set.
`long`	`getPingInterval()` Gets the server ping interval in milliseconds.
`int`	`getPort()` Gets the default server port, if set.
`long`	`getReconnectBufSize()` Returns the maximum size in bytes of the pending message buffer, which is used to buffer messages between a disconnect and subsequent reconnect.
`ReconnectedCallback`	`getReconnectedCallback()` Returns the `ReconnectedCallback`, if one is registered.
`long`	`getReconnectWait()` Returns the reconnect wait interval in milliseconds.
`List<URI>`	`getServers()` Gets the server list as `URI`.
`SSLContext`	`getSslContext()` Deprecated. use `getSSLContext()` instead. Returns the `SSLContext` for this connection factory
`SSLContext`	`getSSLContext()` Returns the `SSLContext` for this connection factory.
`String`	`getUrlString()` Returns the default server URL string, if set.
`String`	`getUsername()` Gets the default username, if set.
`boolean`	`isNoRandomize()` Indicates whether server list randomization is disabled.
`boolean`	`isPedantic()` Indicates whether strict server-side protocol checking is enabled.
`boolean`	`isReconnectAllowed()` Indicates whether reconnection is enabled.
`boolean`	`isSecure()` Indicates whether to require a secure connection with the NATS server.
`boolean`	`isTlsDebug()` Indicates whether TLS debug output should be enabled.
`boolean`	`isVerbose()` Indicates whether `verbose` is set.
`void`	`setClosedCallback(ClosedCallback cb)` Sets the `ClosedCallback`.
`void`	`setConnectionName(String connectionName)` Sets the name associated with this Connection
`void`	`setConnectionTimeout(int timeout)` Sets the connection timeout interval in milliseconds.
`void`	`setDisconnectedCallback(DisconnectedCallback cb)` Sets the `DisconnectedCallback`.
`void`	`setExceptionHandler(ExceptionHandler exceptionHandler)` Sets the `ExceptionHandler`.
`void`	`setHost(String host)` Sets the default server host.
`void`	`setMaxPingsOut(int max)` Sets the maximum number of outstanding pings (pings for which no pong has been received).
`void`	`setMaxReconnect(int max)` Sets the maximum number of reconnection attempts for this connection.
`void`	`setNoRandomize(boolean noRandomize)` Disables or enables server list randomization.
`void`	`setPassword(String password)` Sets the default password.
`void`	`setPedantic(boolean pedantic)` Sets whether strict server-side protocol checking is enabled.
`void`	`setPingInterval(long interval)` Sets the server ping interval in milliseconds.
`void`	`setPort(int port)` Sets the default server port.
`void`	`setReconnectAllowed(boolean reconnectAllowed)` Sets whether reconnection is enabled.
`void`	`setReconnectBufSize(int size)` Sets the maximum size in bytes of the pending message buffer, which is used to buffer messages between a disconnect and subsequent reconnect.
`void`	`setReconnectedCallback(ReconnectedCallback cb)` Sets the `ReconnectedCallback`.
`void`	`setReconnectWait(long interval)` Sets the reconnect wait interval in milliseconds.
`void`	`setSecure(boolean secure)` Sets whether to require a secure connection with the NATS server.
`void`	`setServers(List<URI> servers)` Sets the server list from a list of `URI`.
`void`	`setServers(String urlString)` Sets the server list from a comma-delimited list of server addresses in a single string.
`void`	`setServers(String[] servers)` Sets the server list from a list of `String`.
`void`	`setSslContext(SSLContext ctx)` Deprecated. use `setSSLContext(javax.net.ssl.SSLContext)` instead. Sets the `SSLContext` for this connection factory
`void`	`setSSLContext(SSLContext ctx)` Sets the `SSLContext` for this connection factory.
`void`	`setTlsDebug(boolean debug)` Sets whether TLS debug output should be enabled.
`void`	`setUri(URI uri)` Convenience function to set host, port, username, password from a java.net.URI.
`void`	`setUrl(String url)` Sets the default server URL string.
`void`	`setUsername(String username)` Sets the default username.
`void`	`setVerbose(boolean verbose)` Sets whether `verbose` is set.

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

- Field Detail
  - PROP_URL
```
public static final String PROP_URL
```
    This property is defined as String "io.nats.client.url".
    
    See Also:
    
    Constant Field Values
  - PROP_HOST
```
public static final String PROP_HOST
```
    This property is defined as String "io.nats.client.host".
    
    See Also:
    
    Constant Field Values
  - PROP_PORT
```
public static final String PROP_PORT
```
    This property is defined as String "io.nats.client.port".
    
    See Also:
    
    Constant Field Values
  - PROP_USERNAME
```
public static final String PROP_USERNAME
```
    This property is defined as String "io.nats.client.username".
    
    See Also:
    
    Constant Field Values
  - PROP_PASSWORD
```
public static final String PROP_PASSWORD
```
    This property is defined as String "io.nats.client.password".
    
    See Also:
    
    Constant Field Values
  - PROP_SERVERS
```
public static final String PROP_SERVERS
```
    This property is defined as String "io.nats.client.servers".
    
    See Also:
    
    Constant Field Values
  - PROP_NORANDOMIZE
```
public static final String PROP_NORANDOMIZE
```
    This property is defined as String "io.nats.client.norandomize".
    
    See Also:
    
    Constant Field Values
  - PROP_CONNECTION_NAME
```
public static final String PROP_CONNECTION_NAME
```
    This property is defined as String "io.nats.client.name".
    
    See Also:
    
    Constant Field Values
  - PROP_VERBOSE
```
public static final String PROP_VERBOSE
```
    This property is defined as String "io.nats.client.verbose".
    
    See Also:
    
    Constant Field Values
  - PROP_PEDANTIC
```
public static final String PROP_PEDANTIC
```
    This property is defined as String "io.nats.client.pedantic".
    
    See Also:
    
    Constant Field Values
  - PROP_SECURE
```
public static final String PROP_SECURE
```
    This property is defined as String "io.nats.client.secure".
    
    See Also:
    
    Constant Field Values
  - PROP_TLS_DEBUG
```
public static final String PROP_TLS_DEBUG
```
    This property is defined as String "io.nats.client.tls.debug".
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_ALLOWED
```
public static final String PROP_RECONNECT_ALLOWED
```
    This property is defined as String "io.nats.client.reconnect.allowed".
    
    See Also:
    
    Constant Field Values
  - PROP_MAX_RECONNECT
```
public static final String PROP_MAX_RECONNECT
```
    This property is defined as String "io.nats.client.reconnect.max".
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_WAIT
```
public static final String PROP_RECONNECT_WAIT
```
    This property is defined as String "io.nats.client.reconnect.wait".
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_BUF_SIZE
```
public static final String PROP_RECONNECT_BUF_SIZE
```
    This property is defined as String "io.nats.client.reconnect.buffer.size".
    
    See Also:
    
    Constant Field Values
  - PROP_CONNECTION_TIMEOUT
```
public static final String PROP_CONNECTION_TIMEOUT
```
    This property is defined as String "io.nats.client.timeout".
    
    See Also:
    
    Constant Field Values
  - PROP_PING_INTERVAL
```
public static final String PROP_PING_INTERVAL
```
    This property is defined as String "io.nats.client.pinginterval".
    
    See Also:
    
    Constant Field Values
  - PROP_MAX_PINGS
```
public static final String PROP_MAX_PINGS
```
    This property is defined as String "io.nats.client.maxpings".
    
    See Also:
    
    Constant Field Values
  - PROP_EXCEPTION_HANDLER
```
public static final String PROP_EXCEPTION_HANDLER
```
    This property is defined as String "io.nats.client.callback.exception".
    
    See Also:
    
    Constant Field Values
  - PROP_CLOSED_CB
```
public static final String PROP_CLOSED_CB
```
    This property is defined as String "io.nats.client.callback.closed".
    
    See Also:
    
    Constant Field Values
  - PROP_DISCONNECTED_CB
```
public static final String PROP_DISCONNECTED_CB
```
    This property is defined as String "io.nats.client.callback.disconnected".
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECTED_CB
```
public static final String PROP_RECONNECTED_CB
```
    This property is defined as String "io.nats.client.callback.reconnected".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    Default server host.
    This property is defined as String "localhost"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    Default server port.
    This property is defined as int 4222
    
    See Also:
    
    Constant Field Values
  - DEFAULT_URL
```
public static final String DEFAULT_URL
```
    Default server URL.
    This property is defined as String "nats://localhost:4222"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_RECONNECT
```
public static final int DEFAULT_MAX_RECONNECT
```
    Default maximum number of reconnect attempts.
    This property is defined as String 60
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECONNECT_WAIT
```
public static final int DEFAULT_RECONNECT_WAIT
```
    Default wait time before attempting reconnection to the same server.
    This property is defined as String 2000
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECONNECT_BUF_SIZE
```
public static final int DEFAULT_RECONNECT_BUF_SIZE
```
    Default of pending message buffer that is used for buffering messages that are published during a disconnect/reconnect.
    This property is defined as String 8388608
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT
```
public static final int DEFAULT_TIMEOUT
```
    Default connection timeout.
    This property is defined as String 2000
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PING_INTERVAL
```
public static final int DEFAULT_PING_INTERVAL
```
    Default server ping interval. <=0 means disabled.
    This property is defined as String 120000
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_PINGS_OUT
```
public static final int DEFAULT_MAX_PINGS_OUT
```
    Default maximum number of pings that have not received a response.
    This property is defined as String 2
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConnectionFactory
```
public ConnectionFactory(Properties props)
```
    Constructs a new connection factory from a Properties object.
    
    Parameters:
    
    props - the Properties object
  - ConnectionFactory
```
public ConnectionFactory()
```
    Constructs a connection factory using default parameters.
  - ConnectionFactory
```
public ConnectionFactory(String url)
```
    Constructs a connection factory using the supplied URL string as default.
    
    Parameters:
    
    url - the default server URL to use
  - ConnectionFactory
```
public ConnectionFactory(String[] servers)
```
    Constructs a connection factory from a list of NATS server URL strings.
    
    Parameters:
    
    servers - the list of cluster server URL strings
  - ConnectionFactory
```
public ConnectionFactory(String url,
                         String[] servers)
```
    Constructs a connection factory from a list of NATS server URLs, using url as the primary address.
    If url contains a single server address, that address will be first in the server list, even if isNoRandomize() is false.
    If url is a comma-delimited list of servers, then servers will be ignored.
    
    Parameters:
    
    url - the default server URL to set
    
    servers - the list of cluster server URL strings
  - ConnectionFactory
```
public ConnectionFactory(ConnectionFactory cf)
```
    Constructs a ConnectionFactory by copying the supplied ConnectionFactory.
    
    Parameters:
    
    cf - the ConnectionFactory to copy
- Method Detail
  - createConnection
```
public Connection createConnection()
                            throws IOException,
                                   TimeoutException
```
    Creates an active connection to a NATS server
    
    Returns:
    
    the Connection.
    
    Throws:
    
    IOException - if a Connection cannot be established for some reason.
    
    TimeoutException - if the connection timeout has been exceeded.
  - clone
```
public ConnectionFactory clone()
```
    .
    
    Overrides:
    
    clone in class Object
  - setUri
```
public void setUri(URI uri)
```
    Convenience function to set host, port, username, password from a java.net.URI. Any omitted URI elements are left unchanged in the corresponding fields.
    
    Parameters:
    
    uri - the URI to set
  - getUrlString
```
public String getUrlString()
```
    Returns the default server URL string, if set.
    
    Returns:
    
    the default server URL, or null if not set
  - setUrl
```
public void setUrl(String url)
```
    Sets the default server URL string.
    If url is a comma-delimited list, then setServers(String) will be invoked without setting the default server URL string.
    
    Parameters:
    
    url - the URL to set
  - getHost
```
public String getHost()
```
    Gets the default server host, if set.
    
    Returns:
    
    the host, or null if not set
  - setHost
```
public void setHost(String host)
```
    Sets the default server host.
    
    Parameters:
    
    host - the host to set
  - getPort
```
public int getPort()
```
    Gets the default server port, if set.
    
    Returns:
    
    the default server port, or -1 if not set
  - setPort
```
public void setPort(int port)
```
    Sets the default server port.
    
    Parameters:
    
    port - the port to set
  - getUsername
```
public String getUsername()
```
    Gets the default username, if set.
    
    Returns:
    
    the username, or null if not set
  - setUsername
```
public void setUsername(String username)
```
    Sets the default username.
    
    Parameters:
    
    username - the username to set
  - getPassword
```
public String getPassword()
```
    Gets the default password, or null if not set.
    
    Returns:
    
    the password
  - setPassword
```
public void setPassword(String password)
```
    Sets the default password.
    
    Parameters:
    
    password - the password to set
  - getServers
```
public List<URI> getServers()
```
    Gets the server list as URI.
    
    Returns:
    
    the list of server URIs, or null if not set
  - setServers
```
public void setServers(List<URI> servers)
```
    Sets the server list from a list of URI.
    
    Parameters:
    
    servers - the servers to set
  - setServers
```
public void setServers(String urlString)
```
    Sets the server list from a comma-delimited list of server addresses in a single string.
    
    Parameters:
    
    urlString - the servers to set
  - setServers
```
public void setServers(String[] servers)
```
    Sets the server list from a list of String.
    
    Parameters:
    
    servers - the servers to set
    
    Throws:
    
    IllegalArgumentException - if any of the URIs are malformed
  - isNoRandomize
```
public boolean isNoRandomize()
```
    Indicates whether server list randomization is disabled.
    true means that the server list will be traversed in the order in which it was received
    false means that the server list will be randomized before it is traversed
    
    Returns:
    
    true if server list randomization is disabled, otherwise false
  - setNoRandomize
```
public void setNoRandomize(boolean noRandomize)
```
    Disables or enables server list randomization.
    
    Parameters:
    
    noRandomize - the noRandomize to set
  - getConnectionName
```
public String getConnectionName()
```
    Gets the name associated with this Connection
    
    Returns:
    
    the name associated with this Connection.
  - setConnectionName
```
public void setConnectionName(String connectionName)
```
    Sets the name associated with this Connection
    
    Parameters:
    
    connectionName - the name to set.
  - isVerbose
```
public boolean isVerbose()
```
    Indicates whether verbose is set.
    When verbose==true, the server will acknowledge each protocol line with +OK or -ERR
    
    Returns:
    
    whether verbose is set
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Sets whether verbose is set.
    
    Parameters:
    
    verbose - whether or not this connection should require protocol acks from the server (+OK/-ERR)
  - isPedantic
```
public boolean isPedantic()
```
    Indicates whether strict server-side protocol checking is enabled.
    
    Returns:
    
    whether pedantic is set
  - setPedantic
```
public void setPedantic(boolean pedantic)
```
    Sets whether strict server-side protocol checking is enabled.
    When pedantic==true , strict server-side protocol checking occurs.
    
    Parameters:
    
    pedantic - whether or not this connection should require strict server-side protocol checking
  - isSecure
```
public boolean isSecure()
```
    Indicates whether to require a secure connection with the NATS server.
    
    Returns:
    
    true if secure is required, otherwise false
  - setSecure
```
public void setSecure(boolean secure)
```
    Sets whether to require a secure connection with the NATS server.
    
    Parameters:
    
    secure - whether to require a secure connection with the NATS server
  - isTlsDebug
```
public boolean isTlsDebug()
```
    Indicates whether TLS debug output should be enabled.
    
    Returns:
    
    true if TLS debug is enabled, otherwise false
  - setTlsDebug
```
public void setTlsDebug(boolean debug)
```
    Sets whether TLS debug output should be enabled.
    
    Parameters:
    
    debug - whether TLS debug output should be enabled
  - isReconnectAllowed
```
public boolean isReconnectAllowed()
```
    Indicates whether reconnection is enabled.
    
    Returns:
    
    true if reconnection is allowed, otherwise false
  - setReconnectAllowed
```
public void setReconnectAllowed(boolean reconnectAllowed)
```
    Sets whether reconnection is enabled.
    
    Parameters:
    
    reconnectAllowed - whether to allow reconnects
  - getMaxReconnect
```
public int getMaxReconnect()
```
    Gets the maximum number of reconnection attempts for this connection.
    
    Returns:
    
    the maximum number of reconnection attempts
  - setMaxReconnect
```
public void setMaxReconnect(int max)
```
    Sets the maximum number of reconnection attempts for this connection.
    
    Parameters:
    
    max - the maximum number of reconnection attempts
  - getReconnectWait
```
public long getReconnectWait()
```
    Returns the reconnect wait interval in milliseconds. This is the amount of time to wait before attempting reconnection to the current server
    
    Returns:
    
    the reconnect wait interval in milliseconds
  - setReconnectBufSize
```
public void setReconnectBufSize(int size)
```
    Sets the maximum size in bytes of the pending message buffer, which is used to buffer messages between a disconnect and subsequent reconnect.
    
    Parameters:
    
    size - the reconnect buffer size, in bytes
  - getReconnectBufSize
```
public long getReconnectBufSize()
```
    Returns the maximum size in bytes of the pending message buffer, which is used to buffer messages between a disconnect and subsequent reconnect.
    
    Returns:
    
    the reconnect buffer size, in bytes
  - setReconnectWait
```
public void setReconnectWait(long interval)
```
    Sets the reconnect wait interval in milliseconds. This is the amount of time to wait before attempting reconnection to the current server
    
    Parameters:
    
    interval - the reconnectWait to set
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns the connection timeout interval in milliseconds. This is the maximum amount of time to wait for a connection to a NATS server to complete successfully
    
    Returns:
    
    the connection timeout
  - setConnectionTimeout
```
public void setConnectionTimeout(int timeout)
```
    Sets the connection timeout interval in milliseconds. This is the maximum amount of time to wait for a connection to a NATS server to complete successfully
    
    Parameters:
    
    timeout - the connection timeout
    
    Throws:
    
    IllegalArgumentException - if timeout < 0
  - getPingInterval
```
public long getPingInterval()
```
    Gets the server ping interval in milliseconds. The connection will send a PING to the server at this interval to ensure the server is still alive
    
    Returns:
    
    the pingInterval
  - setPingInterval
```
public void setPingInterval(long interval)
```
    Sets the server ping interval in milliseconds. The connection will send a PING to the server at this interval to ensure the server is still alive
    
    Parameters:
    
    interval - the ping interval to set in milliseconds
  - getMaxPingsOut
```
public int getMaxPingsOut()
```
    Returns the maximum number of outstanding server pings
    
    Returns:
    
    the maximum number of oustanding outbound pings before marking the Connection stale and triggering reconnection (if allowed).
  - setMaxPingsOut
```
public void setMaxPingsOut(int max)
```
    Sets the maximum number of outstanding pings (pings for which no pong has been received). Once this limit is exceeded, the connection is marked as stale and closed.
    
    Parameters:
    
    max - the maximum number of outstanding pings
  - getClosedCallback
```
public ClosedCallback getClosedCallback()
```
    Returns the ClosedCallback, if one is registered.
    
    Returns:
    
    the ClosedCallback, if one is registered
  - setClosedCallback
```
public void setClosedCallback(ClosedCallback cb)
```
    Sets the ClosedCallback.
    
    Parameters:
    
    cb - the ClosedCallback to set
  - getDisconnectedCallback
```
public DisconnectedCallback getDisconnectedCallback()
```
    Returns the DisconnectedCallback, if one is registered.
    
    Returns:
    
    the DisconnectedCallback, if one is registered
  - setDisconnectedCallback
```
public void setDisconnectedCallback(DisconnectedCallback cb)
```
    Sets the DisconnectedCallback.
    
    Parameters:
    
    cb - the DisconnectedCallback to set
  - getReconnectedCallback
```
public ReconnectedCallback getReconnectedCallback()
```
    Returns the ReconnectedCallback, if one is registered.
    
    Returns:
    
    the ReconnectedCallback, if one is registered
  - setReconnectedCallback
```
public void setReconnectedCallback(ReconnectedCallback cb)
```
    Sets the ReconnectedCallback.
    
    Parameters:
    
    cb - the ReconnectedCallback to set
  - getExceptionHandler
```
public ExceptionHandler getExceptionHandler()
```
    Returns the ExceptionHandler, if one is registered.
    
    Returns:
    
    the ExceptionHandler, if one is registered
  - setExceptionHandler
```
public void setExceptionHandler(ExceptionHandler exceptionHandler)
```
    Sets the ExceptionHandler.
    
    Parameters:
    
    exceptionHandler - the ExceptionHandler to set for connection.
  - getSslContext
```
@Deprecated
public SSLContext getSslContext()
```
    Deprecated. use getSSLContext() instead. Returns the SSLContext for this connection factory
    
    Returns:
    
    the SSLContext for this connection factory
  - getSSLContext
```
public SSLContext getSSLContext()
```
    Returns the SSLContext for this connection factory.
    
    Returns:
    
    the SSLContext for this connection factory
  - setSslContext
```
@Deprecated
public void setSslContext(SSLContext ctx)
```
    Deprecated. use setSSLContext(javax.net.ssl.SSLContext) instead. Sets the SSLContext for this connection factory
    
    Parameters:
    
    ctx - the SSLContext to set
  - setSSLContext
```
public void setSSLContext(SSLContext ctx)
```
    Sets the SSLContext for this connection factory.
    
    Parameters:
    
    ctx - the SSLContext to set

Class ConnectionFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_URL

PROP_HOST

PROP_PORT

PROP_USERNAME

PROP_PASSWORD

PROP_SERVERS

PROP_NORANDOMIZE

PROP_CONNECTION_NAME

PROP_VERBOSE

PROP_PEDANTIC

PROP_SECURE

PROP_TLS_DEBUG

PROP_RECONNECT_ALLOWED

PROP_MAX_RECONNECT

PROP_RECONNECT_WAIT

PROP_RECONNECT_BUF_SIZE

PROP_CONNECTION_TIMEOUT

PROP_PING_INTERVAL

PROP_MAX_PINGS

PROP_EXCEPTION_HANDLER

PROP_CLOSED_CB

PROP_DISCONNECTED_CB

PROP_RECONNECTED_CB

DEFAULT_HOST

DEFAULT_PORT

DEFAULT_URL

DEFAULT_MAX_RECONNECT

DEFAULT_RECONNECT_WAIT

DEFAULT_RECONNECT_BUF_SIZE

DEFAULT_TIMEOUT

DEFAULT_PING_INTERVAL

DEFAULT_MAX_PINGS_OUT

Constructor Detail

ConnectionFactory

ConnectionFactory

ConnectionFactory

ConnectionFactory

ConnectionFactory

ConnectionFactory

Method Detail

createConnection

clone

setUri

getUrlString

setUrl

getHost

setHost

getPort

setPort

getUsername

setUsername

getPassword

setPassword

getServers

setServers

setServers

setServers

isNoRandomize

setNoRandomize

getConnectionName

setConnectionName

isVerbose

setVerbose

isPedantic

setPedantic

isSecure

setSecure

isTlsDebug

setTlsDebug

isReconnectAllowed

setReconnectAllowed

getMaxReconnect

setMaxReconnect

getReconnectWait