TcpTransport

java.lang.Object
- org.fusesource.hawtdispatch.transport.ServiceBase
- - org.fusesource.hawtdispatch.transport.TcpTransport

All Implemented Interfaces:

Transport

Direct Known Subclasses:

SslTransport
```
public class TcpTransport
extends ServiceBase
implements Transport
```
An implementation of the Transport interface using raw tcp/ip

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`TcpTransport.CANCELED`
`(package private) class`	`TcpTransport.CANCELING`
`(package private) class`	`TcpTransport.CONNECTED`
`(package private) class`	`TcpTransport.CONNECTING`
`(package private) static class`	`TcpTransport.DISCONNECTED`
`(package private) static class`	`TcpTransport.OneWay`
`(package private) class`	`TcpTransport.RateLimitingChannel`
`(package private) static class`	`TcpTransport.SocketState`

Nested classes/interfaces inherited from class org.fusesource.hawtdispatch.transport.ServiceBase
ServiceBase.CallbackSupport, ServiceBase.STARTING, ServiceBase.State, ServiceBase.STOPPING

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.concurrent.Executor`	`blockingExecutor`
`private Task`	`CANCEL_HANDLER`
`protected java.nio.channels.SocketChannel`	`channel`
`(package private) boolean`	`closeOnCancel`
`protected ProtocolCodec`	`codec`
`protected DispatchQueue`	`dispatchQueue`
`protected CustomDispatchSource<java.lang.Integer,java.lang.Integer>`	`drainOutboundSource`
`static int`	`IPTOS_LOWCOST`
`static int`	`IPTOS_LOWDELAY`
`static int`	`IPTOS_RELIABILITY`
`static int`	`IPTOS_THROUGHPUT`
`(package private) boolean`	`keepAlive`
`protected TransportListener`	`listener`
`(package private) java.net.SocketAddress`	`localAddress`
`(package private) static java.net.InetAddress`	`localhost`
`protected java.net.URI`	`localLocation`
`(package private) int`	`maxReadRate`
`(package private) int`	`maxWriteRate`
`protected TcpTransport.RateLimitingChannel`	`rateLimitingChannel`
`private DispatchSource`	`readSource`
`(package private) int`	`receiveBufferSize`
`(package private) boolean`	`rejectingOffers`
`(package private) java.net.SocketAddress`	`remoteAddress`
`protected java.net.URI`	`remoteLocation`
`(package private) int`	`sendBufferSize`
`protected TcpTransport.SocketState`	`socketState`
`(package private) int`	`trafficClass`
`protected boolean`	`useLocalHost`
`(package private) boolean`	`writeResumedForCodecFlush`
`private DispatchSource`	`writeSource`
`protected CustomDispatchSource<java.lang.Integer,java.lang.Integer>`	`yieldSource`

Fields inherited from class org.fusesource.hawtdispatch.transport.ServiceBase
_serviceState, CREATED, STARTED, STOPPED

Constructor Summary

Constructors
Constructor and Description

TcpTransport()

Constructors
Constructor and Description
`TcpTransport()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`_resumeRead()`
`void`	`_start(Task onCompleted)`
`void`	`_stop(Task onCompleted)`
`private boolean`	`assertConnected()`
`void`	`connected(java.nio.channels.SocketChannel channel)`
`void`	`connecting(java.net.URI remoteLocation, java.net.URI localLocation)`
`private void`	`dispose()`
`void`	`drainInbound()`
`void`	`flush()` Forces a flush of any output buffers.
`boolean`	`full()`
`java.util.concurrent.Executor`	`getBlockingExecutor()`
`DispatchQueue`	`getDispatchQueue()` Returns the dispatch queue used by the transport
`java.net.SocketAddress`	`getLocalAddress()`
`static java.net.InetAddress`	`getLocalHost()`
`int`	`getMaxReadRate()`
`int`	`getMaxWriteRate()`
`ProtocolCodec`	`getProtocolCodec()`
`java.nio.channels.ReadableByteChannel`	`getReadChannel()`
`int`	`getReceiveBufferSize()`
`java.net.SocketAddress`	`getRemoteAddress()`
`int`	`getSendBufferSize()`
`java.nio.channels.SocketChannel`	`getSocketChannel()`
`int`	`getTrafficClass()`
`TransportListener`	`getTransportListener()` Returns the current transport listener
`java.nio.channels.WritableByteChannel`	`getWriteChannel()`
`protected void`	`initializeChannel()`
`protected void`	`initializeCodec()`
`private void`	`initRateLimitingChannel()`
`boolean`	`isClosed()`
`boolean`	`isCloseOnCancel()`
`boolean`	`isConnected()`
`boolean`	`isKeepAlive()`
`boolean`	`isUseLocalHost()`
`boolean`	`offer(java.lang.Object command)` A one way asynchronous send of a command.
`protected void`	`onConnected()`
`void`	`onTransportFailure(java.io.IOException error)`
`protected java.lang.String`	`resolveHostName(java.lang.String host)`
`void`	`resumeRead()` resume delivery of commands.
`protected void`	`resumeWrite()`
`private void`	`schedualRateAllowanceReset()`
`void`	`setBlockingExecutor(java.util.concurrent.Executor blockingExecutor)`
`void`	`setCloseOnCancel(boolean closeOnCancel)`
`void`	`setDispatchQueue(DispatchQueue queue)` Sets the dispatch queue used by the transport
`void`	`setKeepAlive(boolean keepAlive)`
`void`	`setMaxReadRate(int maxReadRate)`
`void`	`setMaxWriteRate(int maxWriteRate)`
`void`	`setProtocolCodec(ProtocolCodec protocolCodec)` Sets the protocol codec for the transport
`void`	`setReceiveBufferSize(int receiveBufferSize)`
`void`	`setSendBufferSize(int sendBufferSize)`
`void`	`setTrafficClass(int trafficClass)`
`void`	`setTransportListener(TransportListener transportListener)` Registers an inbound command listener
`void`	`setUseLocalHost(boolean useLocalHost)` Sets whether 'localhost' or the actual local host name should be used to make local connections.
`void`	`suspendRead()` suspend delivery of commands.
`protected void`	`suspendWrite()`
`private void`	`trace(java.lang.String message)`
`protected boolean`	`transportFlush()`

Methods inherited from class org.fusesource.hawtdispatch.transport.ServiceBase
getServiceState, start, start, stop, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fusesource.hawtdispatch.transport.Transport
start, start, stop, stop

Field Detail

localhost
```
static java.net.InetAddress localhost
```

remoteLocation
```
protected java.net.URI remoteLocation
```

localLocation
```
protected java.net.URI localLocation
```

listener
```
protected TransportListener listener
```

codec
```
protected ProtocolCodec codec
```

channel

protected java.nio.channels.SocketChannel channel

socketState

protected TcpTransport.SocketState socketState

dispatchQueue
```
protected DispatchQueue dispatchQueue
```

readSource
```
private DispatchSource readSource
```

writeSource
```
private DispatchSource writeSource
```

drainOutboundSource

protected CustomDispatchSource<java.lang.Integer,java.lang.Integer> drainOutboundSource

yieldSource

protected CustomDispatchSource<java.lang.Integer,java.lang.Integer> yieldSource

useLocalHost
```
protected boolean useLocalHost
```

maxReadRate
```
int maxReadRate
```

maxWriteRate
```
int maxWriteRate
```

receiveBufferSize
```
int receiveBufferSize
```

sendBufferSize
```
int sendBufferSize
```

closeOnCancel
```
boolean closeOnCancel
```

keepAlive
```
boolean keepAlive
```

IPTOS_LOWCOST
```
public static final int IPTOS_LOWCOST
```
See Also:

Constant Field Values

IPTOS_RELIABILITY
```
public static final int IPTOS_RELIABILITY
```
See Also:

Constant Field Values

IPTOS_THROUGHPUT
```
public static final int IPTOS_THROUGHPUT
```
See Also:

Constant Field Values

IPTOS_LOWDELAY
```
public static final int IPTOS_LOWDELAY
```
See Also:

Constant Field Values

trafficClass
```
int trafficClass
```

rateLimitingChannel

protected TcpTransport.RateLimitingChannel rateLimitingChannel

localAddress
```
java.net.SocketAddress localAddress
```

remoteAddress
```
java.net.SocketAddress remoteAddress
```

blockingExecutor

protected java.util.concurrent.Executor blockingExecutor

CANCEL_HANDLER
```
private final Task CANCEL_HANDLER
```

rejectingOffers
```
boolean rejectingOffers
```

writeResumedForCodecFlush
```
boolean writeResumedForCodecFlush
```

Constructor Detail
- TcpTransport
```
public TcpTransport()
```

Method Detail
- getLocalHost
```
public static java.net.InetAddress getLocalHost()
                                         throws java.net.UnknownHostException
```
  Throws:
  
  java.net.UnknownHostException
- connected
```
public void connected(java.nio.channels.SocketChannel channel)
               throws java.io.IOException,
                      java.lang.Exception
```
  Throws:
  
  java.io.IOException
  
  java.lang.Exception
- initializeChannel
```
protected void initializeChannel()
                          throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- initializeCodec
```
protected void initializeCodec()
                        throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- initRateLimitingChannel
```
private void initRateLimitingChannel()
```
- connecting
```
public void connecting(java.net.URI remoteLocation,
                       java.net.URI localLocation)
                throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- getDispatchQueue
```
public DispatchQueue getDispatchQueue()
```
  Description copied from interface: Transport
  
  Returns the dispatch queue used by the transport
  
  Specified by:
  
  getDispatchQueue in interface Transport
  
  Specified by:
  
  getDispatchQueue in class ServiceBase
  
  Returns:
- setDispatchQueue
```
public void setDispatchQueue(DispatchQueue queue)
```
  Description copied from interface: Transport
  
  Sets the dispatch queue used by the transport
  
  Specified by:
  
  setDispatchQueue in interface Transport
- _start
```
public void _start(Task onCompleted)
```
  Specified by:
  
  _start in class ServiceBase
- _stop
```
public void _stop(Task onCompleted)
```
  Specified by:
  
  _stop in class ServiceBase
- resolveHostName
```
protected java.lang.String resolveHostName(java.lang.String host)
                                    throws java.net.UnknownHostException
```
  Throws:
  
  java.net.UnknownHostException
- onConnected
```
protected void onConnected()
                    throws java.io.IOException
```
  Throws:
  
  java.io.IOException
- schedualRateAllowanceReset
```
private void schedualRateAllowanceReset()
```
- dispose
```
private void dispose()
```
- onTransportFailure
```
public void onTransportFailure(java.io.IOException error)
```
- full
```
public boolean full()
```
  Specified by:
  
  full in interface Transport
- offer
```
public boolean offer(java.lang.Object command)
```
  Description copied from interface: Transport
  
  A one way asynchronous send of a command. Only sent if the the transport is not full.
  
  Specified by:
  
  offer in interface Transport
  
  Returns:
  
  true if the command was accepted.
- flush
```
public void flush()
```
  Description copied from interface: Transport
  
  Forces a flush of any output buffers. Once the flush completes the listener's 'onRefill()' method will execute.
  
  Specified by:
  
  flush in interface Transport
- transportFlush
```
protected boolean transportFlush()
                          throws java.io.IOException
```
  Throws:
  
  java.io.IOException
- drainInbound
```
public void drainInbound()
```
  Specified by:
  
  drainInbound in interface Transport
- getLocalAddress
```
public java.net.SocketAddress getLocalAddress()
```
  Specified by:
  
  getLocalAddress in interface Transport
  
  Returns:
  
  the remote address for this connection
- getRemoteAddress
```
public java.net.SocketAddress getRemoteAddress()
```
  Specified by:
  
  getRemoteAddress in interface Transport
  
  Returns:
  
  the remote address for this connection
- assertConnected
```
private boolean assertConnected()
```
- suspendRead
```
public void suspendRead()
```
  Description copied from interface: Transport
  
  suspend delivery of commands.
  
  Specified by:
  
  suspendRead in interface Transport
- resumeRead
```
public void resumeRead()
```
  Description copied from interface: Transport
  
  resume delivery of commands.
  
  Specified by:
  
  resumeRead in interface Transport
- _resumeRead
```
private void _resumeRead()
```
- suspendWrite
```
protected void suspendWrite()
```
- resumeWrite
```
protected void resumeWrite()
```
- getTransportListener
```
public TransportListener getTransportListener()
```
  Description copied from interface: Transport
  
  Returns the current transport listener
  
  Specified by:
  
  getTransportListener in interface Transport
  
  Returns:
- setTransportListener
```
public void setTransportListener(TransportListener transportListener)
```
  Description copied from interface: Transport
  
  Registers an inbound command listener
  
  Specified by:
  
  setTransportListener in interface Transport
- getProtocolCodec
```
public ProtocolCodec getProtocolCodec()
```
  Specified by:
  
  getProtocolCodec in interface Transport
  
  Returns:
  
  The protocol codec for the transport.
- setProtocolCodec
```
public void setProtocolCodec(ProtocolCodec protocolCodec)
                      throws java.lang.Exception
