NioSctpServerChannel (Netty API Reference (4.0.56.Final))

JavaScript is disabled on your browser.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

io.netty.channel.sctp.nio

Class NioSctpServerChannel

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.NioSctpServerChannel

All Implemented Interfaces:

Channel, SctpServerChannel, ServerChannel, AttributeMap, java.lang.Comparable<Channel>
```
public class NioSctpServerChannel
extends AbstractNioMessageChannel
implements SctpServerChannel 
```
SctpServerChannel implementation which use non-blocking mode to accept new connections and create the NioSctpChannel 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.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

Constructor Summary

Constructors
Constructor and Description

NioSctpServerChannel ()
Create a new instance

Constructors
Constructor and Description
`NioSctpServerChannel ()` Create a new instance

Method Summary

All Methods
Modifier and Type	Method and Description
`java.util.Set<java.net.InetSocketAddress>`	`allLocalAddresses ()` Return all local addresses of the SCTP server channel.
`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.
`SctpServerChannelConfig`	`config ()` Returns the `SctpServerChannelConfig` 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 com.sun.nio.sctp.SctpServerChannel`	`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`.
`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.

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

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

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

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

Methods inherited from interface java.lang.Comparable
compareTo

- Constructor Detail
  - NioSctpServerChannel
```
public NioSctpServerChannel()
```
    Create a new 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
  - allLocalAddresses
```
public java.util.Set<java.net.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
  - 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
  - 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
  - remoteAddress
```
public java.net.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 java.net.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.
  - javaChannel
```
protected com.sun.nio.sctp.SctpServerChannel javaChannel()
```
    Overrides:
    
    javaChannel in class AbstractNioChannel
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    Description copied from class: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    Specified by:
    
    localAddress0 in class AbstractChannel
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
 throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    Specified by:
    
    doBind in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doClose
```
protected void doClose()
 throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Close the Channel
    
    Overrides:
    
    doClose in class AbstractNioChannel
    
    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 class AbstractNioMessageChannel
    
    Throws:
    
    java.lang.Exception
  - bindAddress
```
public ChannelFuture bindAddress(java.net.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(java.net.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(java.net.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(java.net.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 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 class AbstractNioChannel
    
    Throws:
    
    java.lang.Exception
  - doFinishConnect
```
protected void doFinishConnect()
 throws java.lang.Exception
```
    Description copied from class: AbstractNioChannel
    
    Finish the connect
    
    Specified by:
    
    doFinishConnect in class AbstractNioChannel
    
    Throws:
    
    java.lang.Exception
  - remoteAddress0
```
protected java.net.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 java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    Specified by:
    
    doDisconnect in class AbstractChannel
    
    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 underlying Channel.
    
    Specified by:
    
    doWriteMessage in class AbstractNioMessageChannel
    
    Returns:
    
    true if and only if the message has been written
    
    Throws:
    
    java.lang.Exception
  - filterOutboundMessage
```
protected 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 a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)
    
    Overrides:
    
    filterOutboundMessage in class AbstractChannel
    
    Throws:
    
    java.lang.Exception

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class NioSctpServerChannel

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

NioSctpServerChannel

Method Detail

metadata

allLocalAddresses

config

isActive

remoteAddress

localAddress

javaChannel

localAddress0

doBind

doClose

doReadMessages

bindAddress

bindAddress

unbindAddress

unbindAddress

doConnect

doFinishConnect

remoteAddress0

doDisconnect

doWriteMessage

filterOutboundMessage