Package com.github.twitch4j.pubsub

Class TwitchPubSub

java.lang.Object

com.github.twitch4j.pubsub.TwitchPubSub

All Implemented Interfaces:

ITwitchPubSub, AutoCloseable

public class TwitchPubSub
extends Object
implements ITwitchPubSub

Twitch PubSub

Field Summary

Fields

Modifier and Type	Field	Description
protected final BlockingQueue<String>	commandQueue	Command Queue
protected final Future<?>	heartbeatTask	Heartbeat Thread
protected boolean	isClosed	is Closed?
protected long	lastPing	Last Ping send (1 minute delay before sending the first ping)
protected long	lastPong	Last Pong received
protected final Future<?>	queueTask	Command Queue Thread
static final int	REQUIRED_THREAD_COUNT
protected final Set<PubSubRequest>	subscribedTopics	Holds the subscribed topics in case we need to reconnect
protected final ScheduledExecutorService	taskExecutor	Thread Pool Executor

Constructor Summary

Constructors

Constructor	Description
TwitchPubSub(WebsocketConnection websocketConnection, com.github.philippheuer.events4j.core.EventManager eventManager, ScheduledThreadPoolExecutor taskExecutor, ProxyConfig proxyConfig, Collection<String> botOwnerIds, int wsPingPeriod, IBackoffStrategy connectionBackoffStrategy, int wsCloseDelay, Consumer<PubSubResponsePayload> fallbackTopicHandler)	Deprecated. Twitch will decommission PubSub on April 14, 2025, with shutdown windows starting in February.

Method Summary

Modifier and Type	Method	Description
void	close()	Close
void	connect()	Connecting to IRC-WS
void	disconnect()	Disconnecting from WebSocket
com.github.philippheuer.events4j.core.EventManager	getEventManager()	EventManager
long	getLatency()
PubSubSubscription	listenOnTopic(PubSubRequest request)	Send WS Message to subscribe to a topic
protected void	onConnected()
protected void	onPreConnect()
protected void	onTextMessage(String text)
void	reconnect()	Reconnecting to WebSocket
boolean	unsubscribeFromTopic(PubSubSubscription subscription)	Unsubscribe from a topic.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.twitch4j.pubsub.ITwitchPubSub

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, listenForFollows, listenForFriendshipEvents, listenForHypeTrainEvents, listenForHypeTrainRewardEvents, listenForLeaderboardAllTimeEvents, listenForLeaderboardEvents, listenForLeaderboardEvents, listenForLeaderboardMonthlyEvents, listenForLowTrustUsersEvents, listenForModerationEvents, listenForModerationEvents, listenForOnsiteNotificationEvents, listenForPinnedChatEvents, listenForPollEvents, listenForPresenceEvents, listenForPublicBitEvents, listenForPublicCheerEvents, listenForRadioEvents, listenForRaidEvents, listenForSharedChatEvents, listenForShieldModeEvents, listenForShoutoutEvents, listenForStreamChangeEvents, listenForStreamChatRoomEvents, listenForSubscriptionEvents, listenForUserBitsUpdateEvents, listenForUserCampaignEvents, listenForUserChannelPointsEvents, listenForUserChatroomEvents, listenForUserDropEvents, listenForUserImageUpdateEvents, listenForUserModerationNotificationEvents, listenForUserPredictionsEvents, listenForUserPropertiesUpdateEvents, listenForUserSubscribeEvents, listenForUserUnbanRequestEvents, listenForVideoPlaybackByNameEvents, listenForVideoPlaybackEvents, listenForWatchPartyEvents, listenForWhisperEvents, listenOnTopic, listenOnTopic, listenOnTopic

Field Details

REQUIRED_THREAD_COUNT

public static final int REQUIRED_THREAD_COUNT

See Also:

• Constant Field Values

queueTask

protected final Future<?> queueTask

Command Queue Thread

heartbeatTask

protected final Future<?> heartbeatTask

Heartbeat Thread

isClosed

protected volatile boolean isClosed

is Closed?

commandQueue

protected final BlockingQueue<String> commandQueue

Command Queue

subscribedTopics

protected final Set<PubSubRequest> subscribedTopics

Holds the subscribed topics in case we need to reconnect

lastPing

protected volatile long lastPing

Last Ping send (1 minute delay before sending the first ping)

lastPong

protected volatile long lastPong

Last Pong received

taskExecutor

protected final ScheduledExecutorService taskExecutor

Thread Pool Executor

Constructor Details

TwitchPubSub

@Deprecated
@ScheduledForRemoval(inVersion="2.0.0")
public TwitchPubSub(WebsocketConnection websocketConnection,
 com.github.philippheuer.events4j.core.EventManager eventManager,
 ScheduledThreadPoolExecutor taskExecutor,
 ProxyConfig proxyConfig,
 Collection<String> botOwnerIds,
 int wsPingPeriod,
 IBackoffStrategy connectionBackoffStrategy,
 int wsCloseDelay,
 Consumer<PubSubResponsePayload> fallbackTopicHandler)

Deprecated.

Twitch will decommission PubSub on April 14, 2025, with shutdown windows starting in February.

Constructor

Parameters:

websocketConnection - WebsocketConnection

eventManager - EventManager

taskExecutor - ScheduledThreadPoolExecutor

proxyConfig - ProxyConfig

botOwnerIds - Bot Owner IDs

wsPingPeriod - WebSocket Ping Period

connectionBackoffStrategy - WebSocket Connection Backoff Strategy

wsCloseDelay - Websocket Close Delay

fallbackTopicHandler - Fallback Topic Handler

See Also:

• Deprecation Announcement

Method Details

connect

public void connect()

Connecting to IRC-WS

disconnect

public void disconnect()

Disconnecting from WebSocket

reconnect

public void reconnect()

Reconnecting to WebSocket

onPreConnect

protected void onPreConnect()

onConnected

protected void onConnected()

onTextMessage

protected void onTextMessage(String text)

listenOnTopic

public PubSubSubscription listenOnTopic(PubSubRequest request)

Description copied from interface: ITwitchPubSub

Send WS Message to subscribe to a topic

Specified by:

listenOnTopic in interface ITwitchPubSub

Parameters:

request - Topic

Returns:

PubSubSubscription to be listened to

unsubscribeFromTopic

public boolean unsubscribeFromTopic(PubSubSubscription subscription)

Description copied from interface: ITwitchPubSub

Unsubscribe from a topic. Usage example:

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

Specified by:

unsubscribeFromTopic in interface ITwitchPubSub

Parameters:

subscription - PubSubSubscription to be unlistened from

Returns:

whether the subscription was previously subscribed to

getLatency

public long getLatency()

Specified by:

getLatency in interface ITwitchPubSub

Returns:

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

close

public void close()

Close

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ITwitchPubSub

getEventManager

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

EventManager

Specified by:

getEventManager in interface ITwitchPubSub