Package org.spongepowered.api.network.channel.packet

Interface TransactionalPacketBinding<P extends RequestPacket<R>,R extends Packet>

Type Parameters:

P - The type of the request packet

R - The type of the response packet

All Superinterfaces:

PacketBinding<P>

All Known Subinterfaces:

FixedTransactionalPacketBinding<P,R>

public interface TransactionalPacketBinding<P extends RequestPacket<R>,R extends Packet>
extends PacketBinding<P>

A packet binding that represents a request/response pair. One side of a connection can send a RequestPacket and the other side will normally respond with a response Packet.

Request/response pairs share an opcode, a additional byte will specify whether it's a request, response or a no-response.

Method Summary

Modifier and Type	Method	Description
<S extends EngineConnectionState> TransactionalPacketBinding<P,R>	addResponseHandler(Class<S> connectionState, PacketHandler<? super R,? super S> responseHandler)	Adds a PacketHandler to handle a response Packet on for a specific connection type.
<S extends EngineConnectionState> TransactionalPacketBinding<P,R>	addResponseHandler(Class<S> connectionState, ResponsePacketHandler<? super P,? super R,? super S> handler)	Adds a ResponsePacketHandler to handle a response Packet for a specific connection type.
TransactionalPacketBinding<P,R>	addResponseHandler(PacketHandler<? super R,EngineConnectionState> handler)	Adds a PacketHandler to handle a response Packet on both platform sides.
TransactionalPacketBinding<P,R>	addResponseHandler(ResponsePacketHandler<? super P,? super R,EngineConnectionState> handler)	Adds a ResponsePacketHandler to handle a response Packet on both platform sides.
int	opcode()	Gets the opcode of the TransactionalPacketBinding.
Class<P>	packetType()	Gets the type of the RequestPacket.
<S extends EngineConnectionState> TransactionalPacketBinding<P,R>	setRequestHandler(Class<S> connectionState, RequestPacketHandler<? super P,? extends R,? super S> handler)	Sets the RequestPacketHandler to handle a RequestPacket for a specific connection type.
TransactionalPacketBinding<P,R>	setRequestHandler(RequestPacketHandler<? super P,? extends R,EngineConnectionState> handler)	Sets the RequestPacketHandler to handle a RequestPacket on both connection sides.

Method Details

opcode

int opcode()

Gets the opcode of the TransactionalPacketBinding. This opcode will be shared by the request and response Packets.

Specified by:

opcode in interface PacketBinding<P extends RequestPacket<R>>

Returns:

The opcode

packetType

Class<P> packetType()

Gets the type of the RequestPacket.

Specified by:

packetType in interface PacketBinding<P extends RequestPacket<R>>

Returns:

The request packet type

setRequestHandler

<S extends EngineConnectionState>
TransactionalPacketBinding<P,R> setRequestHandler(Class<S> connectionState,
 RequestPacketHandler<? super P,? extends R,? super S> handler)

Sets the RequestPacketHandler to handle a RequestPacket for a specific connection type. The difference with a normal PacketHandler is that it requires a response Packet as return value.

Type Parameters:

S - The connection state

Parameters:

connectionState - The connection state the request packet should be handled by

handler - The handler of the request packet

Returns:

This packet binding, for chaining

setRequestHandler

TransactionalPacketBinding<P,R> setRequestHandler(RequestPacketHandler<? super P,? extends R,EngineConnectionState> handler)

Sets the RequestPacketHandler to handle a RequestPacket on both connection sides. The difference with a normal PacketHandler is that it requires a response Packet as return value.

Parameters:

handler - The handler of the request packet

Returns:

This packet binding, for chaining

addResponseHandler

<S extends EngineConnectionState>
TransactionalPacketBinding<P,R> addResponseHandler(Class<S> connectionState,
 PacketHandler<? super R,? super S> responseHandler)

Adds a PacketHandler to handle a response Packet on for a specific connection type.

Binding a response PacketHandler is completely optional. It is also possible to append a handler to the CompletableFuture returned by TransactionalPacketDispatcher.sendTo(EngineConnection, RequestPacket).

Type Parameters:

S - The connection state

Parameters:

connectionState - The connection state the response packet should be handled by

responseHandler - The handler of the response packet

Returns:

This packet binding, for chaining

addResponseHandler

<S extends EngineConnectionState>
TransactionalPacketBinding<P,R> addResponseHandler(Class<S> connectionState,
 ResponsePacketHandler<? super P,? super R,? super S> handler)

Adds a ResponsePacketHandler to handle a response Packet for a specific connection type.

Binding a response PacketHandler is completely optional. It is also possible to append a handler to the CompletableFuture returned by TransactionalPacketDispatcher.sendTo(EngineConnection, RequestPacket).

Type Parameters:

S - The connection state

Parameters:

connectionState - The connection state the response packet should be handled by

handler - The handler of the response packet

Returns:

This packet binding, for chaining

addResponseHandler

TransactionalPacketBinding<P,R> addResponseHandler(PacketHandler<? super R,EngineConnectionState> handler)

Adds a PacketHandler to handle a response Packet on both platform sides.

Binding a response PacketHandler is completely optional. It is also possible to append a handler to the CompletableFuture returned by TransactionalPacketDispatcher.sendTo(EngineConnection, RequestPacket).

Parameters:

handler - The handler of the response packet

Returns:

This packet binding, for chaining

addResponseHandler

TransactionalPacketBinding<P,R> addResponseHandler(ResponsePacketHandler<? super P,? super R,EngineConnectionState> handler)

Adds a ResponsePacketHandler to handle a response Packet on both platform sides.

Binding a response PacketHandler is completely optional. It is also possible to append a handler to the CompletableFuture returned by TransactionalPacketDispatcher.sendTo(EngineConnection, RequestPacket).

Parameters:

handler - The handler of the response packet

Returns:

This packet binding, for chaining