Package org.spongepowered.api.network.channel.raw.handshake

Interface RawHandshakeDataChannel

public interface RawHandshakeDataChannel

Represents a raw login data channel. This channel can only send raw data to a EngineConnection during its handshake phase.

Method Summary

Modifier and Type	Method	Description
RawDataChannel	parent()	Gets the parent RawDataChannel.
java.util.concurrent.CompletableFuture<ChannelBuf>	sendTo(EngineConnection connection, java.util.function.Consumer<ChannelBuf> payload)	Sends a request message ChannelBuf to the EngineConnection.
<C extends EngineConnection> void	setRequestHandler(java.lang.Class<C> connectionType, RawHandshakeDataRequestHandler<? super C> handler)	Sets the RawHandshakeDataRequestHandler for the given connection type.
void	setRequestHandler(RawHandshakeDataRequestHandler<EngineConnection> handler)	Sets the RawHandshakeDataRequestHandler on the both the client and server sides.
<C extends EngineConnection> void	setRequestHandler(EngineConnectionSide<C> side, RawHandshakeDataRequestHandler<? super C> handler)	Sets the RawHandshakeDataRequestHandler on the given connection side.

Method Detail

parent

RawDataChannel parent()

Gets the parent RawDataChannel.

Returns:

The raw data channel

setRequestHandler

<C extends EngineConnection> void setRequestHandler(EngineConnectionSide<C> side,
                                                    RawHandshakeDataRequestHandler<? super C> handler)

Sets the RawHandshakeDataRequestHandler on the given connection side.

Type Parameters:

C - The connection type

Parameters:

side - The connection side the handler should be set on

handler - The handler to set

setRequestHandler

<C extends EngineConnection> void setRequestHandler(java.lang.Class<C> connectionType,
                                                    RawHandshakeDataRequestHandler<? super C> handler)

Sets the RawHandshakeDataRequestHandler for the given connection type.

Type Parameters:

C - The connection type

Parameters:

connectionType - The connection type the handler should be used by

handler - The handler to set

setRequestHandler

void setRequestHandler(RawHandshakeDataRequestHandler<EngineConnection> handler)

Sets the RawHandshakeDataRequestHandler on the both the client and server sides.

Parameters:

handler - The handler to set

sendTo

java.util.concurrent.CompletableFuture<ChannelBuf> sendTo(EngineConnection connection,
                                                          java.util.function.Consumer<ChannelBuf> payload)

Sends a request message ChannelBuf to the EngineConnection.

The CompletableFuture may fail exceptionally by a NoResponseException if there wasn't a valid response received for the given request.

Parameters:

connection - The client connection to send the request to

payload - The payload provider of the request

Returns:

The completable future of the response