Package com.github.twitch4j.pubsub

Klasse TwitchPubSubConnectionPool

java.lang.Object

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

com.github.twitch4j.common.pool.SubscriptionConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean>

com.github.twitch4j.common.pool.TwitchModuleConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean,TwitchPubSubBuilder>

com.github.twitch4j.pubsub.TwitchPubSubConnectionPool

Alle implementierten Schnittstellen:

TransactionalSubscriber<PubSubRequest,PubSubSubscription,Boolean>, ITwitchPubSub, AutoCloseable

public class TwitchPubSubConnectionPool
extends TwitchModuleConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean,TwitchPubSubBuilder>
implements ITwitchPubSub

A pool for PubSub connections to help navigate rate-limits.

Warning: Passing a ScheduledThreadPoolExecutor with too small corePoolSize can lead to connections in the pool not behaving properly. Not specifying an executor allows connections to create their own at will. If enough connections are made, this could pollute one's runtime environment.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder<C extends TwitchPubSubConnectionPool,B extends TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder<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

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	TwitchPubSubConnectionPool(TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder<?,?> b)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder<?,?>	builder()
protected TwitchPubSub	createConnection()
protected void	disposeConnection(TwitchPubSub connection)
long	getLatency()
protected PubSubRequest	getRequestFromSubscription(PubSubSubscription subscription)
protected int	getSubscriptionSize(PubSubRequest pubSubRequest)
protected PubSubSubscription	handleDuplicateSubscription(TwitchPubSub twitchPubSub, TwitchPubSub old, PubSubRequest pubSubRequest)
protected PubSubSubscription	handleSubscription(TwitchPubSub twitchPubSub, PubSubRequest pubSubRequest)
protected Boolean	handleUnsubscription(TwitchPubSub twitchPubSub, PubSubSubscription pubSubSubscription)
PubSubSubscription	listenOnTopic(PubSubRequest request)	Send WS Message to subscribe to a topic
PubSubSubscription	subscribe(PubSubRequest pubSubRequest)
boolean	unsubscribeFromTopic(PubSubSubscription subscription)	Unsubscribe from a topic.

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, unsubscribe

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.pubsub.ITwitchPubSub

close, getEventManager, listenForAdPropertyRefreshEvents, listenForAdsEvents, listenForAdsManagerEvents, listenForAutomodLevelsModificationEvents, listenForAutomodQueueEvents, listenForBitsBadgeEvents, listenForBountyBoardEvents, listenForBroadcastSettingUpdateEvents, listenForCelebrationEvents, listenForChannelBitsLeaderboardAllTimeEvents, listenForChannelBitsLeaderboardEvents, listenForChannelBitsLeaderboardEvents, listenForChannelBitsLeaderboardMonthlyEvents, listenForChannelChatroomEvents, listenForChannelDropEvents, listenForChannelExtensionEvents, listenForChannelPointsRedemptionEvents, listenForChannelPredictionsEvents, listenForChannelPrimeGiftStatusEvents, listenForChannelSquadEvents, listenForChannelSubGiftsEvents, listenForChannelSubLeaderboardAllTimeEvents, listenForChannelSubLeaderboardEvents, listenForChannelSubLeaderboardEvents, listenForChannelSubLeaderboardMonthlyEvents, listenForChannelUnbanRequestEvents, listenForCharityCampaignEvents, listenForChatHighlightEvents, listenForCheerEvents, listenForCommerceEvents, listenForCommunityBoostEvents, listenForCreatorGoalsEvents, listenForCrowdChantEvents, listenForDashboardActivityFeedEvents, listenForExtensionControlEvents, listenForFollowingEvents, listenForFriendshipEvents, listenForHypeTrainEvents, listenForHypeTrainRewardEvents, listenForLeaderboardAllTimeEvents, listenForLeaderboardEvents, listenForLeaderboardEvents, listenForLeaderboardMonthlyEvents, listenForLowTrustUsersEvents, listenForModerationEvents, listenForModerationEvents, listenForOnsiteNotificationEvents, listenForPinnedChatEvents, listenForPollEvents, listenForPresenceEvents, listenForPublicBitEvents, listenForPublicCheerEvents, listenForRadioEvents, listenForRaidEvents, listenForShieldModeEvents, listenForShoutoutEvents, listenForStreamChangeEvents, listenForStreamChatRoomEvents, listenForSubscriptionEvents, listenForUserBitsUpdateEvents, listenForUserCampaignEvents, listenForUserChannelPointsEvents, listenForUserChatroomEvents, listenForUserDropEvents, listenForUserImageUpdateEvents, listenForUserModerationNotificationEvents, listenForUserPredictionsEvents, listenForUserPropertiesUpdateEvents, listenForUserSubscribeEvents, listenForUserUnbanRequestEvents, listenForVideoPlaybackByNameEvents, listenForVideoPlaybackEvents, listenForWatchPartyEvents, listenForWhisperEvents, listenOnTopic, listenOnTopic, listenOnTopic

