com.github.brainlag.nsq

Class NSQConsumer

java.lang.Object

com.github.brainlag.nsq.NSQConsumer

All Implemented Interfaces:

Closeable, AutoCloseable

public class NSQConsumer
extends Object
implements Closeable

Constructor Summary

Constructors

Constructor and Description
NSQConsumer(NSQLookup lookup, String topic, String channel, NSQMessageCallback callback)
NSQConsumer(NSQLookup lookup, String topic, String channel, NSQMessageCallback callback, NSQConfig config)
NSQConsumer(NSQLookup lookup, String topic, String channel, NSQMessageCallback callback, NSQConfig config, NSQErrorCallback errCallback)

Method Summary

Modifier and Type	Method and Description
void	close()
long	getTotalMessages()
protected void	processMessage(NSQMessage message)
ScheduledFuture	scheduleRun(Runnable task, int delay, int period, TimeUnit unit) This method allows for a runnable task to be scheduled using the NSQConsumer's scheduler executor This is intended for calling a periodic method in a NSQMessageCallback for batching messages without needing state in the callback itself
NSQConsumer	setExecutor(Executor executor) This is the executor where the callbacks happen.
NSQConsumer	setLookupPeriod(long periodMillis)
NSQConsumer	setMessagesPerBatch(int messagesPerBatch)
NSQConsumer	setScheduledExecutor(ScheduledExecutorService scheduler) Executor where scheduled callback methods are sent to
void	shutdown()
NSQConsumer	start()

Methods inherited from class java.lang.Object

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

Constructor Detail

NSQConsumer

public NSQConsumer(NSQLookup lookup,
                   String topic,
                   String channel,
                   NSQMessageCallback callback)

NSQConsumer

public NSQConsumer(NSQLookup lookup,
                   String topic,
                   String channel,
                   NSQMessageCallback callback,
                   NSQConfig config)

NSQConsumer

public NSQConsumer(NSQLookup lookup,
                   String topic,
                   String channel,
                   NSQMessageCallback callback,
                   NSQConfig config,
                   NSQErrorCallback errCallback)

Method Detail

start

public NSQConsumer start()

processMessage

protected void processMessage(NSQMessage message)

shutdown

public void shutdown()

setMessagesPerBatch

public NSQConsumer setMessagesPerBatch(int messagesPerBatch)

setLookupPeriod

public NSQConsumer setLookupPeriod(long periodMillis)

getTotalMessages

public long getTotalMessages()

setExecutor

public NSQConsumer setExecutor(Executor executor)

This is the executor where the callbacks happen. The executer can only changed before the client is started. Default is a cached threadpool.

scheduleRun

public ScheduledFuture scheduleRun(Runnable task,
                                   int delay,
                                   int period,
                                   TimeUnit unit)

This method allows for a runnable task to be scheduled using the NSQConsumer's scheduler executor This is intended for calling a periodic method in a NSQMessageCallback for batching messages without needing state in the callback itself

Parameters:

task - The Runnable task

delay - Delay in milliseconds

period - Period of time between scheduled runs

unit - TimeUnit for delay and period times

Returns:

ScheduledFuture - useful for cancelling scheduled task

setScheduledExecutor

public NSQConsumer setScheduledExecutor(ScheduledExecutorService scheduler)

Executor where scheduled callback methods are sent to

Parameters:

scheduler - scheduler to use (defaults to SingleThreadScheduledExecutor)

Returns:

this NSQConsumer

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException