io.netty.channel.sctp

Interface SctpChannel

All Superinterfaces:

AttributeMap, Channel, ChannelOutboundInvoker, Comparable<Channel>

All Known Implementing Classes:

NioSctpChannel, OioSctpChannel

public interface SctpChannel
extends Channel

A SCTP/IP Channel interface for single SCTP association.

The SctpChannel is a message-oriented, connected transport which supports multi-streaming and multi-homing.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Channel.Unsafe

Method Summary

Modifier and Type	Method and Description
Set<InetSocketAddress>	allLocalAddresses() Return all local addresses of the SCTP channel.
Set<InetSocketAddress>	allRemoteAddresses() Return all remote addresses of the SCTP server channel.
com.sun.nio.sctp.Association	association() Returns the underlying SCTP association.
ChannelFuture	bindAddress(InetAddress localAddress) Bind a address to the already bound channel to enable multi-homing.
ChannelFuture	bindAddress(InetAddress localAddress, ChannelPromise promise) Bind a address to the already bound channel to enable multi-homing.
SctpChannelConfig	config() Returns the SctpChannelConfig configuration of the channel.
InetSocketAddress	localAddress() Return the (primary) local address of the SCTP channel.
SctpServerChannel	parent() Returns the parent of this channel.
InetSocketAddress	remoteAddress() Return the (primary) remote address of the SCTP channel.
ChannelFuture	unbindAddress(InetAddress localAddress) Unbind the address from channel's multi-homing address list.
ChannelFuture	unbindAddress(InetAddress localAddress, ChannelPromise promise) Unbind the address from channel's multi-homing address list.

Methods inherited from interface io.netty.channel.Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, metadata, pipeline, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

parent

SctpServerChannel parent()

Description copied from interface: Channel

Returns the parent of this channel.

Specified by:

parent in interface Channel

Returns:

the parent channel. null if this channel does not have a parent channel.

association

com.sun.nio.sctp.Association association()

Returns the underlying SCTP association.

localAddress

InetSocketAddress localAddress()

Return the (primary) local address of the SCTP channel. Please note that, this return the first local address in the underlying SCTP Channel's local address iterator to support Netty Channel API. In other words, its the application's responsibility to keep track of it's local primary address. (To set a local address as primary, the application can request by calling local SCTP stack, with SctpStandardSocketOption.SCTP_PRIMARY_ADDR option).

Specified by:

localAddress in interface Channel

Returns:

the local address of this channel. null if this channel is not bound.

allLocalAddresses

Set<InetSocketAddress> allLocalAddresses()

Return all local addresses of the SCTP channel. Please note that, it will return more than one address if this channel is using multi-homing

config

SctpChannelConfig config()

Returns the SctpChannelConfig configuration of the channel.

Specified by:

config in interface Channel

remoteAddress

InetSocketAddress remoteAddress()

Return the (primary) remote address of the SCTP channel. Please note that, this return the first remote address in the underlying SCTP Channel's remote address iterator to support Netty Channel API. In other words, its the application's responsibility to keep track of it's peer's primary address. (The application can request it's remote peer to set a specific address as primary by calling the local SCTP stack with SctpStandardSocketOption.SCTP_SET_PEER_PRIMARY_ADDR option)

Specified by:

remoteAddress in interface Channel

Returns:

the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.

allRemoteAddresses

Set<InetSocketAddress> allRemoteAddresses()

Return all remote addresses of the SCTP server channel. Please note that, it will return more than one address if the remote is using multi-homing.

bindAddress

ChannelFuture bindAddress(InetAddress localAddress)

Bind a address to the already bound channel to enable multi-homing. The Channel bust be bound and yet to be connected.

bindAddress

ChannelFuture bindAddress(InetAddress localAddress,
                          ChannelPromise promise)

Bind a address to the already bound channel to enable multi-homing. The Channel bust be bound and yet to be connected. Will notify the given ChannelPromise and return a ChannelFuture

unbindAddress

ChannelFuture unbindAddress(InetAddress localAddress)

Unbind the address from channel's multi-homing address list. The address should be added already in multi-homing address list.

unbindAddress

ChannelFuture unbindAddress(InetAddress localAddress,
                            ChannelPromise promise)

Unbind the address from channel's multi-homing address list. The address should be added already in multi-homing address list. Will notify the given ChannelPromise and return a ChannelFuture