NioSctpChannel (Netty/Transport/SCTP 4.0.10.Final API)

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:

io.netty.channel.Channel, SctpChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>
```
public class NioSctpChannel
extends io.netty.channel.nio.AbstractNioMessageChannel
implements SctpChannel
```
SctpChannel implementation which use non-blocking mode and allows to read / write SctpMessages 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 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
`NioSctpChannel()` Create a new instance
`NioSctpChannel(io.netty.channel.Channel parent, SctpChannel sctpChannel)` Create a new instance
`NioSctpChannel(SctpChannel sctpChannel)` Create a new instance using `SctpChannel`

Method Summary

Methods
Modifier and Type	Method and Description
`Set<InetSocketAddress>`	`allLocalAddresses()` Return all local addresses of the SCTP channel.
`io.netty.buffer.ByteBufAllocator`	`alloc()`
`Set<InetSocketAddress>`	`allRemoteAddresses()` Return all remote addresses of the SCTP server channel.
`Association`	`association()` Returns the underlying SCTP association.
`io.netty.channel.ChannelFuture`	`bind(SocketAddress arg0)`
`io.netty.channel.ChannelFuture`	`bind(SocketAddress arg0, io.netty.channel.ChannelPromise arg1)`
`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.
`io.netty.channel.ChannelFuture`	`close()`
`io.netty.channel.ChannelFuture`	`close(io.netty.channel.ChannelPromise arg0)`
`SctpChannelConfig`	`config()` Returns the `SctpChannelConfig` configuration of the channel.
`io.netty.channel.ChannelFuture`	`connect(SocketAddress arg0)`
`io.netty.channel.ChannelFuture`	`connect(SocketAddress arg0, io.netty.channel.ChannelPromise arg1)`
`io.netty.channel.ChannelFuture`	`connect(SocketAddress arg0, SocketAddress arg1)`
`io.netty.channel.ChannelFuture`	`connect(SocketAddress arg0, SocketAddress arg1, io.netty.channel.ChannelPromise arg2)`
`io.netty.channel.ChannelFuture`	`deregister()` Deprecated.
`io.netty.channel.ChannelFuture`	`deregister(io.netty.channel.ChannelPromise arg0)` Deprecated.
`io.netty.channel.ChannelFuture`	`disconnect()`
`io.netty.channel.ChannelFuture`	`disconnect(io.netty.channel.ChannelPromise arg0)`
`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)`
`boolean`	`isActive()`
`protected SctpChannel`	`javaChannel()`
`InetSocketAddress`	`localAddress()` Return the (primary) local address of the SCTP channel.
`protected SocketAddress`	`localAddress0()`
`io.netty.channel.ChannelMetadata`	`metadata()`
`io.netty.channel.ChannelFuture`	`newFailedFuture(Throwable arg0)`
`io.netty.channel.ChannelProgressivePromise`	`newProgressivePromise()`
`io.netty.channel.ChannelPromise`	`newPromise()`
`io.netty.channel.ChannelFuture`	`newSucceededFuture()`
`SctpServerChannel`	`parent()`
`io.netty.channel.ChannelPipeline`	`pipeline()`
`InetSocketAddress`	`remoteAddress()` Return the (primary) remote address of the SCTP channel.
`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.
`io.netty.channel.ChannelPromise`	`voidPromise()`
`io.netty.channel.ChannelFuture`	`write(Object arg0)`
`io.netty.channel.ChannelFuture`	`write(Object arg0, io.netty.channel.ChannelPromise arg1)`
`io.netty.channel.ChannelFuture`	`writeAndFlush(Object arg0)`
`io.netty.channel.ChannelFuture`	`writeAndFlush(Object arg0, io.netty.channel.ChannelPromise arg1)`

Methods inherited from class io.netty.channel.nio.AbstractNioMessageChannel
doWrite, newUnsafe

Methods inherited from class io.netty.channel.nio.AbstractNioChannel
doBeginRead, doDeregister, doRegister, eventLoop, isCompatible, isInputShutdown, isOpen, selectionKey, unsafe

