org.spongepowered.api.network

Interface ChannelBinding.IndexedMessageChannel

All Superinterfaces:

ChannelBinding

Enclosing interface:

ChannelBinding

public static interface ChannelBinding.IndexedMessageChannel
extends ChannelBinding

Represents a channel binding that sends and receives messages.

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
<M extends Message> void	addHandler(Class<M> messageClass, MessageHandler<M> handler) Register a MessageHandler for a Message
<M extends Message> void	addHandler(Class<M> messageClass, Platform.Type side, MessageHandler<M> handler) Register a MessageHandler for a Message.
void	registerMessage(Class<? extends Message> messageClass, int messageId) Register a message class to this channel without a receiving handler.
<M extends Message> void	registerMessage(Class<M> messageClass, int messageId, MessageHandler<M> handler) Register a message class to this channel and a handler for receiving the message.
<M extends Message> void	registerMessage(Class<M> messageClass, int messageId, Platform.Type side, MessageHandler<M> handler) Register a message class to this channel and a handler for receiving the message.
void	sendTo(Player player, Message message) Sends the message to the player across this channel.
void	sendToAll(Message message) Sends the message to all players on the server.
void	sendToServer(Message message) Sends the message to the server.

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

getName, getOwner, getRegistrar

Method Detail

registerMessage

void registerMessage(Class<? extends Message> messageClass,
                     int messageId)

Register a message class to this channel without a receiving handler. This will only allow the message to be sent, this channel binding will not be able to receive the message.

The message ID is used to identify this message class as it is sent and received across the network, it is a single byte and thus has a range of 0 to 255.

Parameters:

messageClass - The class of the message being registered. Note: the class must have a publicly accessible no-args constructor

messageId - A unique ID for this message

registerMessage

<M extends Message> void registerMessage(Class<M> messageClass,
                                         int messageId,
                                         MessageHandler<M> handler)

Register a message class to this channel and a handler for receiving the message. The handler is invoked every time the message is sent to either side.

Parameters:

messageClass - The class of the message being registered

messageId - A unique ID for this message

handler - The handler that acts upon the message being received

registerMessage

<M extends Message> void registerMessage(Class<M> messageClass,
                                         int messageId,
                                         Platform.Type side,
                                         MessageHandler<M> handler)

Register a message class to this channel and a handler for receiving the message. The handler is invoked every time the message is sent to the given side.

Parameters:

messageClass - The class of the message being registered

messageId - A unique ID for this message

side - The side to listen to messages on

handler - The handler that acts upon the message being received

addHandler

<M extends Message> void addHandler(Class<M> messageClass,
                                    Platform.Type side,
                                    MessageHandler<M> handler)

Register a MessageHandler for a Message.

Type Parameters:

M - The type of message

Parameters:

messageClass - The class to handle

side - The side being handled

handler - The handler

addHandler

<M extends Message> void addHandler(Class<M> messageClass,
                                    MessageHandler<M> handler)

Register a MessageHandler for a Message

Type Parameters:

M - The type of message

Parameters:

messageClass - The class to handle

handler - The handler

sendTo

void sendTo(Player player,
            Message message)

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

Parameters:

player - The player to send the message to

message - The message to send

sendToServer

void sendToServer(Message message)

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

Parameters:

message - The message to send

sendToAll

void sendToAll(Message message)

Sends the message to all players on the server.

Parameters:

message - The message to send