```
  Description copied from interface: Transport
  
  Sets the protocol codec for the transport
  
  Specified by:
  
  setProtocolCodec in interface Transport
  
  Throws:
  
  java.lang.Exception
- isConnected
```
public boolean isConnected()
```
  Specified by:
  
  isConnected in interface Transport
  
  Returns:
  
  true if the transport is connected
- isClosed
```
public boolean isClosed()
```
  Specified by:
  
  isClosed in interface Transport
  
  Returns:
  
  true if the transport is closed/stopped.
- isUseLocalHost
```
public boolean isUseLocalHost()
```
- setUseLocalHost
```
public void setUseLocalHost(boolean useLocalHost)
```
  Sets whether 'localhost' or the actual local host name should be used to make local connections. On some operating systems such as Macs its not possible to connect as the local host name so localhost is better.
- trace
```
private void trace(java.lang.String message)
```
- getSocketChannel
```
public java.nio.channels.SocketChannel getSocketChannel()
```
- getReadChannel
```
public java.nio.channels.ReadableByteChannel getReadChannel()
```
  Specified by:
  
  getReadChannel in interface Transport
- getWriteChannel
```
public java.nio.channels.WritableByteChannel getWriteChannel()
```
  Specified by:
  
  getWriteChannel in interface Transport
- getMaxReadRate
```
public int getMaxReadRate()
```
- setMaxReadRate
```
public void setMaxReadRate(int maxReadRate)
```
- getMaxWriteRate
```
public int getMaxWriteRate()
```
- setMaxWriteRate
```
public void setMaxWriteRate(int maxWriteRate)
```
- getTrafficClass
```
public int getTrafficClass()
```
- setTrafficClass
```
public void setTrafficClass(int trafficClass)
```
- getReceiveBufferSize
```
public int getReceiveBufferSize()
```
- setReceiveBufferSize
```
public void setReceiveBufferSize(int receiveBufferSize)
```
- getSendBufferSize
```
public int getSendBufferSize()
```
- setSendBufferSize
```
public void setSendBufferSize(int sendBufferSize)
```
- isKeepAlive
```
public boolean isKeepAlive()
```
- setKeepAlive
```
public void setKeepAlive(boolean keepAlive)
```
- getBlockingExecutor
```
public java.util.concurrent.Executor getBlockingExecutor()
```
  Specified by:
  
  getBlockingExecutor in interface Transport
- setBlockingExecutor
```
public void setBlockingExecutor(java.util.concurrent.Executor blockingExecutor)
```
  Specified by:
  
  setBlockingExecutor in interface Transport
- isCloseOnCancel
```
public boolean isCloseOnCancel()
```
- setCloseOnCancel
```
public void setCloseOnCancel(boolean closeOnCancel)
```

Class TcpTransport

Nested Class Summary

Nested classes/interfaces inherited from class org.fusesource.hawtdispatch.transport.ServiceBase

Field Summary

Fields inherited from class org.fusesource.hawtdispatch.transport.ServiceBase

Constructor Summary

Method Summary

Methods inherited from class org.fusesource.hawtdispatch.transport.ServiceBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.fusesource.hawtdispatch.transport.Transport

Field Detail

localhost

remoteLocation

localLocation

listener

codec

channel

socketState

dispatchQueue

readSource

writeSource

drainOutboundSource

yieldSource

useLocalHost

maxReadRate

maxWriteRate

receiveBufferSize

sendBufferSize

closeOnCancel

keepAlive

IPTOS_LOWCOST

IPTOS_RELIABILITY

IPTOS_THROUGHPUT

IPTOS_LOWDELAY

trafficClass

rateLimitingChannel

localAddress

remoteAddress

blockingExecutor

CANCEL_HANDLER

rejectingOffers

writeResumedForCodecFlush

Constructor Detail

TcpTransport

Method Detail

getLocalHost

connected

initializeChannel

initializeCodec

initRateLimitingChannel

connecting

getDispatchQueue

setDispatchQueue

_start

_stop

resolveHostName

onConnected

schedualRateAllowanceReset

dispose

onTransportFailure

full

offer

flush

transportFlush

drainInbound

getLocalAddress

getRemoteAddress

assertConnected

suspendRead

resumeRead

_resumeRead

suspendWrite

resumeWrite

getTransportListener

setTransportListener

getProtocolCodec

setProtocolCodec

isConnected

isClosed

isUseLocalHost