io.netty.channel.sctp.nio

Class NioSctpServerChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.nio.AbstractNioChannel

io.netty.channel.nio.AbstractNioMessageChannel

io.netty.channel.sctp.nio.NioSctpServerChannel

All Implemented Interfaces:

io.netty.channel.Channel, io.netty.channel.ChannelOutboundInvoker, SctpServerChannel, io.netty.channel.ServerChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>

public class NioSctpServerChannel
extends io.netty.channel.nio.AbstractNioMessageChannel
implements SctpServerChannel

SctpServerChannel implementation which use non-blocking mode to accept new connections and create the NioSctpChannel for them. Be aware that not all operations systems support SCTP. Please refer to the documentation of your operation system, to understand what you need to do to use it. Also this feature is only supported on Java 7+.

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel

io.netty.channel.nio.AbstractNioChannel.AbstractNioUnsafe, io.netty.channel.nio.AbstractNioChannel.NioUnsafe

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

io.netty.channel.AbstractChannel.AbstractUnsafe

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

io.netty.channel.Channel.Unsafe

Field Summary

Fields inherited from class io.netty.channel.nio.AbstractNioChannel

readInterestOp

Constructor Summary

Constructors

Constructor and Description
NioSctpServerChannel() Create a new instance

Method Summary

Modifier and Type	Method and Description
Set<InetSocketAddress>	allLocalAddresses() Return all local addresses of the SCTP server channel.
io.netty.channel.ChannelFuture	bindAddress(InetAddress localAddress) Bind a address to the already bound channel to enable multi-homing.
io.netty.channel.ChannelFuture	bindAddress(InetAddress localAddress, io.netty.channel.ChannelPromise promise) Bind a address to the already bound channel to enable multi-homing.
SctpServerChannelConfig	config() Returns the SctpServerChannelConfig configuration of the channel.
protected void	doBind(SocketAddress localAddress)
protected void	doClose()
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress)
protected void	doDisconnect()
protected void	doFinishConnect()
protected int	doReadMessages(List<Object> buf)
protected boolean	doWriteMessage(Object msg, io.netty.channel.ChannelOutboundBuffer in)
protected Object	filterOutboundMessage(Object msg)
boolean	isActive()
protected SctpServerChannel	javaChannel()
InetSocketAddress	localAddress() Return the (primary) local address of the SCTP server channel.
protected SocketAddress	localAddress0()
io.netty.channel.ChannelMetadata	metadata()
InetSocketAddress	remoteAddress()
protected SocketAddress	remoteAddress0()
io.netty.channel.ChannelFuture	unbindAddress(InetAddress localAddress) Unbind the address from channel's multi-homing address list.
io.netty.channel.ChannelFuture	unbindAddress(InetAddress localAddress, io.netty.channel.ChannelPromise promise) Unbind the address from channel's multi-homing address list.

Methods inherited from class io.netty.channel.nio.AbstractNioMessageChannel

closeOnReadError, continueOnWriteError, continueReading, doBeginRead, doWrite, newUnsafe

Methods inherited from class io.netty.channel.nio.AbstractNioChannel

clearReadPending, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, setReadPending, unsafe

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.channel.Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, parent, 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

Constructor Detail

NioSctpServerChannel

public NioSctpServerChannel()

Create a new instance

Method Detail

metadata

public io.netty.channel.ChannelMetadata metadata()

Specified by:

metadata in interface io.netty.channel.Channel

allLocalAddresses

public Set<InetSocketAddress> allLocalAddresses()

Description copied from interface: SctpServerChannel

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

Specified by:

allLocalAddresses in interface SctpServerChannel

config

public SctpServerChannelConfig config()

Description copied from interface: SctpServerChannel

Returns the SctpServerChannelConfig configuration of the channel.

Specified by:

config in interface io.netty.channel.Channel

Specified by:

config in interface SctpServerChannel

isActive

public boolean isActive()

Specified by:

isActive in interface io.netty.channel.Channel

remoteAddress

public InetSocketAddress remoteAddress()

Specified by:

remoteAddress in interface io.netty.channel.Channel

Overrides:

remoteAddress in class io.netty.channel.AbstractChannel

localAddress

public InetSocketAddress localAddress()

Description copied from interface: SctpServerChannel

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 io.netty.channel.Channel

Specified by:

localAddress in interface SctpServerChannel

Overrides:

localAddress in class io.netty.channel.AbstractChannel

javaChannel

protected SctpServerChannel javaChannel()

Overrides:

javaChannel in class io.netty.channel.nio.AbstractNioChannel

localAddress0

protected SocketAddress localAddress0()

Specified by:

localAddress0 in class io.netty.channel.AbstractChannel

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Specified by:

doBind in class io.netty.channel.AbstractChannel

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Overrides:

doClose in class io.netty.channel.nio.AbstractNioChannel

Throws:

Exception

doReadMessages

protected int doReadMessages(List<Object> buf)
                      throws Exception

Specified by:

doReadMessages in class io.netty.channel.nio.AbstractNioMessageChannel

Throws:

Exception

bindAddress

public io.netty.channel.ChannelFuture bindAddress(InetAddress localAddress)

Description copied from interface: SctpServerChannel

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

Specified by:

bindAddress in interface SctpServerChannel

bindAddress

public io.netty.channel.ChannelFuture bindAddress(InetAddress localAddress,
                                                  io.netty.channel.ChannelPromise promise)

Description copied from interface: SctpServerChannel

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

Specified by:

bindAddress in interface SctpServerChannel

unbindAddress

public io.netty.channel.ChannelFuture unbindAddress(InetAddress localAddress)

Description copied from interface: SctpServerChannel

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

Specified by:

unbindAddress in interface SctpServerChannel

unbindAddress

public io.netty.channel.ChannelFuture unbindAddress(InetAddress localAddress,
                                                    io.netty.channel.ChannelPromise promise)

Description copied from interface: SctpServerChannel

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

Specified by:

unbindAddress in interface SctpServerChannel

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress)
                     throws Exception

Specified by:

doConnect in class io.netty.channel.nio.AbstractNioChannel

Throws:

Exception

doFinishConnect

protected void doFinishConnect()
                        throws Exception

Specified by:

doFinishConnect in class io.netty.channel.nio.AbstractNioChannel

Throws:

Exception

remoteAddress0

protected SocketAddress remoteAddress0()

Specified by:

remoteAddress0 in class io.netty.channel.AbstractChannel

doDisconnect

protected void doDisconnect()
                     throws Exception

Specified by:

doDisconnect in class io.netty.channel.AbstractChannel

Throws:

Exception

doWriteMessage

protected boolean doWriteMessage(Object msg,
                                 io.netty.channel.ChannelOutboundBuffer in)
                          throws Exception

Specified by:

doWriteMessage in class io.netty.channel.nio.AbstractNioMessageChannel

Throws:

Exception

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)
                                throws Exception

Overrides:

filterOutboundMessage in class io.netty.channel.AbstractChannel

Throws:

Exception