org.kitteh.irc.client.library.feature.sending

Class QueueProcessingThreadSender

java.lang.Object

java.lang.Thread

org.kitteh.irc.client.library.util.QueueProcessingThread<String>

org.kitteh.irc.client.library.feature.sending.QueueProcessingThreadSender

All Implemented Interfaces:

Runnable, MessageSendingQueue

Direct Known Subclasses:

SingleDelaySender, TwitchDelaySender

public class QueueProcessingThreadSender
extends QueueProcessingThread<String>
implements MessageSendingQueue

A MessageSendingQueue using QueueProcessingThread.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
QueueProcessingThreadSender(Client client, String name) Constructs the sending queue.

Method Summary

Modifier and Type	Method and Description
void	beginSending(Consumer<String> consumer) Starts sending messages to the given consumer.
protected boolean	checkReady(String message) Checks if the message can be sent yet, or at all.
protected void	cleanup(Queue<String> remainingQueue) This method is called after the thread has been interrupted.
protected Client	getClient() Gets the client.
Optional<Consumer<String>>	getConsumer() Gets the queue's currently set consumer.
void	pause() Pauses message sending.
protected void	processElement(String message) Processes an element from the queue.
Queue<String>	shutdown() Closes down shop, interrupts all threads.

Methods inherited from class org.kitteh.irc.client.library.util.QueueProcessingThread

contains, getQueue, queue, run

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kitteh.irc.client.library.feature.sending.MessageSendingQueue

contains, queue

Constructor Detail

QueueProcessingThreadSender

public QueueProcessingThreadSender(@Nonnull
                                   Client client,
                                   @Nonnull
                                   String name)

Constructs the sending queue.

Parameters:

client - the client

name - name of this sending queue

Method Detail

processElement

protected void processElement(@Nonnull
                              String message)

Description copied from class: QueueProcessingThread

Processes an element from the queue.

Specified by:

processElement in class QueueProcessingThread<String>

Parameters:

message - next element from the queue

checkReady

protected boolean checkReady(@Nonnull
                             String message)

Checks if the message can be sent yet, or at all. This is where delay can be factored in via a thread sleep or other approach.

Parameters:

message - the message to be sent

Returns:

true if the message will send, false to drop it

cleanup

protected final void cleanup(@Nonnull
                             Queue<String> remainingQueue)

Description copied from class: QueueProcessingThread

This method is called after the thread has been interrupted.

Overrides:

cleanup in class QueueProcessingThread<String>

Parameters:

remainingQueue - the queue

getClient

@Nonnull
protected Client getClient()

Gets the client.

Returns:

the client

beginSending

public void beginSending(@Nonnull
                         Consumer<String> consumer)

Description copied from interface: MessageSendingQueue

Starts sending messages to the given consumer.

Specified by:

beginSending in interface MessageSendingQueue

Parameters:

consumer - the consumer to consume

getConsumer

@Nonnull
public Optional<Consumer<String>> getConsumer()

Description copied from interface: MessageSendingQueue

Gets the queue's currently set consumer.

Specified by:

getConsumer in interface MessageSendingQueue

Returns:

current consumer if present

pause

public void pause()

Description copied from interface: MessageSendingQueue

Pauses message sending.

Specified by:

pause in interface MessageSendingQueue

shutdown

@Nonnull
public Queue<String> shutdown()

Description copied from interface: MessageSendingQueue

Closes down shop, interrupts all threads. No further messages.

Specified by:

shutdown in interface MessageSendingQueue

Returns:

the remaining messages