Package io.netty.channel.sctp.nio
Class NioSctpChannel
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.NioSctpChannel
- All Implemented Interfaces:
Channel
,ChannelOutboundInvoker
,SctpChannel
,AttributeMap
,Comparable<Channel>
SctpChannel
implementation which use non-blocking mode and allows to read /
write SctpMessage
s to the underlying SctpChannel
.
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 ClassesNested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel
AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe
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
FieldsModifier and TypeFieldDescriptionprivate final SctpChannelConfig
private static final InternalLogger
private static final ChannelMetadata
private final NotificationHandler
<?> Fields inherited from class io.netty.channel.nio.AbstractNioChannel
readInterestOp
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a new instanceNioSctpChannel
(SctpChannel sctpChannel) Create a new instance usingSctpChannel
NioSctpChannel
(Channel parent, SctpChannel sctpChannel) Create a new instance -
Method Summary
Modifier and TypeMethodDescriptionReturn all local addresses of the SCTP channel.Return all remote addresses of the SCTP server channel.Returns the underlying SCTP association.bindAddress
(InetAddress localAddress) Bind a address to the already bound channel to enable multi-homing.bindAddress
(InetAddress localAddress, ChannelPromise promise) Bind a address to the already bound channel to enable multi-homing.config()
Returns theSctpChannelConfig
configuration of the channel.protected void
doBind
(SocketAddress localAddress) Bind theChannel
to theSocketAddress
protected void
doClose()
Close theChannel
protected boolean
doConnect
(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peerprotected void
Disconnect thisChannel
from its remote peerprotected void
Finish the connectprotected int
doReadMessages
(List<Object> buf) Read messages into the given array and return the amount which was read.protected boolean
doWriteMessage
(Object msg, ChannelOutboundBuffer in) Write a message to the underlyingChannel
.protected final Object
Invoked when a new message is added to aChannelOutboundBuffer
of thisAbstractChannel
, so that theChannel
implementation converts the message to another.boolean
isActive()
Returntrue
if theChannel
is active and so connected.protected SctpChannel
Returns the local address where this channel is bound to.protected SocketAddress
Returns theSocketAddress
which is bound locally.metadata()
private static SctpChannel
parent()
Returns the parent of this channel.Returns the remote address where this channel is connected to.protected SocketAddress
Return theSocketAddress
which theChannel
is connected to.unbindAddress
(InetAddress localAddress) Unbind the address from channel's multi-homing address list.unbindAddress
(InetAddress localAddress, 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, 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.util.AttributeMap
attr, hasAttr
Methods inherited from interface io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, pipeline, read, unsafe
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
-
Field Details
-
METADATA
-
logger
-
config
-
notificationHandler
-
-
Constructor Details
-
NioSctpChannel
public NioSctpChannel()Create a new instance -
NioSctpChannel
Create a new instance usingSctpChannel
-
NioSctpChannel
Create a new instance- Parameters:
parent
- theChannel
which is the parent of thisNioSctpChannel
ornull
.sctpChannel
- the underlyingSctpChannel
-
-
Method Details
-
newSctpChannel
-
localAddress
Description copied from interface:Channel
Returns the local address where this channel is bound to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
localAddress
in interfaceChannel
- Specified by:
localAddress
in interfaceSctpChannel
- Overrides:
localAddress
in classAbstractChannel
- Returns:
- the local address of this channel.
null
if this channel is not bound.
-
remoteAddress
Description copied from interface:Channel
Returns the remote address where this channel is connected to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
remoteAddress
in interfaceChannel
- Specified by:
remoteAddress
in interfaceSctpChannel
- Overrides:
remoteAddress
in classAbstractChannel
- 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
, useDefaultAddressedEnvelope.recipient()
to determine the origination of the received message as this method will returnnull
.
-
parent
Description copied from interface:Channel
Returns the parent of this channel.- Specified by:
parent
in interfaceChannel
- Specified by:
parent
in interfaceSctpChannel
- Overrides:
parent
in classAbstractChannel
- Returns:
- the parent channel.
null
if this channel does not have a parent channel.
-
metadata
Description copied from interface:Channel
-
association
Description copied from interface:SctpChannel
Returns the underlying SCTP association.- Specified by:
association
in interfaceSctpChannel
-
allLocalAddresses
Description copied from interface:SctpChannel
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- Specified by:
allLocalAddresses
in interfaceSctpChannel
-
config
Description copied from interface:SctpChannel
Returns theSctpChannelConfig
configuration of the channel.- Specified by:
config
in interfaceChannel
- Specified by:
config
in interfaceSctpChannel
-
allRemoteAddresses
Description copied from interface:SctpChannel
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.- Specified by:
allRemoteAddresses
in interfaceSctpChannel
-
javaChannel
- Overrides:
javaChannel
in classAbstractNioChannel
-
isActive
public boolean isActive()Description copied from interface:Channel
Returntrue
if theChannel
is active and so connected. -
localAddress0
Description copied from class:AbstractChannel
Returns theSocketAddress
which is bound locally.- Specified by:
localAddress0
in classAbstractChannel
-
remoteAddress0
Description copied from class:AbstractChannel
Return theSocketAddress
which theChannel
is connected to.- Specified by:
remoteAddress0
in classAbstractChannel
-
doBind
Description copied from class:AbstractChannel
Bind theChannel
to theSocketAddress
- Specified by:
doBind
in classAbstractChannel
- Throws:
Exception
-
doConnect
protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception Description copied from class:AbstractNioChannel
Connect to the remote peer- Specified by:
doConnect
in classAbstractNioChannel
- Throws:
Exception
-
doFinishConnect
Description copied from class:AbstractNioChannel
Finish the connect- Specified by:
doFinishConnect
in classAbstractNioChannel
- Throws:
Exception
-
doDisconnect
Description copied from class:AbstractChannel
Disconnect thisChannel
from its remote peer- Specified by:
doDisconnect
in classAbstractChannel
- Throws:
Exception
-
doClose
Description copied from class:AbstractChannel
Close theChannel
- Overrides:
doClose
in classAbstractNioChannel
- Throws:
Exception
-
doReadMessages
Description copied from class:AbstractNioMessageChannel
Read messages into the given array and return the amount which was read.- Specified by:
doReadMessages
in classAbstractNioMessageChannel
- Throws:
Exception
-
doWriteMessage
Description copied from class:AbstractNioMessageChannel
Write a message to the underlyingChannel
.- Specified by:
doWriteMessage
in classAbstractNioMessageChannel
- Returns:
true
if and only if the message has been written- Throws:
Exception
-
filterOutboundMessage
Description copied from class:AbstractChannel
Invoked when a new message is added to aChannelOutboundBuffer
of thisAbstractChannel
, so that theChannel
implementation converts the message to another. (e.g. heap buffer -> direct buffer)- Overrides:
filterOutboundMessage
in classAbstractChannel
- Throws:
Exception
-
bindAddress
Description copied from interface:SctpChannel
Bind a address to the already bound channel to enable multi-homing. The Channel bust be bound and yet to be connected.- Specified by:
bindAddress
in interfaceSctpChannel
-
bindAddress
Description copied from interface:SctpChannel
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 givenChannelPromise
and return aChannelFuture
- Specified by:
bindAddress
in interfaceSctpChannel
-
unbindAddress
Description copied from interface:SctpChannel
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 interfaceSctpChannel
-
unbindAddress
Description copied from interface:SctpChannel
Unbind the address from channel's multi-homing address list. The address should be added already in multi-homing address list. Will notify the givenChannelPromise
and return aChannelFuture
- Specified by:
unbindAddress
in interfaceSctpChannel
-