org.kitteh.irc.client.library.defaults

Class DefaultClient

java.lang.Object

org.kitteh.irc.client.library.defaults.DefaultClient

All Implemented Interfaces:

Client, Client.WithManagement, ClientLinked

public class DefaultClient
extends Object
implements Client.WithManagement

Default implementation of Client.

Nested Class Summary

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.Client

Client.Builder, Client.Commands, Client.WithManagement

Constructor Summary

Constructors

Constructor and Description
DefaultClient() Creates a new default client.

Method Summary

Modifier and Type	Method and Description
void	addChannel(String... channels) Adds channels to this client.
void	addKeyProtectedChannel(Pair<String,String>... channelsAndKeys) Adds key-protected channels to this client.
void	addKeyProtectedChannel(@NonNull String channel, @NonNull String key) Adds a key-protected channel to this client.
void	beginMessageSendingImmediate(@NonNull Consumer<String> consumer) Starts the sending of queued 'immediately' messages.
@NonNull Client.Commands	commands() Provides access to Commands.
void	connect() Begin connecting to the server.
@NonNull ActorTracker	getActorTracker() Gets the actor tracker.
@NonNull AuthManager	getAuthManager() Gets the authentication manager.
@NonNull InetSocketAddress	getBindAddress() Gets the bind address
CapabilityManager.WithManagement	getCapabilityManager() Gets the capability manager.
@NonNull Optional<Channel>	getChannel(@NonNull String name) Gets a snapshot of known information about a named channel, if the channel is being tracked by the client.
@NonNull Set<Channel>	getChannels() Gets the channels in which the client is currently present.
@NonNull Set<Channel>	getChannels(@NonNull Collection<String> channels) Gets the channels on the given collection in which the client is currently present.
@NonNull DefaultMessageMap	getDefaultMessageMap() Gets the message manager for default messages to reply with when certain messages are being sent.
@NonNull EventManager	getEventManager() Gets the client's event manager.
@NonNull Listener<Exception>	getExceptionListener() Gets the exception listener.
@NonNull Listener<String>	getInputListener() Gets the currently set input listener.
@NonNull Set<String>	getIntendedChannels() Gets the channels the client intends to join.
@NonNull String	getIntendedNick() Gets the nickname the client intends to possess.
@NonNull ISupportManager	getISupportManager() Gets the manager of ISUPPORT info.
@NonNull Cutter	getMessageCutter() Gets the current message cutter for multi-line messages.
@NonNull Function<Client.WithManagement,? extends MessageSendingQueue>	getMessageSendingQueueSupplier() Gets the message sending queue supplier.
@NonNull MessageTagManager	getMessageTagManager() Gets the message tag manager.
@NonNull String	getName() Gets the client name.
@NonNull NetworkHandler	getNetworkHandler() Gets the network handler.
@NonNull String	getNick() Gets the current nickname the client has.
@NonNull Listener<String>	getOutputListener() Gets the currently set output listener.
@NonNull Optional<HostWithPort>	getProxyAddress() Gets the proxy address
@NonNull Optional<ProxyType>	getProxyType() Gets if the client is configured to use a proxy.
@NonNull String	getRequestedNick() Gets the nickname the client has last requested.
@Nullable Path	getSecureKey() Gets the TLS key.
@Nullable Path	getSecureKeyCertChain() Gets the TLS key certificate chain.
@Nullable String	getSecureKeyPassword() Gets the TLS key password.
@Nullable TrustManagerFactory	getSecureTrustManagerFactory() Gets the trust manager factory.
@NonNull HostWithPort	getServerAddress() Gets the server address
ServerInfo.WithManagement	getServerInfo() Gets information about the server to which the client is currently connected.
@NonNull Optional<StsMachine>	getStsMachine() Gets the STS machine instance, if one is in use.
@NonNull Optional<User>	getUser() Gets the User that the client is represented by.
@NonNull Optional<ModeStatusList<UserMode>>	getUserModes() Gets the user's modes.
void	initialize(@NonNull String name, @NonNull NetworkHandler networkHandler, @NonNull HostWithPort serverAddress, @Nullable String serverPassword, @Nullable InetSocketAddress bindAddress, @Nullable HostWithPort proxyAddress, @Nullable ProxyType proxyType, @NonNull String nick, @NonNull String userString, @NonNull String realName, @NonNull ActorTracker actorTracker, @NonNull AuthManager authManager, CapabilityManager.WithManagement capabilityManager, @NonNull EventManager eventManager, @NonNull List<EventListenerSupplier> listenerSuppliers, @NonNull MessageTagManager messageTagManager, @NonNull ISupportManager iSupportManager, @Nullable DefaultMessageMap defaultMessageMap, @NonNull Function<Client.WithManagement,? extends MessageSendingQueue> messageSendingQueue, @NonNull Function<Client.WithManagement,? extends ServerInfo.WithManagement> serverInfo, @Nullable Consumer<Exception> exceptionListener, @Nullable Consumer<String> inputListener, @Nullable Consumer<String> outputListener, boolean secure, @Nullable Path secureKeyCertChain, @Nullable Path secureKey, @Nullable String secureKeyPassword, @Nullable TrustManagerFactory trustManagerFactory, @Nullable StsStorageManager stsStorageManager, @Nullable String webircHost, @Nullable InetAddress webircIP, @Nullable String webircPassword, @Nullable String webircGateway) Initialize with pre-connection information.
boolean	isConnectionAlive() Gets if the connection is alive.
boolean	isSecureConnection() Gets if the client is configured for a secure connection.
void	knockChannel(@NonNull String channelName) KNOCKs on a +i (but not +p) channel, requesting an INVITE.
void	pauseMessageSending() Pauses message sending, waiting for next successful connection.
void	ping() Sends a PING.
void	processLine(@NonNull String line) Queue up a line for processing.
void	reconnect() Triggers a reconnect, quitting with the default DefaultMessageType.RECONNECT message.
void	reconnect(@Nullable String reason) Triggers a reconnect, quitting with the given reason.
void	removeChannel(@NonNull String channelName) Removes a channel from the client, leaving as necessary.
void	removeChannel(@NonNull String channelName, @Nullable String reason) Removes a channel from the client, leaving as necessary.
void	sendCtcpMessage(@NonNull String target, @NonNull String message) Sends a CTCP message to a target user or channel.
void	sendCtcpReply(@NonNull String target, @NonNull String message) Sends a CTCP reply to a target user or channel.
void	sendMessage(@NonNull String target, @NonNull String message) Sends a message to a target user or channel.
void	sendMultiLineMessage(@NonNull String target, @NonNull String message, @NonNull Cutter cutter) Sends a potentially multi-line message to a target user or channel using the defined Cutter.
void	sendMultiLineNotice(@NonNull String target, @NonNull String message, @NonNull Cutter cutter) Sends a potentially multi-line notice to a target user or channel using the defined Cutter.
void	sendNickChange(@NonNull String newNick) Sends a nick change request.
void	sendNotice(@NonNull String target, @NonNull String message) Sends a notice to a target user or channel.
void	sendRawLine(@NonNull String message) Sends a raw IRC message.
void	sendRawLineAvoidingDuplication(@NonNull String message) Sends a raw IRC message, unless the exact same message is already in the queue of messages not yet sent.
void	sendRawLineImmediately(@NonNull String message) Sends a raw IRC message, disregarding message delays and all sanity.
void	setCurrentNick(@NonNull String nick) Sets the current nickname the client knows it has.
void	setDefaultMessageMap(@NonNull DefaultMessageMap defaults) Sets the message manager for default messages to reply with when certain messages are being sent.
void	setExceptionListener(@Nullable Consumer<Exception> listener) Sets a listener for all thrown exceptions on this client.
void	setInputListener(@Nullable Consumer<String> listener) Sets a listener for all incoming messages from the server.
void	setMessageCutter(@NonNull Cutter cutter) Sets the default message cutter to use for multi-line messages.
void	setMessageSendingQueueSupplier(@NonNull Function<Client.WithManagement,? extends MessageSendingQueue> supplier) Sets the message sending queue supplier.
void	setNetworkHandler(@NonNull NetworkHandler networkHandler) Sets the network handler, for the next time a connection is made.
void	setNick(@NonNull String nick) Sets the nick the client wishes to use.
void	setOutputListener(@Nullable Consumer<String> listener) Sets a listener for all outgoing messages to the server.
void	setServerAddress(@NonNull HostWithPort address) Sets the server address.
void	setUserModes(@NonNull ModeStatusList<UserMode> userModes) Sets the client's user modes.
void	shutdown() Shuts down the client without a quit message.
void	shutdown(@Nullable String reason) Shuts down the client.
void	startSending() Starts sending queued messages.
@NonNull String	toString()
void	updateUserModes(@NonNull ModeStatusList<UserMode> userModes) Updates the client's user modes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kitteh.irc.client.library.Client

