Package com.github.twitch4j.chat

Klasse TwitchChatConnectionPool

java.lang.Object

com.github.twitch4j.common.pool.AbstractConnectionPool<TwitchChat>

com.github.twitch4j.common.pool.SubscriptionConnectionPool<TwitchChat,String,String,Boolean>

com.github.twitch4j.common.pool.TwitchModuleConnectionPool<TwitchChat,String,String,Boolean,TwitchChatBuilder>

com.github.twitch4j.chat.TwitchChatConnectionPool

Alle implementierten Schnittstellen:

ITwitchChat, TransactionalSubscriber<String,String,Boolean>, AutoCloseable

public class TwitchChatConnectionPool
extends TwitchModuleConnectionPool<TwitchChat,String,String,Boolean,TwitchChatBuilder>
implements ITwitchChat

A pool for TwitchChat connections.

This pool is easiest to use for:

• Reading from many channels without an account
• Reading from many channels with an account
• Reading from many channels using valid proxies
• Reading and sending messages/whispers with only one account

Other applications are possible, but harder to configure. See below for a list of warnings.

Warning: If a custom ScheduledThreadPoolExecutor is specified, its corePoolSize must be large enough for the threads required by connections made by this class.

Warning: If a chatAccount is to be shared across multiple connections and used to send messages, one should use advancedConfiguration to ensure the two are using a shared Bucket.

Note: If whispers are to be sent using this pool, one must manually join the channel to send the whisper from first. If chatAccount's are dynamically supplied such that no two connections are using the same account, one can set twitchChatBuilder.withAutoJoinOwnChannel(true) via advancedConfiguration to avoid the manual join.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C extends TwitchChatConnectionPool,B extends TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>>

Von Klasse geerbte verschachtelte Klassen/Schnittstellen com.github.twitch4j.common.pool.TwitchModuleConnectionPool

TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<C,X,Y,Z,B,C2 extends TwitchModuleConnectionPool<C,X,Y,Z,B>,B2 extends TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<C,X,Y,Z,B,C2,B2>>

Von Klasse geerbte verschachtelte Klassen/Schnittstellen com.github.twitch4j.common.pool.SubscriptionConnectionPool

SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2 extends SubscriptionConnectionPool<C,S,T,U>,B extends SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2,B>>

Von Klasse geerbte verschachtelte Klassen/Schnittstellen com.github.twitch4j.common.pool.AbstractConnectionPool

AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2 extends AbstractConnectionPool<C>,B extends AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2,B>>

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected Bandwidth	authRateLimit	Custom RateLimit for AUTH
protected final boolean	automaticallyPartOnBan	Veraltet. use removeChannelOnJoinFailure via advancedConfiguration instead.
protected final @NonNull Supplier<OAuth2Credential>	chatAccount	Provides a chat account to be used when constructing a new TwitchChat instance.
protected Bandwidth	chatRateLimit	Custom RateLimit for ChatMessages
protected Bandwidth	joinRateLimit	Custom RateLimit for JOIN/PART
protected Bandwidth	perChannelRateLimit	Custom RateLimit for Messages per Channel
protected Bandwidth[]	whisperRateLimit	Custom RateLimit for Whispers

Von Klasse geerbte Felder com.github.twitch4j.common.pool.TwitchModuleConnectionPool

advancedConfiguration, executor, proxyConfig

Von Klasse geerbte Felder com.github.twitch4j.common.pool.SubscriptionConnectionPool