Methods inherited from class io.netty.channel.AbstractChannel
alloc, bind, bind, checkEOF, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, equals, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, 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, isOpen, isRegistered, isWritable, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap
attr

Methods inherited from interface java.lang.Comparable
compareTo

- Constructor Detail
  - NioSctpChannel
```
public NioSctpChannel()
```
    Create a new instance
  - NioSctpChannel
```
public NioSctpChannel(SctpChannel sctpChannel)
```
    Create a new instance using SctpChannel
  - NioSctpChannel
```
public NioSctpChannel(io.netty.channel.Channel parent,
              SctpChannel sctpChannel)
```
    Create a new instance
    
    Parameters:
    parent - the Channel which is the parent of this NioSctpChannel or null.
    sctpChannel - the underlying SctpChannel
- Method Detail
  - localAddress
```
public InetSocketAddress localAddress()
```
    Description copied from interface: SctpChannel
    
    Return the (primary) local address of the SCTP channel. Please note that, this return the first local address in the underlying SCTP Channel'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 SctpChannel
    
    Overrides:
    
    localAddress in class io.netty.channel.AbstractChannel
  - remoteAddress
```
public InetSocketAddress remoteAddress()
```
    Description copied from interface: SctpChannel
    
    Return the (primary) remote address of the SCTP channel. Please note that, this return the first remote address in the underlying SCTP Channel's remote address iterator to support Netty Channel API. In other words, its the application's responsibility to keep track of it's peer's primary address. (The application can request it's remote peer to set a specific address as primary by calling the local SCTP stack with SctpStandardSocketOption.SCTP_SET_PEER_PRIMARY_ADDR option)
    
    Specified by:
    
    remoteAddress in interface io.netty.channel.Channel
    
    Specified by:
    
    remoteAddress in interface SctpChannel
    
    Overrides:
    
    remoteAddress in class io.netty.channel.AbstractChannel
  - parent
```
public SctpServerChannel parent()
```
    Specified by:
    
    parent in interface io.netty.channel.Channel
    
    Specified by:
    
    parent in interface SctpChannel
    
    Overrides:
    
    parent in class io.netty.channel.AbstractChannel
  - metadata
```
public io.netty.channel.ChannelMetadata metadata()
```
    Specified by:
    
    metadata in interface io.netty.channel.Channel
  - association
```
public Association association()
```
    Description copied from interface: SctpChannel
    
    Returns the underlying SCTP association.
    
    Specified by:
    
    association in interface SctpChannel
  - allLocalAddresses
```
public Set<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 interface SctpChannel
  - config
```
public SctpChannelConfig config()
```
    Description copied from interface: SctpChannel
    
    Returns the SctpChannelConfig configuration of the channel.
    
    Specified by:
    
    config in interface io.netty.channel.Channel
    
    Specified by:
    
    config in interface SctpChannel
  - allRemoteAddresses
```
public Set<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 interface SctpChannel
  - javaChannel
```
protected SctpChannel javaChannel()
```
    Overrides:
    
    javaChannel in class io.netty.channel.nio.AbstractNioChannel
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface io.netty.channel.Channel
  - localAddress0
```
protected SocketAddress localAddress0()
```
    Specified by:
    
    localAddress0 in class io.netty.channel.AbstractChannel
  - remoteAddress0
```
protected SocketAddress remoteAddress0()
```
    Specified by:
    
    remoteAddress0 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
  - 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
  - doDisconnect
```
protected void doDisconnect()
                     throws Exception
```
    Specified by:
    
    doDisconnect in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doClose
```
protected void doClose()
                throws Exception
```
    Specified by:
    
    doClose in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doReadMessages
```
protected int doReadMessages(List<Object> buf)
                      throws Exception
```
    Specified by:
    
    doReadMessages in class io.netty.channel.nio.AbstractNioMessageChannel
    
    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
  - bindAddress
```
public io.netty.channel.ChannelFuture bindAddress(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 interface SctpChannel
  - bindAddress
```
public io.netty.channel.ChannelFuture bindAddress(InetAddress localAddress,
                                         io.netty.channel.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 given ChannelPromise and return a ChannelFuture
    
    Specified by:
    
    bindAddress in interface SctpChannel
  - unbindAddress
```
public io.netty.channel.ChannelFuture unbindAddress(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 interface SctpChannel
  - unbindAddress
```
public io.netty.channel.ChannelFuture unbindAddress(InetAddress localAddress,
                                           io.netty.channel.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 given ChannelPromise and return a ChannelFuture
    
    Specified by:
    
    unbindAddress in interface SctpChannel
  - bind
```
public io.netty.channel.ChannelFuture bind(SocketAddress arg0)
```
  - connect
```
public io.netty.channel.ChannelFuture connect(SocketAddress arg0)
```
  - connect
```
public io.netty.channel.ChannelFuture connect(SocketAddress arg0,
                                     SocketAddress arg1)
```
  - disconnect
```
public io.netty.channel.ChannelFuture disconnect()
```
  - close
```
public io.netty.channel.ChannelFuture close()
```
  - deregister
```
@Deprecated
public io.netty.channel.ChannelFuture deregister()
```
    Deprecated.
  - bind
```
public io.netty.channel.ChannelFuture bind(SocketAddress arg0,
                                  io.netty.channel.ChannelPromise arg1)
```
  - connect
```
public io.netty.channel.ChannelFuture connect(SocketAddress arg0,
                                     io.netty.channel.ChannelPromise arg1)
```
  - connect
```
public io.netty.channel.ChannelFuture connect(SocketAddress arg0,
                                     SocketAddress arg1,
                                     io.netty.channel.ChannelPromise arg2)
```
  - disconnect
```
public io.netty.channel.ChannelFuture disconnect(io.netty.channel.ChannelPromise arg0)
```
  - close
```
public io.netty.channel.ChannelFuture close(io.netty.channel.ChannelPromise arg0)
```
  - deregister
```
@Deprecated
public io.netty.channel.ChannelFuture deregister(io.netty.channel.ChannelPromise arg0)
```
    Deprecated.
  - write
```
public io.netty.channel.ChannelFuture write(Object arg0)
```
  - write
```
public io.netty.channel.ChannelFuture write(Object arg0,
                                   io.netty.channel.ChannelPromise arg1)
```
  - writeAndFlush
```
public io.netty.channel.ChannelFuture writeAndFlush(Object arg0,
                                           io.netty.channel.ChannelPromise arg1)
```
  - writeAndFlush
```
public io.netty.channel.ChannelFuture writeAndFlush(Object arg0)
```
  - pipeline
```
public io.netty.channel.ChannelPipeline pipeline()
```
  - alloc
```
public io.netty.buffer.ByteBufAllocator alloc()
```
  - newPromise
```
public io.netty.channel.ChannelPromise newPromise()
```
  - newProgressivePromise
```
public io.netty.channel.ChannelProgressivePromise newProgressivePromise()
```
  - newSucceededFuture
```
public io.netty.channel.ChannelFuture newSucceededFuture()
```
  - newFailedFuture
```
public io.netty.channel.ChannelFuture newFailedFuture(Throwable arg0)
```
  - voidPromise
```
public io.netty.channel.ChannelPromise voidPromise()
```

Class NioSctpChannel

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface java.lang.Comparable

Constructor Detail

NioSctpChannel

NioSctpChannel

NioSctpChannel

Method Detail

localAddress

remoteAddress

parent

metadata

association

allLocalAddresses

config

allRemoteAddresses

javaChannel

isActive

localAddress0

remoteAddress0

doBind

doConnect

doFinishConnect

doDisconnect

doClose

doReadMessages

doWriteMessage

bindAddress

bindAddress

unbindAddress

unbindAddress

bind

connect

connect

disconnect

close

deregister

bind

connect

connect

disconnect

close

deregister

write

write

writeAndFlush

writeAndFlush

pipeline

alloc

newPromise

newProgressivePromise

newSucceededFuture

newFailedFuture

voidPromise