Class NioSocketChannel
- java.lang.Object
-
- org.jboss.netty.channel.AbstractChannel
-
- org.jboss.netty.channel.socket.nio.NioSocketChannel
-
- All Implemented Interfaces:
Comparable<Channel>
,Channel
,SocketChannel
public class NioSocketChannel extends AbstractChannel implements SocketChannel
-
-
Field Summary
-
Fields inherited from interface org.jboss.netty.channel.Channel
OP_NONE, OP_READ, OP_READ_WRITE, OP_WRITE
-
-
Constructor Summary
Constructors Constructor Description NioSocketChannel(Channel parent, ChannelFactory factory, ChannelPipeline pipeline, ChannelSink sink, SocketChannel socket, NioWorker worker)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NioSocketChannelConfig
getConfig()
Returns the configuration of this channel.protected int
getInternalInterestOps()
InetSocketAddress
getLocalAddress()
Returns the local address where this channel is bound to.InetSocketAddress
getRemoteAddress()
Returns the remote address where this channel is connected to.NioWorker
getWorker()
Return theAbstractNioWorker
that handle the IO of theAbstractNioChannel
boolean
isBound()
Returnstrue
if and only if this channel is bound to a local address.boolean
isConnected()
Returnstrue
if and only if this channel is connected to a remote address.boolean
isOpen()
Returnstrue
if and only if this channel is open.protected boolean
setClosed()
Marks this channel as closed.protected void
setInternalInterestOps(int interestOps)
Sets theinterestOps
property of this channel immediately.ChannelFuture
write(Object message, SocketAddress remoteAddress)
Sends a message to this channel asynchronously.-
Methods inherited from class org.jboss.netty.channel.AbstractChannel
bind, close, compareTo, connect, disconnect, equals, getAttachment, getCloseFuture, getFactory, getId, getInterestOps, getParent, getPipeline, getSucceededFuture, getUnsupportedOperationFuture, getUserDefinedWritability, hashCode, isReadable, isWritable, setAttachment, setInterestOps, setReadable, setUnwritable, setUserDefinedWritability, setWritable, toString, unbind, write
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.jboss.netty.channel.Channel
bind, close, connect, disconnect, getAttachment, getCloseFuture, getFactory, getId, getInterestOps, getParent, getPipeline, getUserDefinedWritability, isReadable, isWritable, setAttachment, setInterestOps, setReadable, setUserDefinedWritability, unbind, write
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface org.jboss.netty.channel.socket.SocketChannel
getLocalAddress, getRemoteAddress
-
-
-
-
Constructor Detail
-
NioSocketChannel
public NioSocketChannel(Channel parent, ChannelFactory factory, ChannelPipeline pipeline, ChannelSink sink, SocketChannel socket, NioWorker worker)
-
-
Method Detail
-
getWorker
public NioWorker getWorker()
Return theAbstractNioWorker
that handle the IO of theAbstractNioChannel
- Returns:
- worker
-
getConfig
public NioSocketChannelConfig getConfig()
Description copied from interface:Channel
Returns the configuration of this channel.- Specified by:
getConfig
in interfaceChannel
- Specified by:
getConfig
in interfaceSocketChannel
-
isOpen
public boolean isOpen()
Description copied from interface:Channel
Returnstrue
if and only if this channel is open.- Specified by:
isOpen
in interfaceChannel
- Overrides:
isOpen
in classAbstractChannel
-
isBound
public boolean isBound()
Description copied from interface:Channel
Returnstrue
if and only if this channel is bound to a local address.
-
isConnected
public boolean isConnected()
Description copied from interface:Channel
Returnstrue
if and only if this channel is connected to a remote address.- Specified by:
isConnected
in interfaceChannel
-
setClosed
protected boolean setClosed()
Description copied from class:AbstractChannel
Marks this channel as closed. This method is intended to be called by an internal component - please do not call it unless you know what you are doing.- Returns:
true
if and only if this channel was not marked as closed yet
-
write
public ChannelFuture write(Object message, SocketAddress remoteAddress)
Description copied from interface:Channel
Sends a message to this channel asynchronously. It has an additional parameter that allows a user to specify where to send the specified message instead of this channel's current remote address. If this channel was created by a connectionless transport (e.g.DatagramChannel
) and is not connected yet, you must specify non-null address. Otherwise, the write request will fail withNotYetConnectedException
and an'exceptionCaught'
event will be triggered.- Specified by:
write
in interfaceChannel
- Overrides:
write
in classAbstractChannel
- Parameters:
message
- the message to writeremoteAddress
- where to send the specified message. This method is identical toChannel.write(Object)
ifnull
is specified here.- Returns:
- the
ChannelFuture
which will be notified when the write request succeeds or fails
-
getLocalAddress
public InetSocketAddress getLocalAddress()
Description copied from interface:Channel
Returns the local address where this channel is bound to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Returns:
- the local address of this channel.
null
if this channel is not bound.
-
getRemoteAddress
public InetSocketAddress getRemoteAddress()
Description copied from interface:Channel
Returns the remote address where this channel is connected to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- 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
, useMessageEvent.getRemoteAddress()
to determine the origination of the received message as this method will returnnull
.
-
getInternalInterestOps
protected int getInternalInterestOps()
- Overrides:
getInternalInterestOps
in classAbstractChannel
-
setInternalInterestOps
protected void setInternalInterestOps(int interestOps)
Description copied from class:AbstractChannel
Sets theinterestOps
property of this channel immediately. This method is intended to be called by an internal component - please do not call it unless you know what you are doing.- Overrides:
setInternalInterestOps
in classAbstractChannel
-
-