io.netty.channel.sctp

Interface SctpServerChannel

All Superinterfaces:

AttributeMap, Channel, 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

Methods

Modifier and Type	Method and Description
Set<InetSocketAddress>	allLocalAddresses() Return all local addresses of the SCTP server channel.
ByteBufAllocator	alloc() Return the assigned ByteBufAllocator which will be used for allocate ByteBufs.
ChannelFuture	bind(SocketAddress localAddress) Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	bind(SocketAddress localAddress, ChannelPromise promise) Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
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.
ChannelFuture	close() Request to close this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	close(ChannelPromise promise) Request to close this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
SctpServerChannelConfig	config() Returns the SctpServerChannelConfig configuration of the channel.
ChannelFuture	connect(SocketAddress remoteAddress) Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, ChannelPromise promise) Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress) Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	deregister() Request to deregister this ChannelOutboundInvoker from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	deregister(ChannelPromise promise) Request to deregister this ChannelOutboundInvoker from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	disconnect() Request to discconect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	disconnect(ChannelPromise promise) Request to discconect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
InetSocketAddress	localAddress() Return the (primary) local address of the SCTP server channel.
ChannelFuture	newFailedFuture(Throwable cause) Create a new ChannelFuture which is marked as fakued already.
ChannelProgressivePromise	newProgressivePromise() Return an new ChannelProgressivePromise
ChannelPromise	newPromise() Return a new ChannelPromise.
ChannelFuture	newSucceededFuture() Create a new ChannelFuture which is marked as successes already.
ChannelPipeline	pipeline() Return the assigned ChannelPipeline
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.
ChannelPromise	voidPromise() Return a special ChannelPromise which can be reused for different operations.
ChannelFuture	write(Object msg) Request to write a message via this ChannelOutboundInvoker through the ChannelPipeline.
ChannelFuture	write(Object msg, ChannelPromise promise) Request to write a message via this ChannelOutboundInvoker through the ChannelPipeline.
ChannelFuture	writeAndFlush(Object msg) Shortcut for call write(Object) and flush().
ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise) Shortcut for call write(Object, ChannelPromise) and flush().

Methods inherited from interface io.netty.channel.Channel

closeFuture, eventLoop, flush, isActive, isOpen, isRegistered, isWritable, metadata, parent, read, remoteAddress, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr

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

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

Set<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(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(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(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

bind

ChannelFuture bind(SocketAddress localAddress)

Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

connect

ChannelFuture connect(SocketAddress remoteAddress)

Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.

This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

connect

ChannelFuture connect(SocketAddress remoteAddress,
                    SocketAddress localAddress)

Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

disconnect

ChannelFuture disconnect()

Request to discconect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

close

ChannelFuture close()

Request to close this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again.

This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

deregister

ChannelFuture deregister()

Request to deregister this ChannelOutboundInvoker from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

bind

ChannelFuture bind(SocketAddress localAddress,
                 ChannelPromise promise)

Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

connect

ChannelFuture connect(SocketAddress remoteAddress,
                    ChannelPromise promise)

Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelFuture will be notified.

If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.

This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

connect

ChannelFuture connect(SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    ChannelPromise promise)

Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified and also returned.

This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

disconnect

ChannelFuture disconnect(ChannelPromise promise)

Request to discconect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

close

ChannelFuture close(ChannelPromise promise)

Request to close this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again. The given ChannelPromise will be notified.

This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

deregister

ChannelFuture deregister(ChannelPromise promise)

Request to deregister this ChannelOutboundInvoker from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

write

ChannelFuture write(Object msg)

Request to write a message via this ChannelOutboundInvoker through the ChannelPipeline. This method will not request to actual flush, so be sure to call flush() once you want to request to flush all pending data to the actual transport.

write

ChannelFuture write(Object msg,
                  ChannelPromise promise)

Request to write a message via this ChannelOutboundInvoker through the ChannelPipeline. This method will not request to actual flush, so be sure to call flush() once you want to request to flush all pending data to the actual transport.

writeAndFlush

ChannelFuture writeAndFlush(Object msg,
                          ChannelPromise promise)

Shortcut for call write(Object, ChannelPromise) and flush().

writeAndFlush

ChannelFuture writeAndFlush(Object msg)

Shortcut for call write(Object) and flush().

pipeline

ChannelPipeline pipeline()

Return the assigned ChannelPipeline

alloc

ByteBufAllocator alloc()

Return the assigned ByteBufAllocator which will be used for allocate ByteBufs.

newPromise

ChannelPromise newPromise()

Return a new ChannelPromise.

newProgressivePromise

ChannelProgressivePromise newProgressivePromise()

Return an new ChannelProgressivePromise

newSucceededFuture

ChannelFuture newSucceededFuture()

Create a new ChannelFuture which is marked as successes already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

newFailedFuture

ChannelFuture newFailedFuture(Throwable cause)

Create a new ChannelFuture which is marked as fakued already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

voidPromise

ChannelPromise voidPromise()

Return a special ChannelPromise which can be reused for different operations.

It's only supported to use it for ChannelOutboundInvoker.write(Object, ChannelPromise).

Be aware that the returned ChannelPromise will not support most operations and should only be used if you want to safe object allocation for every operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call ChannelPipeline.fireExceptionCaught(Throwable) in this case.

Be aware this is an expert feature and should be used with care!