closed, disposeUnusedConnections, maxSubscriptionsPerConnection, saturatedConnections, subscriptions, unsaturatedConnections

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	TwitchChatConnectionPool(TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<?,?> b)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<?,?>	builder()
protected TwitchChat	createConnection()
protected void	disposeConnection(TwitchChat connection)
Map<String,String>	getChannelIdToChannelName()	Note: this map does not dynamically update unlike TwitchChat.getChannelIdToChannelName()
Map<String,String>	getChannelNameToChannelId()	Note: this map does not dynamically update unlike TwitchChat.getChannelNameToChannelId()
Set<String>	getChannels()	Returns a set of all currently joined channels (without # prefix)
long	getLatency()
protected String	getRequestFromSubscription(String s)
protected int	getSubscriptionSize(String s)
protected String	handleDuplicateSubscription(TwitchChat twitchChat, TwitchChat old, String s)
protected String	handleSubscription(TwitchChat twitchChat, String s)
protected Boolean	handleUnsubscription(TwitchChat twitchChat, String s)
boolean	isChannelJoined(String channelName)	Check if Chat is currently in a channel
void	joinChannel(String channelName)	Joins a channel
boolean	leaveChannel(String channelName)	Parts from a channel
boolean	sendMessage(String channelToIdentifyChatInstance, String targetChannel, String message)	Sends a message from the TwitchChat identified either to a channel or directly on the socket.
boolean	sendMessage(String channelToIdentifyChatInstance, String targetChannel, String message, String nonce, String replyMsgId)	Sends a message from the identified TwitchChat instance with an optional nonce or reply parent.
boolean	sendMessage(String channelToIdentifyChatInstance, String targetChannel, String message, @Nullable Map<String,Object> tags)	Sends a message from the identified TwitchChat instance with the specified tags.
boolean	sendMessage(String channel, String message, @Nullable Map<String,Object> tags)	Sends a message to the channel while including the specified message tags.
boolean	sendPrivateMessage(String channelToIdentifyChatInstance, String toChannel, String message)	Veraltet. Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
String	subscribe(String s)	Joins a channel.
Boolean	unsubscribe(String s)	Parts from a channel.

Von Klasse geerbte Methoden com.github.twitch4j.common.pool.TwitchModuleConnectionPool

getConnectionEventManager, getDefaultConnectionEventManager, getEventManager, getExecutor

Von Klasse geerbte Methoden com.github.twitch4j.common.pool.SubscriptionConnectionPool

close, getConnections, numConnections, numSubscriptions

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden com.github.twitch4j.chat.ITwitchChat

ban, clearChat, close, delete, getEventManager, sendActionMessage, sendAnnouncement, sendMessage, sendMessage, setEmoteOnly, setFollowersOnly, setSlowMode, setSubscribersOnly, setUniqueChat, timeout, unban

Felddetails

chatAccount

@NonNull
protected final @NonNull Supplier<OAuth2Credential> chatAccount

Provides a chat account to be used when constructing a new TwitchChat instance. By default, this yields null, which corresponds to an anonymous connection.

automaticallyPartOnBan

@Deprecated
protected final boolean automaticallyPartOnBan

Veraltet.

use removeChannelOnJoinFailure via advancedConfiguration instead.

Whether chat connections should automatically part from channels they have been banned from. This is useful for reclaiming subscription headroom so a minimal number of chat instances are running. By default false so that a chat instance can (eventually) reconnect if a unban occurs.

chatRateLimit

protected Bandwidth chatRateLimit

Custom RateLimit for ChatMessages

whisperRateLimit

protected Bandwidth[] whisperRateLimit

Custom RateLimit for Whispers

joinRateLimit

protected Bandwidth joinRateLimit

Custom RateLimit for JOIN/PART

authRateLimit

protected Bandwidth authRateLimit

Custom RateLimit for AUTH

perChannelRateLimit

protected Bandwidth perChannelRateLimit

Custom RateLimit for Messages per Channel

For example, this can restrict messages per channel at 100/30 (for a verified bot that has a global 7500/30 message limit).

Konstruktordetails

TwitchChatConnectionPool

protected TwitchChatConnectionPool(TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<?,?> b)

Methodendetails

sendMessage

public boolean sendMessage(String channel,
 String message,
 @Nullable
 @Nullable Map<String,Object> tags)

Beschreibung aus Schnittstelle kopiert: ITwitchChat

Sends a message to the channel while including the specified message tags.

Angegeben von:

sendMessage in Schnittstelle ITwitchChat

Parameter:

channel - the name of the channel to send the message to.

message - the message to be sent.

tags - the message tags.

Gibt zurück:

whether the message was added to the queue

sendMessage

public boolean sendMessage(String channelToIdentifyChatInstance,
 String targetChannel,
 String message)

Sends a message from the TwitchChat identified either to a channel or directly on the socket.

Parameter:

channelToIdentifyChatInstance - the channel used to identify which TwitchChat instance should be used to send the message; the instance must be subscribed to this channel.

targetChannel - the channel to send the message to, if not null (otherwise it is sent directly on the socket).

message - the message to be sent.

Gibt zurück:

whether a TwitchChat instance was found and used to send the message

sendMessage

public boolean sendMessage(String channelToIdentifyChatInstance,
 String targetChannel,
 String message,
 @Unofficial
 String nonce,
 String replyMsgId)

Sends a message from the identified TwitchChat instance with an optional nonce or reply parent.

Parameter:

channelToIdentifyChatInstance - the channel used to identify which TwitchChat instance should be used to send the message; the instance must be subscribed to this channel.

targetChannel - the channel to send the message to, if not null (otherwise it is sent directly on the socket).

message - the message to be sent.

nonce - the cryptographic nonce (optional).

replyMsgId - the msgId of the parent message being replied to (optional).

Gibt zurück:

whether a TwitchChat instance was found and used to send the message

sendMessage

public boolean sendMessage(String channelToIdentifyChatInstance,
 String targetChannel,
 String message,
 @Nullable
 @Nullable Map<String,Object> tags)

Sends a message from the identified TwitchChat instance with the specified tags.

Parameter:

channelToIdentifyChatInstance - the channel used to identify which TwitchChat instance should be used to send the message; the instance must be subscribed to this channel.

targetChannel - the channel to send the message to, if not null (otherwise it is sent directly on the socket).

message - the message to be sent.

tags - the message tags.

Gibt zurück:

whether a TwitchChat instance was found and used to send the message

sendPrivateMessage

@Deprecated
public boolean sendPrivateMessage(String channelToIdentifyChatInstance,
 String toChannel,
 String message)

Veraltet.

Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings

Sends a whisper.

Parameter:

channelToIdentifyChatInstance - the channel used to identify which TwitchChat instance should be used to send the message; the instance must be subscribed to this channel.

toChannel - the channel to send the whisper to.

message - the message to send in the whisper.

Gibt zurück:

whether a TwitchChat instance was identified to send the message from.

Löst aus:

NullPointerException - if the identified TwitchChat does not have a valid chatCredential

subscribe

public String subscribe(String s)

Joins a channel.

Angegeben von:

subscribe in Schnittstelle TransactionalSubscriber<String,String,Boolean>

Setzt außer Kraft:

subscribe in Klasse SubscriptionConnectionPool<TwitchChat,String,String,Boolean>

Parameter:

s - the channel name

Gibt zurück:

the channel name

joinChannel

public void joinChannel(String channelName)

Beschreibung aus Schnittstelle kopiert: ITwitchChat

Joins a channel

Angegeben von:

joinChannel in Schnittstelle ITwitchChat

Parameter:

channelName - The target channel name.

unsubscribe

public Boolean unsubscribe(String s)

Parts from a channel.

Angegeben von:

unsubscribe in Schnittstelle TransactionalSubscriber<String,String,Boolean>

Setzt außer Kraft:

unsubscribe in Klasse SubscriptionConnectionPool<TwitchChat,String,String,Boolean>

Parameter:

s - the channel name

Gibt zurück:

a non-null class if able to part, null otherwise

leaveChannel

public boolean leaveChannel(String channelName)

Beschreibung aus Schnittstelle kopiert: ITwitchChat

Parts from a channel

Angegeben von:

leaveChannel in Schnittstelle ITwitchChat

Parameter:

channelName - The target channel name.

Gibt zurück:

whether the channel was previously joined

isChannelJoined

public boolean isChannelJoined(String channelName)

Beschreibung aus Schnittstelle kopiert: ITwitchChat

Check if Chat is currently in a channel

Angegeben von:

isChannelJoined in Schnittstelle ITwitchChat

Parameter:

channelName - channel to check (without # prefix)

Gibt zurück:

boolean

getChannels

public Set<String> getChannels()

Beschreibung aus Schnittstelle kopiert: ITwitchChat

Returns a set of all currently joined channels (without # prefix)

Angegeben von:

getChannels in Schnittstelle ITwitchChat

Gibt zurück:

a set of channel names

handleSubscription

protected String handleSubscription(TwitchChat twitchChat,
 String s)

Angegeben von:

handleSubscription in Klasse SubscriptionConnectionPool<TwitchChat,String,String,Boolean>

handleDuplicateSubscription

protected String handleDuplicateSubscription(TwitchChat twitchChat,
 TwitchChat old,
 String s)

Angegeben von:

handleDuplicateSubscription in Klasse SubscriptionConnectionPool<TwitchChat,String,String,Boolean>

handleUnsubscription

protected Boolean handleUnsubscription(TwitchChat twitchChat,
 String s)

Angegeben von:

handleUnsubscription in Klasse SubscriptionConnectionPool<TwitchChat,String,String,Boolean>

getRequestFromSubscription

protected String getRequestFromSubscription(String s)

Angegeben von:

getRequestFromSubscription in Klasse SubscriptionConnectionPool<TwitchChat,String,String,Boolean>

getSubscriptionSize

protected int getSubscriptionSize(String s)

Angegeben von:

getSubscriptionSize in Klasse SubscriptionConnectionPool<TwitchChat,String,String,Boolean>

createConnection

protected TwitchChat createConnection()

Angegeben von:

createConnection in Klasse AbstractConnectionPool<TwitchChat>

disposeConnection

protected void disposeConnection(TwitchChat connection)

Angegeben von:

disposeConnection in Klasse AbstractConnectionPool<TwitchChat>

getLatency

public long getLatency()

Angegeben von:

getLatency in Schnittstelle ITwitchChat

Gibt zurück:

the most recently measured round-trip latency for the socket(s) in milliseconds, or -1 if unknown

getChannelIdToChannelName

public Map<String,String> getChannelIdToChannelName()

Note: this map does not dynamically update unlike TwitchChat.getChannelIdToChannelName()

Angegeben von:

getChannelIdToChannelName in Schnittstelle ITwitchChat

Gibt zurück:

cached mappings of channel ids to names

getChannelNameToChannelId

public Map<String,String> getChannelNameToChannelId()

Note: this map does not dynamically update unlike TwitchChat.getChannelNameToChannelId()

Angegeben von:

getChannelNameToChannelId in Schnittstelle ITwitchChat

Gibt zurück:

cached mappings of channel names to ids

builder

public static TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<?,?> builder()