Package io.netty.channel.sctp

Interface SctpServerChannel

All Superinterfaces:

AttributeMap, Channel, ChannelOutboundInvoker, java.lang.Comparable<Channel>, ServerChannel

All Known Implementing Classes:

NioSctpServerChannel, OioSctpServerChannel

public interface SctpServerChannel
extends ServerChannel

A SCTP/IP ServerChannel which accepts incoming SCTP/IP associations.

Multi-homing address binding/unbinding can done through bindAddress/unbindAddress methods.

Nested Class Summary

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

Channel.Unsafe

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.net.InetSocketAddress>	allLocalAddresses()	Return all local addresses of the SCTP server channel.
ChannelFuture	bindAddress(java.net.InetAddress localAddress)	Bind a address to the already bound channel to enable multi-homing.
ChannelFuture	bindAddress(java.net.InetAddress localAddress, ChannelPromise promise)	Bind a address to the already bound channel to enable multi-homing.
SctpServerChannelConfig	config()	Returns the SctpServerChannelConfig configuration of the channel.
java.net.InetSocketAddress	localAddress()	Return the (primary) local address of the SCTP server channel.
ChannelFuture	unbindAddress(java.net.InetAddress localAddress)	Unbind the address from channel's multi-homing address list.
ChannelFuture	unbindAddress(java.net.InetAddress localAddress, ChannelPromise promise)	Unbind the address from channel's multi-homing address list.

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.Channel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isActive, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

config

SctpServerChannelConfig config()

Returns the SctpServerChannelConfig configuration of the channel.

Specified by:

config in interface Channel

localAddress

java.net.InetSocketAddress localAddress()

Return the (primary) local address of the SCTP server channel. Please note that, this return the first local address in the underlying SCTP ServerChannel'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

java.util.Set<java.net.InetSocketAddress> allLocalAddresses()

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

bindAddress

ChannelFuture bindAddress(java.net.InetAddress localAddress)

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

bindAddress

ChannelFuture bindAddress(java.net.InetAddress localAddress,
                          ChannelPromise promise)

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

unbindAddress

ChannelFuture unbindAddress(java.net.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(java.net.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