builder, getClient, isUser, sendCtcpMessage, sendCtcpReply, sendMessage, sendMultiLineMessage, sendMultiLineMessage, sendMultiLineMessage, sendMultiLineNotice, sendMultiLineNotice, sendMultiLineNotice, sendNotice

Constructor Detail

DefaultClient

public DefaultClient()

Creates a new default client.

Method Detail

initialize

public void initialize(@NonNull String name,
                       @NonNull NetworkHandler networkHandler,
                       @NonNull HostWithPort serverAddress,
                       @Nullable String serverPassword,
                       @Nullable InetSocketAddress bindAddress,
                       @Nullable HostWithPort proxyAddress,
                       @Nullable ProxyType proxyType,
                       @NonNull String nick,
                       @NonNull String userString,
                       @NonNull String realName,
                       @NonNull ActorTracker actorTracker,
                       @NonNull AuthManager authManager,
                       CapabilityManager.WithManagement capabilityManager,
                       @NonNull EventManager eventManager,
                       @NonNull List<EventListenerSupplier> listenerSuppliers,
                       @NonNull MessageTagManager messageTagManager,
                       @NonNull ISupportManager iSupportManager,
                       @Nullable DefaultMessageMap defaultMessageMap,
                       @NonNull Function<Client.WithManagement,? extends MessageSendingQueue> messageSendingQueue,
                       @NonNull Function<Client.WithManagement,? extends ServerInfo.WithManagement> serverInfo,
                       @Nullable Consumer<Exception> exceptionListener,
                       @Nullable Consumer<String> inputListener,
                       @Nullable Consumer<String> outputListener,
                       boolean secure,
                       @Nullable Path secureKeyCertChain,
                       @Nullable Path secureKey,
                       @Nullable String secureKeyPassword,
                       @Nullable TrustManagerFactory trustManagerFactory,
                       @Nullable StsStorageManager stsStorageManager,
                       @Nullable String webircHost,
                       @Nullable InetAddress webircIP,
                       @Nullable String webircPassword,
                       @Nullable String webircGateway)