Konstruktordetails

TwitchPubSubConnectionPool

protected TwitchPubSubConnectionPool(TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder<?,?> b)

Methodendetails

listenOnTopic

public PubSubSubscription listenOnTopic(PubSubRequest request)

Beschreibung aus Schnittstelle kopiert: ITwitchPubSub

Send WS Message to subscribe to a topic

Angegeben von:

listenOnTopic in Schnittstelle ITwitchPubSub

Parameter:

request - Topic

Gibt zurück:

PubSubSubscription to be listened to

unsubscribeFromTopic

public boolean unsubscribeFromTopic(PubSubSubscription subscription)

Beschreibung aus Schnittstelle kopiert: ITwitchPubSub

Unsubscribe from a topic. Usage example:

      PubSubSubscription subscription = twitchPubSub.listenForCheerEvents(...);
      // ...
      twitchPubSub.unsubscribeFromTopic(subscription);
 

Angegeben von:

unsubscribeFromTopic in Schnittstelle ITwitchPubSub

Parameter:

subscription - PubSubSubscription to be unlistened from

Gibt zurück:

whether the subscription was previously subscribed to

subscribe

public PubSubSubscription subscribe(PubSubRequest pubSubRequest)

Angegeben von:

subscribe in Schnittstelle TransactionalSubscriber<PubSubRequest,PubSubSubscription,Boolean>

Setzt außer Kraft:

subscribe in Klasse SubscriptionConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean>

createConnection

protected TwitchPubSub createConnection()

Angegeben von:

createConnection in Klasse AbstractConnectionPool<TwitchPubSub>

disposeConnection

protected void disposeConnection(TwitchPubSub connection)

Angegeben von:

disposeConnection in Klasse AbstractConnectionPool<TwitchPubSub>

handleSubscription

protected PubSubSubscription handleSubscription(TwitchPubSub twitchPubSub,
 PubSubRequest pubSubRequest)

Angegeben von:

handleSubscription in Klasse SubscriptionConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean>

handleDuplicateSubscription

protected PubSubSubscription handleDuplicateSubscription(TwitchPubSub twitchPubSub,
 TwitchPubSub old,
 PubSubRequest pubSubRequest)

Angegeben von:

handleDuplicateSubscription in Klasse SubscriptionConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean>

handleUnsubscription

protected Boolean handleUnsubscription(TwitchPubSub twitchPubSub,
 PubSubSubscription pubSubSubscription)

Angegeben von:

handleUnsubscription in Klasse SubscriptionConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean>

getRequestFromSubscription

protected PubSubRequest getRequestFromSubscription(PubSubSubscription subscription)

Angegeben von:

getRequestFromSubscription in Klasse SubscriptionConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean>

getSubscriptionSize

protected int getSubscriptionSize(PubSubRequest pubSubRequest)

Angegeben von:

getSubscriptionSize in Klasse SubscriptionConnectionPool<TwitchPubSub,PubSubRequest,PubSubSubscription,Boolean>

getLatency

public long getLatency()

Angegeben von:

getLatency in Schnittstelle ITwitchPubSub

Gibt zurück:

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

builder

public static TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder<?,?> builder()