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

Class ConduitSpec

java.lang.Object

com.github.twitch4j.eventsub.socket.conduit.ConduitSpec

public final class ConduitSpec
extends Object

Method Summary

Modifier and Type	Method	Description
@Nullable OAuth2Credential	appAccessToken()	The app access token for helix requests.
ConduitSpec	appAccessToken(@Nullable OAuth2Credential appAccessToken)	The app access token for helix requests.
@Nullable String	clientId()	Your application's client ID.
ConduitSpec	clientId(@Nullable String clientId)	Your application's client ID.
@Nullable String	clientSecret()	Your application's client secret.
ConduitSpec	clientSecret(@Nullable String clientSecret)	Your application's client secret.
@Nullable String	conduitId()	The ID of an already created Conduit (optional); otherwise TwitchConduitSocketPool will create a new Conduit.
ConduitSpec	conduitId(@Nullable String conduitId)	The ID of an already created Conduit (optional); otherwise TwitchConduitSocketPool will create a new Conduit.
boolean	equals(Object o)
@Nullable EventManager	eventManager()	An optional EventManager (if one is already created).
ConduitSpec	eventManager(@Nullable EventManager eventManager)	An optional EventManager (if one is already created).
@Nullable ScheduledThreadPoolExecutor	executor()	An optional ScheduledThreadPoolExecutor.
ConduitSpec	executor(@Nullable ScheduledThreadPoolExecutor executor)	An optional ScheduledThreadPoolExecutor.
int	hashCode()
@Nullable TwitchHelix	helix()	An optional TwitchHelix instance (if one is already created).
ConduitSpec	helix(@Nullable TwitchHelix helix)	An optional TwitchHelix instance (if one is already created).
int	poolShards()	The number of websockets that should be created by the TwitchConduitSocketPool instance.
ConduitSpec	poolShards(int poolShards)	The number of websockets that should be created by the TwitchConduitSocketPool instance.
static @NotNull ConduitSpec	process(@NotNull Consumer<ConduitSpec> spec)
@Nullable ProxyConfig	proxyConfig()	Optional: the proxy to use for helix requests and the websocket connections.
ConduitSpec	proxyConfig(@Nullable ProxyConfig proxyConfig)	Optional: the proxy to use for helix requests and the websocket connections.
int	shardOffset()	An integer offset for the Shard IDs to be registered with the Conduit.
ConduitSpec	shardOffset(int shardOffset)	An integer offset for the Shard IDs to be registered with the Conduit.
@Nullable Duration	socketWelcomeTimeout()	The amount of time to wait for the websocket shards to be welcomed by Twitch.
ConduitSpec	socketWelcomeTimeout(@Nullable Duration socketWelcomeTimeout)	The amount of time to wait for the websocket shards to be welcomed by Twitch.
String	toString()
@Nullable Integer	totalShardCount()	The total number of shards associated with the Conduit ID (optional).
ConduitSpec	totalShardCount(@Nullable Integer totalShardCount)	The total number of shards associated with the Conduit ID (optional).
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

validate

public void validate()

process

@NotNull
public static @NotNull ConduitSpec process(@NotNull
 @NotNull Consumer<ConduitSpec> spec)

conduitId

@Nullable
public @Nullable String conduitId()

The ID of an already created Conduit (optional); otherwise TwitchConduitSocketPool will create a new Conduit.

poolShards

public int poolShards()

The number of websockets that should be created by the TwitchConduitSocketPool instance.

Must be positive.

totalShardCount

@Nullable
public @Nullable Integer totalShardCount()

The total number of shards associated with the Conduit ID (optional).

If the Conduit is already created, specifying this value avoids a TwitchHelix.getConduits(String) call.

If the Conduit is not created yet, this field can be used to create a larger Conduit than poolShards() (if you plan to create another TwitchConduitSocketPool instance on another server).

shardOffset

public int shardOffset()

An integer offset for the Shard IDs to be registered with the Conduit.

This field should only be set if the Conduit is already created with some shards already registered.

clientId

@Nullable
public @Nullable String clientId()

Your application's client ID.