Description copied from interface: Client.WithManagement

Initialize with pre-connection information.

Specified by:

initialize in interface Client.WithManagement

Parameters:

name - name

networkHandler - networkHandler

serverAddress - serverHostWithPort

serverPassword - serverPassword

bindAddress - bindAddress

proxyAddress - proxyAddress

proxyType - proxyType

nick - nick

userString - userString

realName - realName

actorTracker - actorTracker

authManager - authManager

capabilityManager - capabilityManager

eventManager - eventManager

listenerSuppliers - listenerSuppliers

messageTagManager - messageTagManager

iSupportManager - iSupportManager

defaultMessageMap - defaultMessageMap

messageSendingQueue - messageSendingQueue

serverInfo - serverInfo

exceptionListener - exceptionListener

inputListener - inputListener

outputListener - outputListener

secure - secure

secureKeyCertChain - secureKeyCertChain

secureKey - secureKey

secureKeyPassword - secureKeyPassword

trustManagerFactory - trustManagerFactory

stsStorageManager - stsStorageManager

webircHost - webircHost

webircIP - webircIP

webircPassword - webircPassword

webircGateway - webircUser

addChannel

public void addChannel(String... channels)

Description copied from interface: Client

Adds channels to this client.

Joins the channels if already connected.

Specified by:

