Package dev.qixils.crowdcontrol.socket

Class ClientSocketManager

java.lang.Object

dev.qixils.crowdcontrol.socket.ClientSocketManager

All Implemented Interfaces:

Respondable, SocketManager

@AvailableSince("3.0.0")
public final class ClientSocketManager
extends Object
implements SocketManager

Manages the connection to the Crowd Control server.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
ClientSocketManager(@NotNull RequestManager serverConfig)	Creates a new client-side socket manager.

Method Summary

Modifier and Type	Method	Description
void	addConnectListener(@NotNull Consumer<SocketManager> consumer)
void	addLoginListener(@NotNull Consumer<SocketManager> consumer)
@NotNull Response.Builder	buildResponse()
@NotNull String	getDisplayName()
@Nullable Request.Source	getSource()
@NotNull Set<Request.Source>	getSources()
boolean	isClosed()
void	shutdown(@Nullable Request cause, @Nullable String reason)
void	write(@NotNull Response response)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.qixils.crowdcontrol.socket.SocketManager

getConnections, shutdown, shutdown

Constructor Detail

ClientSocketManager

@CheckReturnValue
@Internal
@AvailableSince("3.0.0")
public ClientSocketManager(@NotNull
                           @NotNull RequestManager serverConfig)

Creates a new client-side socket manager. This is intended only for use by the library.

Parameters:

serverConfig - Crowd Control instance

Since:

3.0.0

Method Detail

addConnectListener

public void addConnectListener(@NotNull
                               @NotNull Consumer<SocketManager> consumer)

Specified by:

addConnectListener in interface SocketManager

addLoginListener

public void addLoginListener(@NotNull
                             @NotNull Consumer<SocketManager> consumer)

Specified by:

addLoginListener in interface SocketManager

buildResponse

public @NotNull Response.Builder buildResponse()

Specified by:

buildResponse in interface Respondable

Specified by:

buildResponse in interface SocketManager

shutdown

@AvailableSince("3.1.0")
public void shutdown(@Nullable
                     @Nullable Request cause,
                     @Nullable
                     @Nullable String reason)
              throws IOException

Specified by:

shutdown in interface SocketManager

Throws:

IOException

getSources

@NotNull
public @NotNull Set<Request.Source> getSources()

Specified by:

getSources in interface SocketManager

getSource

public @Nullable Request.Source getSource()

Specified by:

getSource in interface SocketManager

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SocketManager

write

public void write(@NotNull
                  @NotNull Response response)
           throws IOException

Specified by:

write in interface SocketManager

Throws:

IOException

getDisplayName

@NotNull
public @NotNull String getDisplayName()

Specified by:

getDisplayName in interface SocketManager