Not required if appAccessToken() is specified or helix() already has client credentials.

clientSecret

@Nullable
public @Nullable String clientSecret()

Your application's client secret.

Not required if appAccessToken() is specified or helix() already has client credentials.

helix

@Nullable
public @Nullable TwitchHelix helix()

An optional TwitchHelix instance (if one is already created).

appAccessToken

@Nullable
public @Nullable OAuth2Credential appAccessToken()

The app access token for helix requests.

Not required if client id and secret are specified OR the specified helix instance already has client credentials.

executor

@Nullable
public @Nullable ScheduledThreadPoolExecutor executor()

An optional ScheduledThreadPoolExecutor.

eventManager

@Nullable
public @Nullable EventManager eventManager()

An optional EventManager (if one is already created).

Prefer using IEventSubConduit.getEventManager() (instead of creating an EventManager).

proxyConfig

@Nullable
public @Nullable ProxyConfig proxyConfig()

Optional: the proxy to use for helix requests and the websocket connections.

socketWelcomeTimeout

@Nullable
public @Nullable Duration socketWelcomeTimeout()

The amount of time to wait for the websocket shards to be welcomed by Twitch.

If a shard does not connect within this timeout, ShardTimeoutException is thrown by TwitchConduitSocketPool.

conduitId

public ConduitSpec conduitId(@Nullable
 @Nullable String conduitId)

The ID of an already created Conduit (optional); otherwise TwitchConduitSocketPool will create a new Conduit.

Returns:

this.

poolShards

public ConduitSpec poolShards(int poolShards)

The number of websockets that should be created by the TwitchConduitSocketPool instance.

Must be positive.

Returns:

this.

totalShardCount

public ConduitSpec totalShardCount(@Nullable
 @Nullable Integer totalShardCount)

The total number of shards associated with the Conduit ID (optional).

If the Conduit is already created, specifying this value avoids a TwitchHelix.getConduits(String) call.

If the Conduit is not created yet, this field can be used to create a larger Conduit than poolShards() (if you plan to create another TwitchConduitSocketPool instance on another server).

Returns:

this.

shardOffset

public ConduitSpec shardOffset(int shardOffset)

An integer offset for the Shard IDs to be registered with the Conduit.

This field should only be set if the Conduit is already created with some shards already registered.

Returns:

this.

clientId

public ConduitSpec clientId(@Nullable
 @Nullable String clientId)

Your application's client ID.

Not required if appAccessToken() is specified or helix() already has client credentials.

Returns:

this.

clientSecret

public ConduitSpec clientSecret(@Nullable
 @Nullable String clientSecret)

Your application's client secret.

Not required if appAccessToken() is specified or helix() already has client credentials.

Returns:

this.

helix

public ConduitSpec helix(@Nullable
 @Nullable TwitchHelix helix)

An optional TwitchHelix instance (if one is already created).

Returns:

this.

appAccessToken

public ConduitSpec appAccessToken(@Nullable
 @Nullable OAuth2Credential appAccessToken)

The app access token for helix requests.

Not required if client id and secret are specified OR the specified helix instance already has client credentials.

Returns:

this.

executor

public ConduitSpec executor(@Nullable
 @Nullable ScheduledThreadPoolExecutor executor)

An optional ScheduledThreadPoolExecutor.

Returns:

this.

eventManager

public ConduitSpec eventManager(@Nullable
 @Nullable EventManager eventManager)

An optional EventManager (if one is already created).

Prefer using IEventSubConduit.getEventManager() (instead of creating an EventManager).

Returns:

this.

proxyConfig

public ConduitSpec proxyConfig(@Nullable
 @Nullable ProxyConfig proxyConfig)

Optional: the proxy to use for helix requests and the websocket connections.

Returns:

this.

socketWelcomeTimeout

public ConduitSpec socketWelcomeTimeout(@Nullable
 @Nullable Duration socketWelcomeTimeout)

The amount of time to wait for the websocket shards to be welcomed by Twitch.

If a shard does not connect within this timeout, ShardTimeoutException is thrown by TwitchConduitSocketPool.

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object