Package com.github.twitch4j.common.pool

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

java.lang.Object

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

com.github.twitch4j.common.pool.SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2,B>

Direct Known Subclasses:

TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder

Enclosing class:

SubscriptionConnectionPool<C,S,T,U>

public abstract static class SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2 extends SubscriptionConnectionPool<C,S,T,U>,B extends SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2,B>>
extends AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2,B>

Constructor Summary

Constructors

Constructor	Description
SubscriptionConnectionPoolBuilder()

Method Summary

Modifier and Type	Method	Description
abstract C2	build()
B	disposeUnusedConnections(boolean disposeUnusedConnections)	Whether connections without subscriptions should be disposed of.
B	maxSubscriptionsPerConnection(int maxSubscriptionsPerConnection)	The maximum number of outstanding subscriptions a connection may have.
protected abstract B	self()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionConnectionPoolBuilder

public SubscriptionConnectionPoolBuilder()

Method Details

disposeUnusedConnections

public B disposeUnusedConnections(boolean disposeUnusedConnections)

Whether connections without subscriptions should be disposed of. Default: true.

As an optimization, this can be set to false to not dispose of connections in an environment where it is known that a large burst of unsubscriptions will be followed by enough subscriptions such that connections will never need to be disposed of automatically. However, be wary of configuring this as a misstep in your calculations may lead to connections sitting idly while consuming resources.

Returns:

this.

maxSubscriptionsPerConnection

public B maxSubscriptionsPerConnection(int maxSubscriptionsPerConnection)

The maximum number of outstanding subscriptions a connection may have. Default: 50.

50 is a reasonable default given that it is the standard limit imposed on PubSub connections by Twitch and it is the previously-documented rate-limit on the number of possible JOINs in chat in a short burst.

Returns:

this.

See Also:

• PubSub Limits
• Previous Chat Limits

self

protected abstract B self()

Specified by:

self in class AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2 extends SubscriptionConnectionPool<C,S,T,U>,B extends SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2,B>>

build

public abstract C2 build()

Specified by:

build in class AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2 extends SubscriptionConnectionPool<C,S,T,U>,B extends SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2,B>>

toString

public String toString()

Overrides:

toString in class AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2 extends SubscriptionConnectionPool<C,S,T,U>,B extends SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2,B>>