NioSctpChannel (Netty 4.1.109.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

所有已实现的接口:

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 / 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+.

嵌套类概要
- 从类继承的嵌套类/接口 io.netty.channel.nio.AbstractNioChannel
  AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe
- 从类继承的嵌套类/接口 io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- 从接口继承的嵌套类/接口 io.netty.channel.Channel
  Channel.Unsafe

字段概要
- 从类继承的字段 io.netty.channel.nio.AbstractNioChannel
  readInterestOp

构造器概要

构造器
构造器和说明
`NioSctpChannel()` Create a new instance
`NioSctpChannel(Channel parent, SctpChannel sctpChannel)` Create a new instance
`NioSctpChannel(SctpChannel sctpChannel)` Create a new instance using `SctpChannel`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`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.
`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 the `SctpChannelConfig` configuration of the channel.
`protected void`	`doBind(java.net.SocketAddress localAddress)` Bind the `Channel` to the `SocketAddress`
`protected void`	`doClose()` Close the `Channel`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` Connect to the remote peer
`protected void`	`doDisconnect()` Disconnect this `Channel` from its remote peer
`protected void`	`doFinishConnect()` Finish the connect
`protected 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 underlying `Channel`.
`protected java.lang.Object`	`filterOutboundMessage(java.lang.Object msg)` Invoked when a new message is added to a `ChannelOutboundBuffer` of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
`boolean`	`isActive()` Return `true` if the `Channel` is active and so connected.
`protected SctpChannel`	`javaChannel()`
`java.net.InetSocketAddress`	`localAddress()` Returns the local address where this channel is bound to.
`protected java.net.SocketAddress`	`localAddress0()` Returns the `SocketAddress` which is bound locally.
`ChannelMetadata`	`metadata()` Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
`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 the `SocketAddress` which the `Channel` 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.

从类继承的方法 io.netty.channel.nio.AbstractNioMessageChannel
closeOnReadError, continueOnWriteError, continueReading, doBeginRead, doWrite, newUnsafe

从类继承的方法 io.netty.channel.nio.AbstractNioChannel
clearReadPending, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, setReadPending, unsafe

从类继承的方法 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

从类继承的方法 io.netty.util.DefaultAttributeMap
attr, hasAttr

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, pipeline, read, unsafe

从接口继承的方法 io.netty.util.AttributeMap
attr, hasAttr

从接口继承的方法 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

从接口继承的方法 java.lang.Comparable
compareTo

- 构造器详细资料
  - NioSctpChannel
```
public NioSctpChannel()
```
    Create a new instance
  - NioSctpChannel
```
public NioSctpChannel(SctpChannel sctpChannel)
```
    Create a new instance using SctpChannel
  - NioSctpChannel
```
public NioSctpChannel(Channel parent,
                      SctpChannel sctpChannel)
```
    Create a new instance
    
    参数:
    
    parent - the Channel which is the parent of this NioSctpChannel or null.
    
    sctpChannel - the underlying SctpChannel
- 方法详细资料
  - localAddress
```
public java.net.InetSocketAddress localAddress()
```
    从接口复制的说明: 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.
    
    指定者:
    
    localAddress 在接口中 Channel
    
    指定者:
    
    localAddress 在接口中 SctpChannel
    
    覆盖:
    
    localAddress 在类中 AbstractChannel
    
    返回:
    
    the local address of this channel. null if this channel is not bound.
  - remoteAddress
```
public java.net.InetSocketAddress remoteAddress()
```
    从接口复制的说明: 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.
    
    指定者:
    
    remoteAddress 在接口中 Channel
    
    指定者:
    
    remoteAddress 在接口中 SctpChannel
    
    覆盖:
    
    remoteAddress 在类中 AbstractChannel
    
    返回:
    
    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.
  - parent
```
public SctpServerChannel parent()
```
    从接口复制的说明: Channel
    
    Returns the parent of this channel.
    
    指定者:
    
    parent 在接口中 Channel
    
    指定者:
    
    parent 在接口中 SctpChannel
    
    覆盖:
    
    parent 在类中 AbstractChannel
    
    返回:
    
    the parent channel. null if this channel does not have a parent channel.
  - metadata
```
public ChannelMetadata metadata()
```
    从接口复制的说明: Channel
    
    Return the ChannelMetadata of the Channel which describe the nature of the Channel.
    
    指定者:
    
    metadata 在接口中 Channel
  - association
```
public Association association()
```
    从接口复制的说明: SctpChannel
    
    Returns the underlying SCTP association.
    
    指定者:
    
    association 在接口中 SctpChannel
  - allLocalAddresses
```
public java.util.Set<java.net.InetSocketAddress> allLocalAddresses()
```
    从接口复制的说明: 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
    
    指定者:
    
    allLocalAddresses 在接口中 SctpChannel
  - config
```
public SctpChannelConfig config()
```
    从接口复制的说明: SctpChannel
    
    Returns the SctpChannelConfig configuration of the channel.
    
    指定者:
    
    config 在接口中 Channel
    
    指定者:
    
    config 在接口中 SctpChannel
  - allRemoteAddresses
```
public java.util.Set<java.net.InetSocketAddress> allRemoteAddresses()
```
    从接口复制的说明: 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.
    
    指定者:
    
    allRemoteAddresses 在接口中 SctpChannel
  - javaChannel
```
protected SctpChannel javaChannel()
```
    覆盖:
    
    javaChannel 在类中 AbstractNioChannel
  - isActive
```
public boolean isActive()
```
    从接口复制的说明: Channel
    
    Return true if the Channel is active and so connected.
    
    指定者:
    
    isActive 在接口中 Channel
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    从类复制的说明: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    指定者:
    
    localAddress0 在类中 AbstractChannel
  - remoteAddress0
```
protected java.net.SocketAddress remoteAddress0()
```
    从类复制的说明: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
    
    指定者:
    
    remoteAddress0 在类中 AbstractChannel
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    指定者:
    
    doBind 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
    从类复制的说明: AbstractNioChannel
    
    Connect to the remote peer
    
    指定者:
    
    doConnect 在类中 AbstractNioChannel
    
    抛出:
    
    java.lang.Exception
  - doFinishConnect
```
protected void doFinishConnect()
                        throws java.lang.Exception
```
    从类复制的说明: AbstractNioChannel
    
    Finish the connect
    
    指定者:
    
    doFinishConnect 在类中 AbstractNioChannel
    
    抛出:
    
    java.lang.Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    指定者:
    
    doDisconnect 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Close the Channel
    
    覆盖:
    
    doClose 在类中 AbstractNioChannel
    
    抛出:
    
    java.lang.Exception
  - doReadMessages
```
protected int doReadMessages(java.util.List<java.lang.Object> buf)
                      throws java.lang.Exception
```
    从类复制的说明: AbstractNioMessageChannel
    
    Read messages into the given array and return the amount which was read.
    
    指定者:
    
    doReadMessages 在类中 AbstractNioMessageChannel
    
    抛出:
    
    java.lang.Exception
  - doWriteMessage
```
protected boolean doWriteMessage(java.lang.Object msg,
                                 ChannelOutboundBuffer in)
                          throws java.lang.Exception
```
    从类复制的说明: AbstractNioMessageChannel
    
    Write a message to the underlying Channel.
    
    指定者:
    
    doWriteMessage 在类中 AbstractNioMessageChannel
    
    返回:
    
    true if and only if the message has been written
    
    抛出:
    
    java.lang.Exception
  - filterOutboundMessage
```
protected final java.lang.Object filterOutboundMessage(java.lang.Object msg)
                                                throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)
    
    覆盖:
    
    filterOutboundMessage 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - bindAddress
