org.pircbotx

Class MultiBotManager

java.lang.Object

org.pircbotx.MultiBotManager

public class MultiBotManager
extends Object

Manager that makes connecting and running multiple bots an easy, painless process.

Lifecycle:

1. When created, any added bots or configurations are queued
2. When start() is called, all queued bots are connected. Any bots added after this point are automatically connected
3. When stop() is called, OutputIRC.quitServer() is called on all bots. No more bots can be added, the Manager is finished. Note that an optional stopAndWait() method is provided to block until all bots shutdown

executeBot(org.pircbotx.PircBotX) is overridable if you wish to do your own connecting

Author:

Leon Blakey

Constructor Summary

Constructors

Constructor and Description
MultiBotManager() Create MultiBotManager with a cached thread pool.
MultiBotManager(ExecutorService botPool) Create MultiBotManager with the specified thread pool.

Method Summary

Modifier and Type	Method and Description
void	addBot(Configuration config) Alias of addNetwork(org.pircbotx.Configuration)
void	addBot(PircBotX bot) Alias of addNetwork(org.pircbotx.PircBotX)
void	addNetwork(Configuration config) Adds a managed bot using the specified configuration.
void	addNetwork(PircBotX bot) Adds a bot to be managed.
<B extends PircBotX> B	getBotById(int id) Lookup a managed bot by id.
com.google.common.collect.ImmutableSortedSet<PircBotX>	getBots() Get all the bots that this MultiBotManager is managing.
void	start() Start the manager, connecting all queued bots.
void	stop() Stop with no quit message
void	stop(String quitMessage) Disconnect all bots from their respective severs cleanly.
void	stopAndWait() stop() and wait for all bots to disconnect.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiBotManager

public MultiBotManager()

Create MultiBotManager with a cached thread pool.

MultiBotManager

public MultiBotManager(ExecutorService botPool)

Create MultiBotManager with the specified thread pool.

Parameters:

botPool - A provided thread pool.

Method Detail

addBot

public void addBot(Configuration config)

Alias of addNetwork(org.pircbotx.Configuration)

Parameters:

config -

See Also:

addNetwork(org.pircbotx.Configuration)

addNetwork

public void addNetwork(Configuration config)

Adds a managed bot using the specified configuration.

Parameters:

config - A configuration to pass to the created bot

addBot

public void addBot(PircBotX bot)

Alias of addNetwork(org.pircbotx.PircBotX)

Parameters:

bot -

See Also:

addNetwork(org.pircbotx.PircBotX)

addNetwork

public void addNetwork(PircBotX bot)

Adds a bot to be managed.

Parameters:

bot - An existing unconnected bot

start

public void start()

Start the manager, connecting all queued bots.

stop

public void stop()

Stop with no quit message

See Also:

stop(java.lang.String)

stop

public void stop(String quitMessage)

Disconnect all bots from their respective severs cleanly.

stopAndWait

public void stopAndWait()
                 throws InterruptedException

stop() and wait for all bots to disconnect.

Throws:

InterruptedException - If this is interrupted while waiting

getBots

public com.google.common.collect.ImmutableSortedSet<PircBotX> getBots()

Get all the bots that this MultiBotManager is managing.

Returns:

An immutable copy of bots that are being managed

getBotById

public <B extends PircBotX> B getBotById(int id)

Lookup a managed bot by id.

Parameters:

id - The id of the bot

Returns:

A bot that has the specified id or null