Package com.github.twitch4j.chat

Class TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C extends TwitchChatConnectionPool,B extends TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>>

java.lang.Object

com.github.twitch4j.common.pool.AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2,B>

com.github.twitch4j.common.pool.SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,X,Y,Z,C2,B2>

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

com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>

Enclosing class:

TwitchChatConnectionPool

public abstract static class TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C extends TwitchChatConnectionPool,B extends TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>>
extends TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<TwitchChat,String,String,Boolean,TwitchChatBuilder,C,B>

Constructor Summary

Constructors

Constructor	Description
TwitchChatConnectionPoolBuilder()

Method Summary

Modifier and Type	Method	Description
B	authRateLimit(io.github.bucket4j.Bandwidth authRateLimit)	Custom RateLimit for AUTH
B	automaticallyPartOnBan(boolean automaticallyPartOnBan)	Deprecated. use removeChannelOnJoinFailure via advancedConfiguration instead.
abstract C	build()
B	chatAccount(@NonNull Supplier<com.github.philippheuer.credentialmanager.domain.OAuth2Credential> chatAccount)	Provides a chat account to be used when constructing a new TwitchChat instance.
B	chatRateLimit(io.github.bucket4j.Bandwidth chatRateLimit)	Custom RateLimit for ChatMessages
B	connectionBackoffStrategy(IBackoffStrategy connectionBackoffStrategy)	WebSocket Connection Backoff Strategy
B	joinRateLimit(io.github.bucket4j.Bandwidth joinRateLimit)	Custom RateLimit for JOIN/PART
B	perChannelRateLimit(io.github.bucket4j.Bandwidth perChannelRateLimit)	Custom RateLimit for Messages per Channel
protected abstract B	self()
String	toString()
B	whisperRateLimit(io.github.bucket4j.Bandwidth[] whisperRateLimit)	Custom RateLimit for Whispers

Methods inherited from class com.github.twitch4j.common.pool.TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder

advancedConfiguration, connectionEventManager, eventManager, executor, proxyConfig

Methods inherited from class com.github.twitch4j.common.pool.SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder

disposeUnusedConnections, maxSubscriptionsPerConnection

Methods inherited from class java.lang.Object

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

Constructor Details

TwitchChatConnectionPoolBuilder

public TwitchChatConnectionPoolBuilder()

Method Details

chatAccount

public B chatAccount(@NonNull
 @NonNull Supplier<com.github.philippheuer.credentialmanager.domain.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.

Returns:

this.

automaticallyPartOnBan

@Deprecated
public B automaticallyPartOnBan(boolean automaticallyPartOnBan)

Deprecated.

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.

Returns:

this.

chatRateLimit

public B chatRateLimit(io.github.bucket4j.Bandwidth chatRateLimit)

Custom RateLimit for ChatMessages

Returns:

this.

whisperRateLimit

public B whisperRateLimit(io.github.bucket4j.Bandwidth[] whisperRateLimit)

Custom RateLimit for Whispers

Returns:

this.

joinRateLimit

public B joinRateLimit(io.github.bucket4j.Bandwidth joinRateLimit)

Custom RateLimit for JOIN/PART

Returns:

this.

authRateLimit

public B authRateLimit(io.github.bucket4j.Bandwidth authRateLimit)

Custom RateLimit for AUTH

Returns:

this.

perChannelRateLimit

public B perChannelRateLimit(io.github.bucket4j.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).

Returns:

this.

connectionBackoffStrategy

public B connectionBackoffStrategy(IBackoffStrategy connectionBackoffStrategy)

WebSocket Connection Backoff Strategy

Returns:

this.

self

protected abstract B self()

Specified by:

self in class TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<TwitchChat,String,String,Boolean,TwitchChatBuilder,C extends TwitchChatConnectionPool,B extends TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<TwitchChat,String,String,Boolean,TwitchChatBuilder,C extends TwitchChatConnectionPool,B extends TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<TwitchChat,String,String,Boolean,TwitchChatBuilder,C extends TwitchChatConnectionPool,B extends TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>>