org.spongepowered.api.network

Interface ChannelBinding.RawDataChannel

All Superinterfaces:

ChannelBinding

Enclosing interface:

ChannelBinding

public static interface ChannelBinding.RawDataChannel
extends ChannelBinding

Represents a channel that sends and receives raw data.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.network.ChannelBinding

ChannelBinding.IndexedMessageChannel, ChannelBinding.RawDataChannel

Method Summary

Modifier and Type	Method and Description
void	addListener(Platform.Type side, RawDataListener listener) Adds a listener to this channel that is invoked every time data is sent to it on the given side.
void	addListener(RawDataListener listener) Adds a listener to this channel that is invoked every time data is sent to it on either side.
void	removeListener(RawDataListener listener) Removes the listener from handling data.
void	sendTo(Player player, Consumer<ChannelBuf> payload) Sends the raw payload to the player across this channel.
void	sendToAll(Consumer<ChannelBuf> payload) Sends the raw payload to all players on the server.
void	sendToServer(Consumer<ChannelBuf> payload) Sends the raw payload to the server.

Methods inherited from interface org.spongepowered.api.network.ChannelBinding

getName, getOwner, getRegistrar

Method Detail

addListener

void addListener(RawDataListener listener)

Adds a listener to this channel that is invoked every time data is sent to it on either side.

Parameters:

listener - The listener

addListener

void addListener(Platform.Type side,
                 RawDataListener listener)

Adds a listener to this channel that is invoked every time data is sent to it on the given side.

Parameters:

side - The side to listen to data on

listener - The listener

removeListener

void removeListener(RawDataListener listener)

Removes the listener from handling data.

Parameters:

listener - The listener

sendTo

void sendTo(Player player,
            Consumer<ChannelBuf> payload)

Sends the raw payload to the player across this channel. The data may not be sent if the player doesn't have a registered handler.

Parameters:

player - The player to send the message to

payload - A consumer to write the data to

sendToServer

void sendToServer(Consumer<ChannelBuf> payload)

Sends the raw payload to the server. The data may not be sent if there is no registered handler. This must be called from the client side.

Parameters:

payload - A consumer to write the data to

sendToAll

void sendToAll(Consumer<ChannelBuf> payload)

Sends the raw payload to all players on the server.

Parameters:

payload - A consumer to write the data to