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>

@Deprecated
public class OioSctpChannel
extends AbstractOioMessageChannel
implements SctpChannel

Deprecated.

use NioSctpChannel.

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 AbstractChannel

AbstractChannel.AbstractUnsafe

Modifier and Type	Class	Description
protected class	AbstractChannel.AbstractUnsafe	Channel.Unsafe implementation which sub-classes must extend and use.

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Modifier and Type	Interface	Description
static interface	Channel.Unsafe	Unsafe operations that should never be called from user-code.

Field Summary

Fields inherited from class AbstractOioChannel

SO_TIMEOUT

Modifier and Type	Field	Description
protected static final int	SO_TIMEOUT	Deprecated.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class AbstractOioMessageChannel

doRead

Modifier and Type	Method	Description
protected void	doRead()	Deprecated.

Methods inherited from class AbstractOioChannel

clearReadPending, doBeginRead, isCompatible, isReadPending, newUnsafe, setReadPending

Modifier and Type	Method	Description
protected final void	clearReadPending()	Deprecated. Set read pending to false.
protected void	doBeginRead()	Deprecated. Schedule a read operation.
protected boolean	isCompatible(EventLoop loop)	Deprecated. Return true if the given EventLoop is compatible with this instance.
protected boolean	isReadPending()	Deprecated. No longer supported.
protected AbstractChannel.AbstractUnsafe	newUnsafe()	Deprecated. Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
protected void	setReadPending(boolean readPending)	Deprecated. Use AbstractOioChannel.clearReadPending() if appropriate instead.

Methods inherited from class AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doDeregister, doRegister, doShutdownOutput, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, unsafe, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Modifier and Type	Method	Description
ByteBufAllocator	alloc()	Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
ChannelFuture	bind(SocketAddress localAddress)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	bind(SocketAddress localAddress, ChannelPromise promise)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
long	bytesBeforeUnwritable()	Get how many bytes can be written until Channel.isWritable() returns false.
long	bytesBeforeWritable()	Get how many bytes must be drained from underlying buffers until Channel.isWritable() returns true.
ChannelFuture	close()	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	close(ChannelPromise promise)	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	closeFuture()	Returns the ChannelFuture which will be notified when this channel is closed.
final int	compareTo(Channel o)
ChannelFuture	connect(SocketAddress remoteAddress)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, ChannelPromise promise)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	deregister()	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	deregister(ChannelPromise promise)	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	disconnect()	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	disconnect(ChannelPromise promise)	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
protected void	doDeregister()	Deregister the Channel from its EventLoop.
protected void	doRegister()	Is called after the Channel is registered with its EventLoop as part of the register process.
protected void	doShutdownOutput()	Called when conditions justify shutting down the output portion of the channel.
final boolean	equals(Object o)	Returns true if and only if the specified object is identical with this channel (i.e: this == o).
EventLoop	eventLoop()	Return the EventLoop this Channel was registered to.
Channel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
final int	hashCode()	Returns the ID of this channel.
final ChannelId	id()	Returns the globally unique identifier of this Channel.
protected void	invalidateLocalAddress()	Deprecated. no use-case for this.
protected void	invalidateRemoteAddress()	Deprecated. no use-case for this.
boolean	isRegistered()	Returns true if the Channel is registered with an EventLoop.
boolean	isWritable()	Returns true if and only if the I/O thread will perform the requested write operation immediately.
protected final int	maxMessagesPerWrite()
protected DefaultChannelPipeline	newChannelPipeline()	Returns a new DefaultChannelPipeline instance.
ChannelFuture	newFailedFuture(Throwable cause)	Create a new ChannelFuture which is marked as failed already.
protected ChannelId	newId()	Returns a new DefaultChannelId instance.
ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
ChannelPromise	newPromise()	Return a new ChannelPromise.
ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
ChannelPipeline	pipeline()	Return the assigned ChannelPipeline.
Channel	read()	Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading.
String	toString()	Returns the String representation of this channel.
Channel.Unsafe	unsafe()	Returns an internal-use-only object that provides unsafe operations.
protected void	validateFileRegion(DefaultFileRegion region, long position)
final ChannelPromise	voidPromise()	Return a special ChannelPromise which can be reused for different operations.
ChannelFuture	write(Object msg)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
ChannelFuture	write(Object msg, ChannelPromise promise)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
ChannelFuture	writeAndFlush(Object msg)	Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise)	Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Modifier and Type	Method	Description
<T> Attribute<T>	attr(AttributeKey<T> key)	Get the Attribute for the given AttributeKey.
<T> boolean	hasAttr(AttributeKey<T> key)	Returns true if and only if the given Attribute exists in this AttributeMap.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OioSctpChannel

public OioSctpChannel()

Deprecated.

Create a new instance with an new SctpChannel.

OioSctpChannel

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

Deprecated.

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)

Deprecated.

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 invalid input: '{@link /*missing*/}' has no parent as it was created by your self.

ch - the SctpChannel which is used by this instance

Method Details

localAddress

public InetSocketAddress localAddress()

Deprecated.

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()

Deprecated.

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()

Deprecated.

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()

Deprecated.

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()

Deprecated.

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface SctpChannel

isOpen

public boolean isOpen()

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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()

Deprecated.

Description copied from interface: SctpChannel

Returns the underlying SCTP association.

Specified by:

association in interface SctpChannel

isActive

public boolean isActive()

Deprecated.

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()

Deprecated.

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

allLocalAddresses

public Set<InetSocketAddress> allLocalAddresses()

Deprecated.

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()

Deprecated.

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()

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

Exception

bindAddress

public ChannelFuture bindAddress(InetAddress localAddress)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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