PipeTransport

java.lang.Object
- org.fusesource.hawtdispatch.transport.PipeTransport

All Implemented Interfaces:: Transport

public class PipeTransport
extends java.lang.Object
implements Transport

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class PipeTransport.OneWay

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`PipeTransport.OneWay`

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`connected`
`private DispatchQueue`	`dispatchQueue`
`private CustomDispatchSource<java.lang.Object,java.util.LinkedList<java.lang.Object>>`	`dispatchSource`
`private static java.lang.Object`	`EOF_TOKEN`
`private TransportListener`	`listener`
`private boolean`	`marshal`
`(package private) int`	`maxOutbound`
`private java.lang.String`	`name`
`(package private) int`	`outbound`
`(package private) PipeTransport`	`peer`
`private ProtocolCodec`	`protocolCodec`
`private long`	`readCounter`
`private java.net.SocketAddress`	`remoteAddress`
`private PipeTransportServer`	`server`
`private java.util.concurrent.atomic.AtomicBoolean`	`stopping`
`private boolean`	`trace`
`private long`	`writeCounter`

Constructor Summary

Constructors
Constructor and Description

PipeTransport(PipeTransportServer server)

Constructors
Constructor and Description
`PipeTransport(PipeTransportServer server)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`drainInbound()`
`private void`	`fireConnected()`
`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()`
`ProtocolCodec`	`getProtocolCodec()`
`java.nio.channels.ReadableByteChannel`	`getReadChannel()`
`long`	`getReadCounter()`
`java.net.SocketAddress`	`getRemoteAddress()`
`TransportListener`	`getTransportListener()` Returns the current transport listener
`java.nio.channels.WritableByteChannel`	`getWriteChannel()`
`long`	`getWriteCounter()`
`boolean`	`isClosed()`
`boolean`	`isConnected()`
`boolean`	`isMarshal()`
`boolean`	`isTrace()`
`boolean`	`offer(java.lang.Object command)` A one way asynchronous send of a command.
`void`	`resumeRead()` resume delivery of commands.
`void`	`setBlockingExecutor(java.util.concurrent.Executor blockingExecutor)`
`void`	`setDispatchQueue(DispatchQueue queue)` Sets the dispatch queue used by the transport
`void`	`setMarshal(boolean marshall)`
`void`	`setName(java.lang.String name)`
`void`	`setProtocolCodec(ProtocolCodec protocolCodec)` Sets the protocol codec for the transport
`void`	`setRemoteAddress(java.lang.String remoteAddress)`
`void`	`setTrace(boolean trace)`
`void`	`setTransportListener(TransportListener transportListener)` Registers an inbound command listener
`void`	`start(java.lang.Runnable onCompleted)` Deprecated.
`void`	`start(Task onCompleted)` Starts the service.
`void`	`stop(java.lang.Runnable onCompleted)` Deprecated.
`void`	`stop(Task onCompleted)` Stops the service.
`void`	`suspendRead()` suspend delivery of commands.
`private void`	`transmit(java.lang.Object command)`

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

- Field Detail
  - EOF_TOKEN
```
private static final java.lang.Object EOF_TOKEN
```
  - server
```
private final PipeTransportServer server
```
  - peer
```
PipeTransport peer
```
  - listener
```
private TransportListener listener
```
  - remoteAddress
```
private java.net.SocketAddress remoteAddress
```
  - stopping
```
private java.util.concurrent.atomic.AtomicBoolean stopping
```
  - name
```
private java.lang.String name
```
  - marshal
```
private boolean marshal
```
  - trace
```
private boolean trace
```
  - dispatchQueue
```
private DispatchQueue dispatchQueue
```
  - dispatchSource
```
private CustomDispatchSource<java.lang.Object,java.util.LinkedList<java.lang.Object>> dispatchSource
```
  - connected
```
private boolean connected
```
  - writeCounter
```
private long writeCounter
```
  - readCounter
```
private long readCounter
```
  - protocolCodec
```
private ProtocolCodec protocolCodec
```
  - outbound
```
int outbound
```
  - maxOutbound
```
int maxOutbound
```
- Constructor Detail
  - PipeTransport
```
public PipeTransport(PipeTransportServer server)
```
- Method Detail
  - getDispatchQueue
```
public DispatchQueue getDispatchQueue()
```
    Description copied from interface: Transport
    
    Returns the dispatch queue used by the transport
    
    Specified by:
    
    getDispatchQueue in interface Transport
    
    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
```
@Deprecated
public void start(java.lang.Runnable onCompleted)
```
    Deprecated.
    
    Description copied from interface: Transport
    
    Starts the service. Executes the onComplete runnable once the service has fully started up.
    
    Specified by:
    
    start in interface Transport
    
    Parameters:
    
    onCompleted - my be set to null if not interested in a callback.
  - start
```
public void start(Task onCompleted)
```
    Description copied from interface: Transport
    
    Starts the service. Executes the onComplete runnable once the service has fully started up.
    
    Specified by:
    
    start in interface Transport
    
    Parameters:
    
    onCompleted - my be set to null if not interested in a callback.
  - fireConnected
```
private void fireConnected()
```
  - 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
  - stop
```
@Deprecated
public void stop(java.lang.Runnable onCompleted)
```
    Deprecated.
    
    Description copied from interface: Transport
    
    Stops the service. Executes the onComplete runnable once the service has fully stopped.
    
    Specified by:
    
    stop in interface Transport
    
    Parameters:
    
    onCompleted - my be set to null if not interested in a callback.
  - stop
```
public void stop(Task onCompleted)
```
    Description copied from interface: Transport
    
    Stops the service. Executes the onComplete runnable once the service has fully stopped.
    
    Specified by:
    
    stop in interface Transport
    
    Parameters:
    
    onCompleted - my be set to null if not interested in a callback.
  - 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.
  - drainInbound
```
public void drainInbound()
```
    Specified by:
    
    drainInbound in interface Transport
  - transmit
```
private void transmit(java.lang.Object command)
```
  - getWriteCounter
```
public long getWriteCounter()
```
    Returns:
    
    The number of objects sent by the transport.
  - getReadCounter
```
public long getReadCounter()
```
    Returns:
    
    The number of objects received by the 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
  - 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
  - setRemoteAddress
```
public void setRemoteAddress(java.lang.String remoteAddress)
```
  - setName
```
public void setName(java.lang.String name)
```
  - 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)
```
    Description copied from interface: Transport
    
    Sets the protocol codec for the transport
    
    Specified by:
    
    setProtocolCodec in interface Transport
  - isTrace
```
public boolean isTrace()
```
  - setTrace
```
public void setTrace(boolean trace)
```
  - isMarshal
```
public boolean isMarshal()
```
  - setMarshal
```
public void setMarshal(boolean marshall)
```
  - 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.
  - 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
  - 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

Class PipeTransport

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EOF_TOKEN

server

peer

listener

remoteAddress

stopping

name

marshal

trace

dispatchQueue

dispatchSource

connected

writeCounter

readCounter

protocolCodec

outbound

maxOutbound

Constructor Detail

PipeTransport

Method Detail

getDispatchQueue

setDispatchQueue

start

start

fireConnected

flush

stop

stop

full

offer

drainInbound

transmit

getWriteCounter

getReadCounter

getLocalAddress

getRemoteAddress

suspendRead

resumeRead

setRemoteAddress

setName

getTransportListener

setTransportListener

getProtocolCodec

setProtocolCodec

isTrace

setTrace

isMarshal

setMarshal

isConnected

isClosed

getBlockingExecutor

setBlockingExecutor

getReadChannel

getWriteChannel