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

Class SingleDelaySender

java.lang.Object

java.lang.Thread

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

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

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

All Implemented Interfaces:

Runnable, MessageSendingQueue

public class SingleDelaySender
extends QueueProcessingThreadSender

A QueueProcessingThreadSender using a single set delay.

Nested Class Summary

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MESSAGE_DELAY The default message delay, in milliseconds.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
SingleDelaySender(@NonNull Client client, @NonNull String name, int delay) Constructs the sending queue.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkReady(@NonNull String message) Checks if the message can be sent yet, or at all.
static Function<Client.WithManagement,SingleDelaySender>	getSupplier(int delay) Gets a delay supplier with a set delay of milliseconds.
void	setDelay(int delay) Sets the delay for subsequent messages.

Methods inherited from class org.kitteh.irc.client.library.feature.sending.QueueProcessingThreadSender

beginSending, cleanup, getClient, getConsumer, pause, processElement, shutdown

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

Field Detail

DEFAULT_MESSAGE_DELAY

public static final int DEFAULT_MESSAGE_DELAY

The default message delay, in milliseconds.

See Also:

Constant Field Values

Constructor Detail

SingleDelaySender

public SingleDelaySender(@NonNull Client client,
                         @NonNull String name,
                         int delay)

Constructs the sending queue.

Parameters:

client - the client

name - name of this sending queue

delay - initial delay in milliseconds

Method Detail

getSupplier

public static Function<Client.WithManagement,SingleDelaySender> getSupplier(int delay)

Gets a delay supplier with a set delay of milliseconds.

Parameters:

delay - delay to set in milliseconds

Returns:

supplier

checkReady

protected boolean checkReady(@NonNull String message)

Description copied from class: QueueProcessingThreadSender

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.

Overrides:

checkReady in class QueueProcessingThreadSender

Parameters:

message - the message to be sent

Returns:

true if the message will send, false to drop it

setDelay

public void setDelay(int delay)

Sets the delay for subsequent messages.

Parameters:

delay - the new delay in milliseconds