org.spongepowered.api.network

Interface ChannelBinding

All Known Subinterfaces:

ChannelBinding.IndexedMessageChannel, ChannelBinding.RawDataChannel

public interface ChannelBinding

Represents a network channel bound to a ChannelRegistrar. The channel can be used to send and receive data. If this binding is removed by ChannelRegistrar.unbindChannel(org.spongepowered.api.network.ChannelBinding), all methods will throw IllegalStateException.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ChannelBinding.IndexedMessageChannel Represents a channel binding that sends and receives messages.
static interface	ChannelBinding.RawDataChannel Represents a channel that sends and receives raw data.

Method Summary

Modifier and Type	Method and Description
String	getName() Gets this channel's bound name.
PluginContainer	getOwner() Gets the plugin that created this binding.
ChannelRegistrar	getRegistrar() Gets the registrar that this channel is bound to.

Method Detail

getRegistrar

ChannelRegistrar getRegistrar()

Gets the registrar that this channel is bound to.

Returns:

The registrar

getName

String getName()

Gets this channel's bound name.

Returns:

The channel name

getOwner

PluginContainer getOwner()

Gets the plugin that created this binding.

Returns:

The owning plugin