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
,java.lang.Comparable<Channel>
public class NioSctpChannel extends AbstractNioMessageChannel implements SctpChannel
SctpChannel
implementation which use non-blocking mode and allows to read / writeSctpMessage
s to the underlyingSctpChannel
. 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
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
-
Fields inherited from class io.netty.channel.nio.AbstractNioChannel
readInterestOp, readOps
-
-
Constructor Summary
Constructors Constructor Description NioSctpChannel()
Create a new instanceNioSctpChannel(com.sun.nio.sctp.SctpChannel sctpChannel)
Create a new instance usingSctpChannel
NioSctpChannel(Channel parent, com.sun.nio.sctp.SctpChannel sctpChannel)
Create a new instance
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Set<java.net.InetSocketAddress>
allLocalAddresses()
Return all local addresses of the SCTP channel.java.util.Set<java.net.InetSocketAddress>
allRemoteAddresses()
Return all remote addresses of the SCTP server channel.com.sun.nio.sctp.Association
association()
Returns the underlying SCTP association.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.SctpChannelConfig
config()
Returns theSctpChannelConfig
configuration of the channel.protected void
doBind(java.net.SocketAddress localAddress)
Bind theChannel
to theSocketAddress
protected void
doClose()
Close theChannel
protected boolean
doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)
Connect to the remote peerprotected void
doDisconnect()
Disconnect thisChannel
from its remote peerprotected void
doFinishConnect()
Finish the connectprotected int
doReadMessages(java.util.List<java.lang.Object> buf)
Read messages into the given array and return the amount which was read.protected boolean
doWriteMessage(java.lang.Object msg, ChannelOutboundBuffer in)
Write a message to the underlyingChannel
.protected java.lang.Object
filterOutboundMessage(java.lang.Object msg)
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 com.sun.nio.sctp.SctpChannel
javaChannel()
java.net.InetSocketAddress
localAddress()
Returns the local address where this channel is bound to.protected java.net.SocketAddress
localAddress0()
Returns theSocketAddress
which is bound locally.ChannelMetadata
metadata()
SctpServerChannel
parent()
Returns the parent of this channel.java.net.InetSocketAddress
remoteAddress()
Returns the remote address where this channel is connected to.protected java.net.SocketAddress
remoteAddress0()
Return theSocketAddress
which theChannel
is connected to.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 class io.netty.channel.nio.AbstractNioMessageChannel
closeOnReadError, continueOnWriteError, continueReading, doBeginRead, doWrite, newUnsafe
-
Methods inherited from class io.netty.channel.nio.AbstractNioChannel
addAndSubmit, clearReadPending, doDeregister, doRegister, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, registration, removeAndSubmit, selectionKey, setReadPending, unsafe
-
Methods inherited from class io.netty.channel.AbstractChannel
closeFuture, compareTo, doRegister, doShutdownOutput, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, maxMessagesPerWrite, newChannelPipeline, newId, pipeline, toString, validateFileRegion, voidPromise
-
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, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isOpen, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush
-
-
-
-
Constructor Detail
-
NioSctpChannel
public NioSctpChannel()
Create a new instance
-
NioSctpChannel
public NioSctpChannel(com.sun.nio.sctp.SctpChannel sctpChannel)
Create a new instance usingSctpChannel
-
NioSctpChannel
public NioSctpChannel(Channel parent, com.sun.nio.sctp.SctpChannel sctpChannel)
Create a new instance- Parameters:
parent
- theChannel
which is the parent of thisNioSctpChannel
ornull
.sctpChannel
- the underlyingSctpChannel
-
-
Method Detail
-
localAddress
public java.net.InetSocketAddress 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
public java.net.InetSocketAddress 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
public SctpServerChannel 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
public ChannelMetadata metadata()
Description copied from interface:Channel
-
association
public com.sun.nio.sctp.Association association()
Description copied from interface:SctpChannel
Returns the underlying SCTP association.- Specified by:
association
in interfaceSctpChannel
-
allLocalAddresses
public java.util.Set<java.net.InetSocketAddress> 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
public SctpChannelConfig config()
Description copied from interface:SctpChannel
Returns theSctpChannelConfig
configuration of the channel.- Specified by:
config
in interfaceChannel
- Specified by:
config
in interfaceSctpChannel
-
allRemoteAddresses
public java.util.Set<java.net.InetSocketAddress> 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
protected com.sun.nio.sctp.SctpChannel javaChannel()
- Overrides:
javaChannel
in classAbstractNioChannel
-
isActive
public boolean isActive()
Description copied from interface:Channel
Returntrue
if theChannel
is active and so connected.
-
localAddress0
protected java.net.SocketAddress localAddress0()
Description copied from class:AbstractChannel
Returns theSocketAddress
which is bound locally.- Specified by:
localAddress0
in classAbstractChannel
-
remoteAddress0
protected java.net.SocketAddress remoteAddress0()
Description copied from class:AbstractChannel
Return theSocketAddress
which theChannel
is connected to.- Specified by:
remoteAddress0
in classAbstractChannel
-
doBind
protected void doBind(java.net.SocketAddress localAddress) throws java.lang.Exception
Description copied from class:AbstractChannel
Bind theChannel
to theSocketAddress
- Specified by:
doBind
in classAbstractChannel
- Throws:
java.lang.Exception
-
doConnect
protected boolean doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress) throws java.lang.Exception
Description copied from class:AbstractNioChannel
Connect to the remote peer- Specified by:
doConnect
in classAbstractNioChannel
- Throws:
java.lang.Exception
-
doFinishConnect
protected void doFinishConnect() throws java.lang.Exception
Description copied from class:AbstractNioChannel
Finish the connect- Specified by:
doFinishConnect
in classAbstractNioChannel
- Throws:
java.lang.Exception
-
doDisconnect
protected void doDisconnect() throws java.lang.Exception
Description copied from class:AbstractChannel
Disconnect thisChannel
from its remote peer- Specified by:
doDisconnect
in classAbstractChannel
- Throws:
java.lang.Exception
-
doClose
protected void doClose() throws java.lang.Exception
Description copied from class:AbstractChannel
Close theChannel
- Overrides:
doClose
in classAbstractNioChannel
- Throws:
java.lang.Exception
-
doReadMessages
protected int doReadMessages(java.util.List<java.lang.Object> buf) throws java.lang.Exception
Description copied from class:AbstractNioMessageChannel
Read messages into the given array and return the amount which was read.- Specified by:
doReadMessages
in classAbstractNioMessageChannel
- Throws:
java.lang.Exception
-
doWriteMessage
protected boolean doWriteMessage(java.lang.Object msg, ChannelOutboundBuffer in) throws java.lang.Exception
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:
java.lang.Exception
-
filterOutboundMessage
protected final java.lang.Object filterOutboundMessage(java.lang.Object msg) throws java.lang.Exception
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:
java.lang.Exception
-
bindAddress
public ChannelFuture bindAddress(java.net.InetAddress localAddress)
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
public ChannelFuture bindAddress(java.net.InetAddress localAddress, ChannelPromise promise)
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
public ChannelFuture unbindAddress(java.net.InetAddress localAddress)
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
public ChannelFuture unbindAddress(java.net.InetAddress localAddress, ChannelPromise promise)
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
-
-