com.sproutsocial.nsq

Class Client

java.lang.Object

com.sproutsocial.nsq.Client

@ThreadSafe
public class Client
extends Object

Constructor Summary

Constructors

Constructor and Description
Client()

Method Summary

Modifier and Type	Method and Description
byte[]	getAuthSecret()
static Client	getDefaultClient()
ExecutorService	getExecutor()
SSLSocketFactory	getSSLSocketFactory()
void	setAuthSecret(byte[] authSecret)
void	setAuthSecret(String authSecret)
void	setExecutor(ExecutorService exec)
void	setSSLSocketFactory(SSLSocketFactory sslSocketFactory)
boolean	stop()
boolean	stop(int waitMillis) Stops all subscribers, waits for in-flight messages to be finished or requeued, stops the executor that handles messages, then stops all publishers.
boolean	stopSubscribers(int waitMillis) Stops all subscribers, waits for in-flight messages to be finished or requeued, then closes subscriber connections.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Client

public Client()

Method Detail

getDefaultClient

public static Client getDefaultClient()

stop

public boolean stop()

stop

public boolean stop(int waitMillis)

Stops all subscribers, waits for in-flight messages to be finished or requeued, stops the executor that handles messages, then stops all publishers. All connections will be closed and no threads started by this client should be running when this returns.

Parameters:

waitMillis - Time to wait for everything to stop, in milliseconds. Soft limit that may be exceeded by about 200 ms.

stopSubscribers

public boolean stopSubscribers(int waitMillis)

Stops all subscribers, waits for in-flight messages to be finished or requeued, then closes subscriber connections. Useful if you need to perform some action before publishers are stopped, you should call stop() after this to shutdown all threads.

Parameters:

waitMillis - Time to wait for in-flight messages to be finished, in milliseconds.

setExecutor

public void setExecutor(ExecutorService exec)

getExecutor

public ExecutorService getExecutor()

getSSLSocketFactory

public SSLSocketFactory getSSLSocketFactory()

setSSLSocketFactory

public void setSSLSocketFactory(SSLSocketFactory sslSocketFactory)

getAuthSecret

public byte[] getAuthSecret()

setAuthSecret

public void setAuthSecret(byte[] authSecret)

setAuthSecret

public void setAuthSecret(String authSecret)