addChannel in interface Client

Parameters:

channels - channel(s) to add

See Also:

RequestedChannelJoinCompleteEvent, UnexpectedChannelLeaveEvent

addKeyProtectedChannel

public void addKeyProtectedChannel(@NonNull String channel,
                                   @NonNull String key)

Description copied from interface: Client

Adds a key-protected channel to this client.

Joins the channels if already connected.

Specified by:

addKeyProtectedChannel in interface Client

Parameters:

channel - channel to add

key - channel key

addKeyProtectedChannel

public void addKeyProtectedChannel(Pair<String,String>... channelsAndKeys)

Description copied from interface: Client

Adds key-protected channels to this client.

Joins the channels if already connected.

Specified by:

addKeyProtectedChannel in interface Client

Parameters:

channelsAndKeys - pairs of channel, key

getAuthManager

public @NonNull AuthManager getAuthManager()

Description copied from interface: Client

Gets the authentication manager.

Specified by:

getAuthManager in interface Client

Returns:

auth manager

getBindAddress

public @NonNull InetSocketAddress getBindAddress()

Description copied from interface: Client.WithManagement

Gets the bind address

Specified by:

getBindAddress in interface Client.WithManagement

Returns:

bind address

getCapabilityManager

public CapabilityManager.WithManagement getCapabilityManager()

Description copied from interface: Client

Gets the capability manager.

Specified by:

getCapabilityManager in interface Client

Specified by:

getCapabilityManager in interface Client.WithManagement

Returns:

the capability manager

getChannel

public @NonNull Optional<Channel> getChannel(@NonNull String name)

Description copied from interface: Client

Gets a snapshot of known information about a named channel, if the channel is being tracked by the client. Results should be expected after the client has joined the channel, and will contain as much information as is available to the client at the time of the request.

Specified by:

getChannel in interface Client

Parameters:

name - channel name

Returns:

a channel snapshot of the named channel if tracked by the client

See Also:

Client.getChannels()

getChannels

public @NonNull Set<Channel> getChannels()

Description copied from interface: Client

Gets the channels in which the client is currently present.

Specified by:

getChannels in interface Client

Returns:

the client's current channels

getChannels

public @NonNull Set<Channel> getChannels(@NonNull Collection<String> channels)

Description copied from interface: Client

Gets the channels on the given collection in which the client is currently present.

Specified by:

getChannels in interface Client

Parameters:

channels - collection of channel names to get

Returns:

the client's current channels that are named in the collection

getDefaultMessageMap

public @NonNull DefaultMessageMap getDefaultMessageMap()

Description copied from interface: Client

Gets the message manager for default messages to reply with when certain messages are being sent. Like a KICK, PART, or QUIT reason.

Specified by:

getDefaultMessageMap in interface Client

Returns:

the DefaultMessageMap

getEventManager

public @NonNull EventManager getEventManager()

Description copied from interface: Client

Gets the client's event manager.

Specified by:

getEventManager in interface Client

Returns:

the event manager for this client

getExceptionListener

public @NonNull Listener<Exception> getExceptionListener()

Description copied from interface: Client

Gets the exception listener.

Specified by:

getExceptionListener in interface Client

Returns:

the exception listener

getIntendedNick

public @NonNull String getIntendedNick()

Description copied from interface: Client

Gets the nickname the client intends to possess. May not reflect the current nickname if it's taken. The client will automatically attempt to take back this nickname.

Use Client.getNick() for the current nick.

