io.netty.channel.sctp.oio

Class OioSctpChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.oio.AbstractOioChannel

io.netty.channel.oio.AbstractOioMessageChannel

io.netty.channel.sctp.oio.OioSctpChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, SctpChannel, AttributeMap, Comparable<Channel>

public class OioSctpChannel
extends AbstractOioMessageChannel
implements SctpChannel

SctpChannel implementation which use 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.AbstractChannel

AbstractChannel.AbstractUnsafe

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

Channel.Unsafe

Field Summary

Fields inherited from class io.netty.channel.oio.AbstractOioChannel

SO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
OioSctpChannel() Create a new instance with an new SctpChannel.
OioSctpChannel(Channel parent, com.sun.nio.sctp.SctpChannel ch) Create a new instance from the given SctpChannel.
OioSctpChannel(com.sun.nio.sctp.SctpChannel ch) Create a new instance from the given SctpChannel.

Method Summary

Methods

Modifier and Type	Method and Description
Set<InetSocketAddress>	allLocalAddresses() Return all local addresses of the SCTP channel.
Set<InetSocketAddress>	allRemoteAddresses() Return all remote addresses of the SCTP server channel.
com.sun.nio.sctp.Association	association() Returns the underlying SCTP association.
ChannelFuture	bindAddress(InetAddress localAddress) Bind a address to the already bound channel to enable multi-homing.
ChannelFuture	bindAddress(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(SocketAddress localAddress) Bind the Channel to the SocketAddress
protected void	doClose() Close the Channel
protected void	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer using the given localAddress if one is specified or null otherwise.
protected void	doDisconnect() Disconnect this Channel from its remote peer
protected int	doReadMessages(List<Object> msgs) Read messages into the given array and return the amount which was read.
protected void	doWrite(ChannelOutboundBuffer in) Flush the content of the given buffer to the remote peer.
protected Object	filterOutboundMessage(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.
boolean	isOpen() Returns true if the Channel is open and may get active later
InetSocketAddress	localAddress() Returns the local address where this channel is bound to.
protected 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.
InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0() Return the SocketAddress which the Channel is connected to.
ChannelFuture	unbindAddress(InetAddress localAddress) Unbind the address from channel's multi-homing address list.
ChannelFuture	unbindAddress(InetAddress localAddress, ChannelPromise promise) Unbind the address from channel's multi-homing address list.

Methods inherited from class io.netty.channel.oio.AbstractOioMessageChannel

doRead

Methods inherited from class io.netty.channel.oio.AbstractOioChannel

clearReadPending, doBeginRead, isCompatible, isReadPending, newUnsafe, setReadPending

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, doDeregister, doRegister, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, unsafe, 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.channel.Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isRegistered, isWritable, pipeline, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

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

Constructor Detail

OioSctpChannel

public OioSctpChannel()

Create a new instance with an new SctpChannel.

OioSctpChannel

public OioSctpChannel(com.sun.nio.sctp.SctpChannel ch)

Create a new instance from the given SctpChannel.

Parameters:

ch - the SctpChannel which is used by this instance

OioSctpChannel

public OioSctpChannel(Channel parent,
              com.sun.nio.sctp.SctpChannel ch)

Create a new instance from the given SctpChannel.

Parameters:

parent - the parent Channel which was used to create this instance. This can be null if the has no parent as it was created by your self.

ch - the SctpChannel which is used by this instance

Method Detail

localAddress

public 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 SctpChannel

Overrides:

localAddress in class AbstractChannel

Returns:

the local address of this channel. null if this channel is not bound.

remoteAddress

public 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

Specified by:

remoteAddress in interface SctpChannel

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.

parent

public SctpServerChannel parent()

Description copied from interface: Channel

Returns the parent of this channel.

Specified by:

parent in interface Channel

Specified by:

parent in interface SctpChannel

Overrides:

parent in class AbstractChannel

Returns:

the parent channel. null if this channel does not have a parent channel.

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

config

public SctpChannelConfig config()

Description copied from interface: SctpChannel

Returns the SctpChannelConfig configuration of the channel.

Specified by:

config in interface Channel

Specified by:

config in interface SctpChannel

isOpen

public boolean isOpen()

Description copied from interface: Channel

Returns true if the Channel is open and may get active later

Specified by:

isOpen in interface Channel

doReadMessages

protected int doReadMessages(List<Object> msgs)
                      throws Exception

Description copied from class: AbstractOioMessageChannel

Read messages into the given array and return the amount which was read.

Specified by:

doReadMessages in class AbstractOioMessageChannel

Throws:

Exception

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws Exception

Description copied from class: AbstractChannel

Flush the content of the given buffer to the remote peer.

Specified by:

doWrite in class AbstractChannel

Throws:

Exception

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)
                                throws 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:

Exception

association

public com.sun.nio.sctp.Association association()

Description copied from interface: SctpChannel

Returns the underlying SCTP association.

Specified by:

association in interface SctpChannel

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

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

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

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

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

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

Exception

doConnect

protected void doConnect(SocketAddress remoteAddress,
             SocketAddress localAddress)
                  throws Exception

Description copied from class: AbstractOioChannel

Connect to the remote peer using the given localAddress if one is specified or null otherwise.

Specified by:

doConnect in class AbstractOioChannel

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

Exception

bindAddress

public 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 ChannelFuture bindAddress(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 given ChannelPromise and return a ChannelFuture

Specified by:

bindAddress in interface SctpChannel

unbindAddress

public 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 ChannelFuture unbindAddress(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 given ChannelPromise and return a ChannelFuture

Specified by:

unbindAddress in interface SctpChannel