io.netty.channel.sctp.oio

Class OioSctpServerChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.oio.AbstractOioChannel

io.netty.channel.oio.AbstractOioMessageChannel

io.netty.channel.sctp.oio.OioSctpServerChannel

All Implemented Interfaces:

Channel, SctpServerChannel, ServerChannel, AttributeMap, Comparable<Channel>

public class OioSctpServerChannel
extends AbstractOioMessageChannel
implements SctpServerChannel

SctpServerChannel implementation which use blocking mode to accept new connections and create the OioSctpChannel 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.AbstractChannel

AbstractChannel.AbstractUnsafe

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

Channel.Unsafe

Field Summary

Fields inherited from class io.netty.channel.oio.AbstractOioChannel

SO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
OioSctpServerChannel() Create a new instance with an new SctpServerChannel
OioSctpServerChannel(com.sun.nio.sctp.SctpServerChannel sch) Create a new instance from the given SctpServerChannel

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.
protected void	doBind(SocketAddress localAddress) Bind the Channel to the SocketAddress
protected void	doClose() Close the Channel
protected void	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer using the given localAddress if one is specified or null otherwise.
protected void	doDisconnect() Disconnect this Channel from its remote peer
protected int	doReadMessages(List<Object> buf) Read messages into the given array and return the amount which was read.
protected int	doWrite(Object[] msgs, int msgsLength, int startIndex) Flush the content of the given ByteBuf to the remote peer.
boolean	isActive() Return true if the Channel is active and so connected.
boolean	isOpen() Returns true if the Channel is open an may get active later
InetSocketAddress	localAddress() Returns the local address where this channel is bound to.
protected SocketAddress	localAddress0() Returns the SocketAddress which is bound locally.
ChannelMetadata	metadata() Return the ChannelMetadata of the Channel which describe the nature of the 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
InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0() Return the SocketAddress which the Channel is connected to.
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 class io.netty.channel.oio.AbstractOioMessageChannel

doRead

Methods inherited from class io.netty.channel.oio.AbstractOioChannel

doBeginRead, isCompatible, newUnsafe

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, calculateMessageSize, checkEOF, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doDeregister, doPreClose, doRegister, equals, eventLoop, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap

attr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.Channel

closeFuture, eventLoop, flush, isRegistered, isWritable, parent, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

OioSctpServerChannel

public OioSctpServerChannel()

Create a new instance with an new SctpServerChannel

OioSctpServerChannel

public OioSctpServerChannel(com.sun.nio.sctp.SctpServerChannel sch)

Create a new instance from the given SctpServerChannel

Parameters:

sch - the SctpServerChannel which is used by this instance

Method Detail

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

Specified by:

metadata in interface Channel

config

public SctpServerChannelConfig config()

Description copied from interface: SctpServerChannel

Returns the SctpServerChannelConfig configuration of the channel.

Specified by:

config in interface Channel

Specified by:

config in interface SctpServerChannel

remoteAddress

public InetSocketAddress remoteAddress()

Description copied from interface: Channel

Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

remoteAddress in interface Channel

Overrides:

remoteAddress in class AbstractChannel

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.

localAddress

public InetSocketAddress localAddress()

Description copied from interface: Channel

Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

localAddress in interface Channel

Specified by:

localAddress in interface SctpServerChannel

Overrides:

localAddress in class AbstractChannel

Returns:

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

isOpen

public boolean isOpen()

Description copied from interface: Channel

Returns true if the Channel is open an may get active later

Specified by:

isOpen in interface Channel

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

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

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

Exception

doReadMessages

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

Description copied from class: AbstractOioMessageChannel

Read messages into the given array and return the amount which was read.

Specified by:

doReadMessages in class AbstractOioMessageChannel

Throws:

Exception

bindAddress

public 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 ChannelFuture bindAddress(InetAddress localAddress,
                        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 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 ChannelFuture unbindAddress(InetAddress localAddress,
                          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 void doConnect(SocketAddress remoteAddress,
             SocketAddress localAddress)
                  throws Exception

Description copied from class: AbstractOioChannel

Connect to the remote peer using the given localAddress if one is specified or null otherwise.

Specified by:

doConnect in class AbstractOioChannel

Throws:

Exception

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

doWrite

protected int doWrite(Object[] msgs,
          int msgsLength,
          int startIndex)
               throws Exception

Description copied from class: AbstractChannel

Flush the content of the given ByteBuf to the remote peer. Sub-classes may override this as this implementation will just thrown an UnsupportedOperationException

Specified by:

doWrite in class AbstractChannel

Returns:

the number of written messages

Throws:

Exception

bind

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public ChannelFuture writeAndFlush(Object msg,
                          ChannelPromise promise)

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

writeAndFlush

public ChannelFuture writeAndFlush(Object msg)

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

pipeline

public ChannelPipeline pipeline()

Return the assigned ChannelPipeline

alloc

public ByteBufAllocator alloc()

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

newPromise

public ChannelPromise newPromise()

Return a new ChannelPromise.

newProgressivePromise

public ChannelProgressivePromise newProgressivePromise()

Return an new ChannelProgressivePromise

newSucceededFuture

public 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

public 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

public 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!