Specified by:

getIntendedNick in interface Client

Returns:

the nickname the client tries to maintain

getISupportManager

public @NonNull ISupportManager getISupportManager()

Description copied from interface: Client

Gets the manager of ISUPPORT info.

Specified by:

getISupportManager in interface Client

Returns:

the ISUPPORT manager

getStsMachine

public @NonNull Optional<StsMachine> getStsMachine()

Description copied from interface: Client

Gets the STS machine instance, if one is in use.

Specified by:

getStsMachine in interface Client

Returns:

the machine, may not be present

getMessageCutter

public @NonNull Cutter getMessageCutter()

Description copied from interface: Client

Gets the current message cutter for multi-line messages.

Specified by:

getMessageCutter in interface Client

Returns:

message cutter

getMessageSendingQueueSupplier

public @NonNull Function<Client.WithManagement,? extends MessageSendingQueue> getMessageSendingQueueSupplier()

Description copied from interface: Client

Gets the message sending queue supplier. Default supplies a SingleDelaySender with a delay of 1200.

Specified by:

getMessageSendingQueueSupplier in interface Client

Returns:

the supplier

getMessageTagManager

public @NonNull MessageTagManager getMessageTagManager()

Description copied from interface: Client

Gets the message tag manager.

Specified by:

getMessageTagManager in interface Client

Returns:

message tag manager

getName

public @NonNull String getName()

Description copied from interface: Client

Gets the client name. This name is just an internal name for reference and is not visible from IRC.

Specified by:

getName in interface Client

Returns:

the client name

getNick

public @NonNull String getNick()

Description copied from interface: Client

Gets the current nickname the client has.

Specified by:

getNick in interface Client

Returns:

the current nick

getNetworkHandler

public @NonNull NetworkHandler getNetworkHandler()

Description copied from interface: Client.WithManagement

Gets the network handler.

Specified by:

getNetworkHandler in interface Client.WithManagement

Returns:

network handler

getServerInfo

public ServerInfo.WithManagement getServerInfo()

Description copied from interface: Client

Gets information about the server to which the client is currently connected. As long as the client remains connected the information returned by this object will update according to information received from the server. A new one can be acquired from ClientNegotiationCompleteEvent

Specified by:

getServerInfo in interface Client

Specified by:

getServerInfo in interface Client.WithManagement

Returns:

the server information object

getUser

public @NonNull Optional<User> getUser()

Description copied from interface: Client

Gets the User that the client is represented by. Will return Optional.empty() until the Client is in a Channel for which joining has completed, meaning full user info is available.

Specified by:

getUser in interface Client

Returns:

the user of this client if known

getUserModes

public @NonNull Optional<ModeStatusList<UserMode>> getUserModes()

Description copied from interface: Client

Gets the user's modes. Will return Optional.empty() until the Client has queried this information, which is requested after the connection registration has completed.

Specified by:

getUserModes in interface Client

Returns:

user modes of this client if known

knockChannel

public void knockChannel(@NonNull String channelName)

Description copied from interface: Client

KNOCKs on a +i (but not +p) channel, requesting an INVITE.

Specified by:

knockChannel in interface Client

Parameters:

channelName - the channel to send the KNOCK for.

removeChannel

public void removeChannel(@NonNull String channelName)

Description copied from interface: Client

Removes a channel from the client, leaving as necessary.

Specified by:

removeChannel in interface Client

Parameters:

channelName - channel to leave

removeChannel

public void removeChannel(@NonNull String channelName,
                          @Nullable String reason)

Description copied from interface: Client

Removes a channel from the client, leaving as necessary.

Specified by:

removeChannel in interface Client

Parameters:

channelName - channel to leave

reason - part reason

sendCtcpMessage

public void sendCtcpMessage(@NonNull String target,
                            @NonNull String message)

Description copied from interface: Client

Sends a CTCP message to a target user or channel. Automagically adds the CTCP delimiter around the message and escapes the characters that need escaping when sending a CTCP message.