```
public ChannelFuture bindAddress(java.net.InetAddress localAddress)
```
    从接口复制的说明: SctpChannel
    
    Bind a address to the already bound channel to enable multi-homing. The Channel bust be bound and yet to be connected.
    
    指定者:
    
    bindAddress 在接口中 SctpChannel
  - bindAddress
```
public ChannelFuture bindAddress(java.net.InetAddress localAddress,
                                 ChannelPromise promise)
```
    从接口复制的说明: 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
    
    指定者:
    
    bindAddress 在接口中 SctpChannel
  - unbindAddress
```
public ChannelFuture unbindAddress(java.net.InetAddress localAddress)
```
    从接口复制的说明: SctpChannel
    
    Unbind the address from channel's multi-homing address list. The address should be added already in multi-homing address list.
    
    指定者:
    
    unbindAddress 在接口中 SctpChannel
  - unbindAddress
```
public ChannelFuture unbindAddress(java.net.InetAddress localAddress,
                                   ChannelPromise promise)
```
    从接口复制的说明: 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
    
    指定者:
    
    unbindAddress 在接口中 SctpChannel

类 NioSctpChannel

嵌套类概要

从类继承的嵌套类/接口 io.netty.channel.nio.AbstractNioChannel

从类继承的嵌套类/接口 io.netty.channel.AbstractChannel

从接口继承的嵌套类/接口 io.netty.channel.Channel

字段概要

从类继承的字段 io.netty.channel.nio.AbstractNioChannel

构造器概要

方法概要

从类继承的方法 io.netty.channel.nio.AbstractNioMessageChannel

从类继承的方法 io.netty.channel.nio.AbstractNioChannel

从类继承的方法 io.netty.channel.AbstractChannel

从类继承的方法 io.netty.util.DefaultAttributeMap

从类继承的方法 java.lang.Object

从接口继承的方法 io.netty.channel.Channel

从接口继承的方法 io.netty.util.AttributeMap

从接口继承的方法 io.netty.channel.ChannelOutboundInvoker

从接口继承的方法 java.lang.Comparable

构造器详细资料

NioSctpChannel

NioSctpChannel

NioSctpChannel

方法详细资料

localAddress

remoteAddress

parent

metadata

association

allLocalAddresses

config

allRemoteAddresses

javaChannel

isActive

localAddress0

remoteAddress0

doBind

doConnect

doFinishConnect

doDisconnect

doClose

doReadMessages

doWriteMessage

filterOutboundMessage

bindAddress

bindAddress

unbindAddress

unbindAddress