Package com.github.twitch4j.common.pool

Class TwitchModuleConnectionPool<C,X,Y,Z,B>

java.lang.Object

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

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

com.github.twitch4j.common.pool.TwitchModuleConnectionPool<C,X,Y,Z,B>

Type Parameters:

B - the builder of the connection

All Implemented Interfaces:

TransactionalSubscriber<X,Y,Z>, AutoCloseable

Direct Known Subclasses:

TwitchChatConnectionPool, TwitchPubSubConnectionPool, TwitchSingleUserEventSocketPool

public abstract class TwitchModuleConnectionPool<C,X,Y,Z,B>
extends SubscriptionConnectionPool<C,X,Y,Z>

Adds common configuration options for subscription-based connection pools built around instances of T4J modules.

A pool of connections for making subscriptions (and potentially unsubscribing from later).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	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>>

Nested classes/interfaces inherited from class 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>>

Nested classes/interfaces inherited from class com.github.twitch4j.common.pool.AbstractConnectionPool

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull Function<@NonNull B,@NonNull B>	advancedConfiguration	Further configuration that should be applied to the builder when creating new connections.
protected final @NonNull Supplier<ScheduledThreadPoolExecutor>	executor	The ScheduledThreadPoolExecutor to be used by connections in this pool, if specified.
protected final @NonNull Supplier<ProxyConfig>	proxyConfig	The ProxyConfig to be used by connections in this pool, if specified.

Fields inherited from class com.github.twitch4j.common.pool.SubscriptionConnectionPool

closed, disposeUnusedConnections, maxSubscriptionsPerConnection, saturatedConnections, subscriptions, unsaturatedConnections

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TwitchModuleConnectionPool(TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<C,X,Y,Z,B,?,?> b)

Method Summary

Modifier and Type	Method	Description
protected com.github.philippheuer.events4j.core.EventManager	getConnectionEventManager()
protected com.github.philippheuer.events4j.core.EventManager	getDefaultConnectionEventManager()
com.github.philippheuer.events4j.core.EventManager	getEventManager()	The default EventManager for this connection pool, if specified.
protected @NonNull ScheduledThreadPoolExecutor	getExecutor(String namePrefix, int poolSize)

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

close, getConnections, getRequestFromSubscription, getSubscriptionSize, handleDuplicateSubscription, handleSubscription, handleUnsubscription, numConnections, numSubscriptions, subscribe, unsubscribe

Methods inherited from class com.github.twitch4j.common.pool.AbstractConnectionPool

createConnection, disposeConnection

Methods inherited from class java.lang.Object

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

Field Details

executor

@NonNull
protected final @NonNull Supplier<ScheduledThreadPoolExecutor> executor

The ScheduledThreadPoolExecutor to be used by connections in this pool, if specified.

proxyConfig

@NonNull
protected final @NonNull Supplier<ProxyConfig> proxyConfig

The ProxyConfig to be used by connections in this pool, if specified.

advancedConfiguration

@NonNull
protected final @NonNull Function<@NonNull B,@NonNull B> advancedConfiguration

Further configuration that should be applied to the builder when creating new connections.

Constructor Details

TwitchModuleConnectionPool

protected TwitchModuleConnectionPool(TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<C,X,Y,Z,B,?,?> b)

Method Details

getExecutor

@NonNull
protected @NonNull ScheduledThreadPoolExecutor getExecutor(String namePrefix,
 int poolSize)

getConnectionEventManager

protected com.github.philippheuer.events4j.core.EventManager getConnectionEventManager()

Returns:

a EventManager to be used in the construction of a new connection

getDefaultConnectionEventManager

protected com.github.philippheuer.events4j.core.EventManager getDefaultConnectionEventManager()

Returns:

the EventManager to use if none was specified by the user for the connection-level

getEventManager

public com.github.philippheuer.events4j.core.EventManager getEventManager()

The default EventManager for this connection pool, if specified.