org.kitteh.irc.client.library.feature.twitch

Class TwitchDelaySender

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.twitch.TwitchDelaySender

All Implemented Interfaces:

Runnable, MessageSendingQueue

public class TwitchDelaySender
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	MOD_OP_PER_THIRTY_SECONDS Number of commands per 30 seconds if only sending to channels in which the client is moderator or operator.
static int	NON_MOD_OP_PER_THIRTY_SECONDS Number of commands per 30 seconds if ever sending out of channels in which the client is not moderator or operator.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
TwitchDelaySender(@NonNull Client client, @NonNull String name, int perThirtySeconds) 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,TwitchDelaySender>	getSupplier() Gets a supplier.
static Function<Client.WithManagement,TwitchDelaySender>	getSupplier(boolean modOrOpOnly) Gets a supplier.

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

MOD_OP_PER_THIRTY_SECONDS

public static final int MOD_OP_PER_THIRTY_SECONDS

Number of commands per 30 seconds if only sending to channels in which the client is moderator or operator.

See Also:

Constant Field Values

NON_MOD_OP_PER_THIRTY_SECONDS

public static final int NON_MOD_OP_PER_THIRTY_SECONDS

Number of commands per 30 seconds if ever sending out of channels in which the client is not moderator or operator.

See Also:

Constant Field Values

Constructor Detail

TwitchDelaySender

public TwitchDelaySender(@NonNull Client client,
                         @NonNull String name,
                         int perThirtySeconds)

Constructs the sending queue.

Parameters:

client - the client

name - name of this sending queue

perThirtySeconds - messages per thirty seconds

Method Detail

getSupplier

public static Function<Client.WithManagement,TwitchDelaySender> getSupplier()

Gets a supplier.

Returns:

supplier

getSupplier

public static Function<Client.WithManagement,TwitchDelaySender> getSupplier(boolean modOrOpOnly)

Gets a supplier.

Parameters:

modOrOpOnly - true if will only ever send to channels in which the client is moderator or operator

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