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

Interface MessageSendingQueue

All Known Implementing Classes:

QueueProcessingThreadSender, SingleDelaySender, TwitchDelaySender

public interface MessageSendingQueue

A queue for sending messages.

Method Summary

Modifier and Type	Method and Description
void	beginSending(@NonNull Consumer<String> consumer) Starts sending messages to the given consumer.
boolean	contains(@NonNull String message) Gets if the queue currently has within it a particular message.
@NonNull Optional<Consumer<String>>	getConsumer() Gets the queue's currently set consumer.
void	pause() Pauses message sending.
void	queue(@NonNull String message) Queues a given message.
@NonNull Queue<String>	shutdown() Closes down shop, interrupts all threads.

Method Detail

beginSending

void beginSending(@NonNull Consumer<String> consumer)

Starts sending messages to the given consumer.

Parameters:

consumer - the consumer to consume

contains

boolean contains(@NonNull String message)

Gets if the queue currently has within it a particular message.

Parameters:

message - the message to check for

Returns:

true if the message is not yet sent

getConsumer

@NonNull Optional<Consumer<String>> getConsumer()

Gets the queue's currently set consumer.

Returns:

current consumer if present

pause

void pause()

Pauses message sending.

queue

void queue(@NonNull String message)

Queues a given message.

Parameters:

message - the message to queue

shutdown

@NonNull Queue<String> shutdown()

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

Returns:

the remaining messages