Package com.github.twitch4j.eventsub.socket.conduit

Class TwitchConduitSocketPool

java.lang.Object

com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool

All Implemented Interfaces:

IEventSubConduit, AutoCloseable

public final class TwitchConduitSocketPool
extends Object
implements IEventSubConduit

Facilitates creating EventSub WebSocket shards for a new or existing Conduit.

Sample usage:

 
 IEventSubConduit conduit = TwitchConduitSocketPool.create(spec -> {
     spec.poolShards(4); // customizable pool size
     spec.clientId("your-client-id");
     spec.clientSecret("your-client-secret");
 });
 conduit.register(SubscriptionTypes.STREAM_ONLINE, b -> b.broadcasterUserId("71092938").build());
 conduit.getEventManager().onEvent(StreamOnlineEvent.class, System.out::println);
 
 

See Also:

• Conduits Announcement
• Official Documentation

Method Summary

Modifier and Type	Method	Description
void	close()
static @NotNull TwitchConduitSocketPool	create(@NotNull Consumer<ConduitSpec> spec)	Creates a managed websocket pool to serve as shards for an EventSub Conduit.
@NotNull String	getConduitId()
@NotNull com.github.philippheuer.events4j.core.EventManager	getEventManager()
long	getLatency()
int	getManagedShardCount()
int	getShardOffset()
EventSubSubscription	register(@NotNull EventSubSubscription subscription)	Creates an eventsub subscription for this conduit.
<C extends EventSubCondition, B> Optional<EventSubSubscription>	register(@NotNull SubscriptionType<C,B,?> type, @NotNull Function<B,C> conditions)	Creates an eventsub subscription for this conduit.
boolean	unregister(@NotNull EventSubSubscription subscription)	Deletes an eventsub subscription from helix (and this conduit).

Methods inherited from class java.lang.Object

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

Method Details

register

public EventSubSubscription register(@NotNull
 @NotNull EventSubSubscription subscription)

Description copied from interface: IEventSubConduit

Creates an eventsub subscription for this conduit.

Specified by:

register in interface IEventSubConduit

Parameters:

subscription - the eventsub subscription to be registered

Returns:

the created subscription

register

public <C extends EventSubCondition,
B>
Optional<EventSubSubscription> register(@NotNull
 @NotNull SubscriptionType<C,B,?> type,
 @NotNull
 @NotNull Function<B,C> conditions)

Description copied from interface: IEventSubConduit

Creates an eventsub subscription for this conduit.

Specified by:

register in interface IEventSubConduit

Type Parameters:

C - the condition type associated with the subscription

B - the builder type associated with the condition

Parameters:

type - the type of EventSub subscription to be created; see SubscriptionTypes

conditions - the conditions associated with the eventsub subscription

Returns:

the created subscription, or empty if the subscription could not be registered.

unregister

public boolean unregister(@NotNull
 @NotNull EventSubSubscription subscription)

Description copied from interface: IEventSubConduit

Deletes an eventsub subscription from helix (and this conduit).

Specified by:

unregister in interface IEventSubConduit

Parameters:

subscription - the eventsub subscription to be destroyed

Returns:

whether the specified subscription was successfully deleted

getLatency

public long getLatency()

Specified by:

getLatency in interface IEventSubConduit

Returns:

the average latency for the socket shards in milliseconds, or -1 if unknown

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

getManagedShardCount

public int getManagedShardCount()

create

@NotNull
public static @NotNull TwitchConduitSocketPool create(@NotNull
 @NotNull Consumer<ConduitSpec> spec)
                                               throws CreateConduitException,
ConduitNotFoundException,
ConduitResizeException,
ShardTimeoutException,
ShardRegistrationException

Creates a managed websocket pool to serve as shards for an EventSub Conduit.

This pool can be used to create a completely new conduit, or augment an existing conduit.

Note: Twitch limits each Client ID to five (5) enabled conduits, with up to 20,000 shards per conduit. Please do not try to create 20,000 websockets from a single server.

Parameters:

spec - the specification by which to create a websocket pool for an EventSub Conduit

Returns:

a TwitchConduitSocketPool instance

Throws:

NullPointerException - if the passed spec is null

IllegalArgumentException - if the specified conduit configuration is invalid

CreateConduitException - if TwitchHelix.createConduit(String, int) fails

ConduitNotFoundException - if a specific Conduit ID was specified, but not found within TwitchHelix.getConduits(String) when checking the shard count

ConduitResizeException - if TwitchHelix.updateConduit(String, String, int) fails while resizing the Conduit to accommodate the number of shards in the spec

ShardTimeoutException - if any of the underlying sockets for this pool do not receive session_welcome from Twitch before the timeout in the spec (default: 15 seconds)

ShardRegistrationException - if TwitchHelix.updateConduitShards(String, ShardsInput) fails while registering the created sockets with the Conduit ID

See Also:

• Official Conduits Documentation

getEventManager

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

Specified by:

getEventManager in interface IEventSubConduit

Returns:

the event manager for eventsub notifications

getShardOffset

public int getShardOffset()

getConduitId

@NotNull
public @NotNull String getConduitId()

Specified by:

getConduitId in interface IEventSubConduit

Returns:

the ID associated with this Conduit