Note: CTCP replies should not be sent this way. Catch the message with the PrivateCtcpQueryEvent and reply there or use Client.sendCtcpReply(String, String)

Specified by:

sendCtcpMessage in interface Client

Parameters:

target - the destination of the message

message - the message to send

sendCtcpReply

public void sendCtcpReply(@NonNull String target,
                          @NonNull String message)

Description copied from interface: Client

Sends a CTCP reply to a target user or channel. Automagically adds the CTCP delimiter around the message and escapes the characters that need escaping when sending a CTCP message.

Specified by:

sendCtcpReply in interface Client

Parameters:

target - the destination of the message

message - the message to send

sendMessage

public void sendMessage(@NonNull String target,
                        @NonNull String message)

Description copied from interface: Client

Sends a message to a target user or channel.

Specified by:

sendMessage in interface Client

Parameters:

target - the destination of the message

message - the message to send

sendMultiLineMessage

public void sendMultiLineMessage(@NonNull String target,
                                 @NonNull String message,
                                 @NonNull Cutter cutter)

Description copied from interface: Client

Sends a potentially multi-line message to a target user or channel using the defined Cutter.

Note that bots may not react appropriately to a message split across multiple lines.

Specified by:

sendMultiLineMessage in interface Client

Parameters:

target - the destination of the message

message - the message to send

cutter - cutter to utilize

sendMultiLineNotice

public void sendMultiLineNotice(@NonNull String target,
                                @NonNull String message,
                                @NonNull Cutter cutter)

Description copied from interface: Client

Sends a potentially multi-line notice to a target user or channel using the defined Cutter.

Note that bots may not react appropriately to a message split across multiple lines.

Specified by:

sendMultiLineNotice in interface Client

Parameters:

target - the destination of the message

message - the message to send

cutter - cutter to utilize

getSecureKey

public @Nullable Path getSecureKey()

Description copied from interface: Client.WithManagement

Gets the TLS key.

Specified by:

getSecureKey in interface Client.WithManagement

Returns:

key

getSecureKeyCertChain

public @Nullable Path getSecureKeyCertChain()

Description copied from interface: Client.WithManagement

Gets the TLS key certificate chain.

Specified by:

getSecureKeyCertChain in interface Client.WithManagement

Returns:

key cert chain

getSecureKeyPassword

public @Nullable String getSecureKeyPassword()

Description copied from interface: Client.WithManagement

Gets the TLS key password.

Specified by:

getSecureKeyPassword in interface Client.WithManagement

Returns:

password

getSecureTrustManagerFactory

public @Nullable TrustManagerFactory getSecureTrustManagerFactory()

Description copied from interface: Client.WithManagement

Gets the trust manager factory.

Specified by:

getSecureTrustManagerFactory in interface Client.WithManagement

Returns:

trust manager factory

getServerAddress

public @NonNull HostWithPort getServerAddress()

Description copied from interface: Client.WithManagement

Gets the server address

Specified by:

getServerAddress in interface Client.WithManagement

Returns:

server address

getProxyType

public @NonNull Optional<ProxyType> getProxyType()

Description copied from interface: Client.WithManagement

Gets if the client is configured to use a proxy.

Specified by:

getProxyType in interface Client.WithManagement

Returns:

true if configured for proxy

getProxyAddress

public @NonNull Optional<HostWithPort> getProxyAddress()

Description copied from interface: Client.WithManagement

Gets the proxy address

Specified by:

getProxyAddress in interface Client.WithManagement

Returns:

proxy address

sendNotice

public void sendNotice(@NonNull String target,
                       @NonNull String message)

Description copied from interface: Client

Sends a notice to a target user or channel.

Specified by:

sendNotice in interface Client

Parameters:

target - the destination of the message

message - the message to send

sendRawLine

public void sendRawLine(@NonNull String message)

Description copied from interface: Client

Sends a raw IRC message.

Specified by:

sendRawLine in interface Client

Parameters:

message - message to send

sendRawLineAvoidingDuplication

public void sendRawLineAvoidingDuplication(@NonNull String message)

Description copied from interface: Client

Sends a raw IRC message, unless the exact same message is already in the queue of messages not yet sent.

Specified by:

sendRawLineAvoidingDuplication in interface Client

Parameters:

message - message to send

sendRawLineImmediately

public void sendRawLineImmediately(@NonNull String message)

Description copied from interface: Client

Sends a raw IRC message, disregarding message delays and all sanity. Live life on the wild side with this method designed to ensure you get flood-kicked before you finish dumping your life's work into chat.

Specified by:

sendRawLineImmediately in interface Client

Parameters:

message - message to send dangerously, you monster

setExceptionListener

public void setExceptionListener(@Nullable Consumer<Exception> listener)

Description copied from interface: Client

Sets a listener for all thrown exceptions on this client.

All exceptions are passed from a single, separate thread.

Specified by:

setExceptionListener in interface Client

Parameters:

listener - catcher of throwable objects

setDefaultMessageMap

public void setDefaultMessageMap(@NonNull DefaultMessageMap defaults)

Description copied from interface: Client

Sets the message manager for default messages to reply with when certain messages are being sent. Like a KICK, PART, or QUIT reason.

Specified by:

setDefaultMessageMap in interface Client

Parameters:

defaults - DefaultMessageMap to set

setInputListener

public void setInputListener(@Nullable Consumer<String> listener)

Description copied from interface: Client

Sets a listener for all incoming messages from the server.

All messages are passed from a single, separate thread.

Specified by:

setInputListener in interface Client

Parameters:

listener - input listener

setMessageCutter

public void setMessageCutter(@NonNull Cutter cutter)

Description copied from interface: Client

Sets the default message cutter to use for multi-line messages.

Specified by:

setMessageCutter in interface Client

Parameters:

cutter - cutter to set

setMessageSendingQueueSupplier

public void setMessageSendingQueueSupplier(@NonNull Function<Client.WithManagement,? extends MessageSendingQueue> supplier)

Description copied from interface: Client

Sets the message sending queue supplier.

Specified by:

setMessageSendingQueueSupplier in interface Client

Parameters:

supplier - the supplier

setNetworkHandler

public void setNetworkHandler(@NonNull NetworkHandler networkHandler)

Description copied from interface: Client.WithManagement

Sets the network handler, for the next time a connection is made.

Specified by:

setNetworkHandler in interface Client.WithManagement

Parameters:

networkHandler - new network handler

setNick

public void setNick(@NonNull String nick)

Description copied from interface: Client

Sets the nick the client wishes to use.

Specified by:

setNick in interface Client

Parameters:

nick - new nickname

setOutputListener

public void setOutputListener(@Nullable Consumer<String> listener)

Description copied from interface: Client

Sets a listener for all outgoing messages to the server.

All messages are passed from a single, separate thread.

Specified by:

setOutputListener in interface Client

Parameters:

listener - output listener

shutdown

public void shutdown()

Description copied from interface: Client

Shuts down the client without a quit message.

Specified by:

shutdown in interface Client

shutdown

public void shutdown(@Nullable String reason)

Description copied from interface: Client

Shuts down the client.

Specified by:

shutdown in interface Client

Parameters:

reason - quit message to send

toString

public @NonNull String toString()

Overrides:

toString in class Object

processLine

public void processLine(@NonNull String line)

Queue up a line for processing.

Specified by:

processLine in interface Client.WithManagement

Parameters:

line - line to be processed

getActorTracker

public @NonNull ActorTracker getActorTracker()

Description copied from interface: Client.WithManagement

Gets the actor tracker.

Specified by:

getActorTracker in interface Client.WithManagement

Returns:

actor tracker

isConnectionAlive

public boolean isConnectionAlive()

Description copied from interface: Client.WithManagement

Gets if the connection is alive.

Specified by:

isConnectionAlive in interface Client.WithManagement

Returns:

true if connection is alive

getInputListener

public @NonNull Listener<String> getInputListener()

Description copied from interface: Client.WithManagement

Gets the currently set input listener.

Specified by:

getInputListener in interface Client.WithManagement

Returns:

input listener

getIntendedChannels

public @NonNull Set<String> getIntendedChannels()

Description copied from interface: Client.WithManagement

Gets the channels the client intends to join.

Specified by:

getIntendedChannels in interface Client.WithManagement

Returns:

intended channels

getOutputListener

public @NonNull Listener<String> getOutputListener()

Description copied from interface: Client.WithManagement

Gets the currently set output listener.

Specified by:

getOutputListener in interface Client.WithManagement

Returns:

output listener

getRequestedNick

public @NonNull String getRequestedNick()

Description copied from interface: Client.WithManagement

Gets the nickname the client has last requested.

Specified by:

getRequestedNick in interface Client.WithManagement

Returns:

requested nick

connect

public void connect()

Description copied from interface: Client

Begin connecting to the server.

Specified by:

connect in interface Client

beginMessageSendingImmediate

public void beginMessageSendingImmediate(@NonNull Consumer<String> consumer)

Description copied from interface: Client.WithManagement

Starts the sending of queued 'immediately' messages.

Specified by:

beginMessageSendingImmediate in interface Client.WithManagement

Parameters:

consumer - consumer with which to handle this queue

pauseMessageSending

public void pauseMessageSending()

Description copied from interface: Client.WithManagement

Pauses message sending, waiting for next successful connection.

Specified by:

pauseMessageSending in interface Client.WithManagement

ping

public void ping()

Description copied from interface: Client.WithManagement

Sends a PING.

Specified by:

ping in interface Client.WithManagement

sendNickChange

public void sendNickChange(@NonNull String newNick)

Description copied from interface: Client.WithManagement

Sends a nick change request.

Specified by:

sendNickChange in interface Client.WithManagement

Parameters:

newNick - new nickname

setCurrentNick

public void setCurrentNick(@NonNull String nick)

Description copied from interface: Client.WithManagement

Sets the current nickname the client knows it has.

Specified by:

setCurrentNick in interface Client.WithManagement

Parameters:

nick - nickname

setServerAddress

public void setServerAddress(@NonNull HostWithPort address)

Description copied from interface: Client.WithManagement

Sets the server address.

Specified by:

setServerAddress in interface Client.WithManagement

Parameters:

address - server address

setUserModes

public void setUserModes(@NonNull ModeStatusList<UserMode> userModes)

Description copied from interface: Client.WithManagement

Sets the client's user modes.

Specified by:

setUserModes in interface Client.WithManagement

Parameters:

userModes - user modes to set

startSending

public void startSending()

Description copied from interface: Client.WithManagement

Starts sending queued messages.

Specified by:

startSending in interface Client.WithManagement

updateUserModes

public void updateUserModes(@NonNull ModeStatusList<UserMode> userModes)

Description copied from interface: Client.WithManagement

Updates the client's user modes.

Specified by:

updateUserModes in interface Client.WithManagement

Parameters:

userModes - mode changes

reconnect

public void reconnect()

Description copied from interface: Client

Triggers a reconnect, quitting with the default DefaultMessageType.RECONNECT message.

Specified by:

reconnect in interface Client

reconnect

public void reconnect(@Nullable String reason)

Description copied from interface: Client

Triggers a reconnect, quitting with the given reason.

Specified by:

reconnect in interface Client

Parameters:

reason - disconnect reason

isSecureConnection

public boolean isSecureConnection()

Description copied from interface: Client.WithManagement

Gets if the client is configured for a secure connection.

Specified by:

isSecureConnection in interface Client.WithManagement

Returns:

true if configured for secure

commands

public @NonNull Client.Commands commands()

Description copied from interface: Client

Provides access to Commands.

Specified by:

commands in interface Client

Returns:

commands