Package org.epics.pvaccess.impl.remote.tcp

Class BlockingTCPTransport

java.lang.Object

org.epics.pvaccess.impl.remote.codec.AbstractCodec

org.epics.pvaccess.impl.remote.codec.impl.BlockingAbstractCodec

org.epics.pvaccess.impl.remote.codec.impl.BlockingSocketAbstractCodec

org.epics.pvaccess.impl.remote.tcp.BlockingTCPTransport

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ReadableByteChannel, WritableByteChannel, Transport, TransportSendControl, org.epics.pvdata.pv.DeserializableControl, org.epics.pvdata.pv.SerializableControl

Direct Known Subclasses:

BlockingClientTCPTransport, BlockingServerTCPTransport

public abstract class BlockingTCPTransport
extends BlockingSocketAbstractCodec
implements Transport

TCP transport implementation.

Version:

$Id$

Author:

Matej Sekoranja

Nested Class Summary

Nested classes/interfaces inherited from class org.epics.pvaccess.impl.remote.codec.AbstractCodec

AbstractCodec.ReadMode, AbstractCodec.WriteMode

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	context	Context instance.
protected IntrospectionRegistry	incomingIR	Incoming (codes generated by other party) introspection registry.
protected IntrospectionRegistry	outgoingIR	Outgoing (codes generated by this party) introspection registry.
protected short	priority	Priority.
protected byte	remoteTransportRevision	Remote side transport revision (minor).
protected ResponseHandler	responseHandler	PVAS response handler.
protected boolean	verified
protected boolean	verifiedCalled

Fields inherited from class org.epics.pvaccess.impl.remote.codec.impl.BlockingSocketAbstractCodec

channel, socketAddress

Fields inherited from class org.epics.pvaccess.impl.remote.codec.AbstractCodec

blockingProcessQueue, command, flags, logger, MAX_ENSURE_BUFFER_SIZE, MAX_ENSURE_DATA_SIZE, MAX_ENSURE_SIZE, MAX_MESSAGE_PROCESS, MAX_MESSAGE_SEND, payloadSize, readMode, remoteTransportSocketReceiveBufferSize, sendBuffer, sendQueue, sendTo, socketBuffer, totalBytesSent, version, writeMode, writeOpReady

Constructor Summary

Constructors

Constructor	Description
BlockingTCPTransport(Context context, SocketChannel channel, ResponseHandler responseHandler, int receiveBufferSize, short priority)	TCP transport constructor.

Method Summary

Modifier and Type	Method	Description
org.epics.pvdata.pv.Field	cachedDeserialize(ByteBuffer buffer)
void	cachedSerialize(org.epics.pvdata.pv.Field field, ByteBuffer buffer)
void	changedTransport()	Notification that transport has changed (server restarted).
Context	getContext()	Get context transport is living in.
short	getPriority()	Transport priority.
int	getReceiveBufferSize()	Get receive buffer size.
InetSocketAddress	getRemoteAddress()	Get remote address.
byte	getRevision()	Transport protocol revision.
int	getSocketReceiveBufferSize()	Get socket receive buffer size.
String	getType()	Get protocol type (tcp, udp, ssl, etc.).
protected void	internalClose()	Called to any resources just before closing transport
protected void	internalDestroy()
void	processApplicationMessage()
void	processControlMessage()
void	setRemoteRevision(byte minor)	Set remote transport protocol revision.
void	setRemoteTransportReceiveBufferSize(int receiveBufferSize)	Set remote transport receive buffer size.
void	setRemoteTransportSocketReceiveBufferSize(int socketReceiveBufferSize)	Set remote transport socket receive buffer size.
void	verified(org.epics.pvdata.pv.Status status)	Acknowledge that transport was verified.
boolean	verify(long timeoutMs)	Waits (if needed) until transport is verified, i.e.

Methods inherited from class org.epics.pvaccess.impl.remote.codec.impl.BlockingSocketAbstractCodec

getLastReadBufferSocketAddress, invalidDataStreamHandler, read, write

Methods inherited from class org.epics.pvaccess.impl.remote.codec.impl.BlockingAbstractCodec

close, isOpen, readPollOne, receiveThread, scheduleSend, sendBufferFull, sendCompleted, sendThread, start, terminated, writePollOne

Methods inherited from class org.epics.pvaccess.impl.remote.codec.AbstractCodec

alignBuffer, alignData, alignedValue, clearSendQueue, endMessage, enqueueSendRequest, enqueueSendRequest, ensureBuffer, ensureData, flush, flushSerializeBuffer, processRead, processSendQueue, processWrite, putControlMessage, send, setByteOrder, setRecipient, setSenderThread, startMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Methods inherited from interface org.epics.pvdata.pv.DeserializableControl

alignData, ensureData

Methods inherited from interface org.epics.pvaccess.impl.remote.Transport

acquire, aliveNotification, authNZInitialize, authNZMessage, enqueueSendRequest, getSecuritySession, release, setByteOrder

Field Detail

context

protected final Context context

Context instance.

priority

protected final short priority

Priority. NOTE: Priority cannot just be changed, since it is registered in transport registry with given priority.

responseHandler

protected final ResponseHandler responseHandler

PVAS response handler.

incomingIR

protected final IntrospectionRegistry incomingIR

Incoming (codes generated by other party) introspection registry.

outgoingIR

protected final IntrospectionRegistry outgoingIR

Outgoing (codes generated by this party) introspection registry.

remoteTransportRevision

protected byte remoteTransportRevision

Remote side transport revision (minor).

verifiedCalled

protected boolean verifiedCalled

verified

protected boolean verified

Constructor Detail

BlockingTCPTransport

public BlockingTCPTransport(Context context,
                            SocketChannel channel,
                            ResponseHandler responseHandler,
                            int receiveBufferSize,
                            short priority)
                     throws SocketException

TCP transport constructor.

Parameters:

context - context where transport lives in.

channel - used socket channel.

responseHandler - response handler used to process PVA headers.

receiveBufferSize - receive buffer size.

priority - transport priority.

Throws:

SocketException - thrown on any socket exception.

Method Detail

internalDestroy

protected void internalDestroy()

Overrides:

internalDestroy in class BlockingSocketAbstractCodec

internalClose

protected void internalClose()

Called to any resources just before closing transport

getType

public String getType()

Description copied from interface: Transport

Get protocol type (tcp, udp, ssl, etc.).

Specified by:

getType in interface Transport

Returns:

protocol type.

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: Transport

Get remote address.

Specified by:

getRemoteAddress in interface Transport

Returns:

remote address.

getContext

public Context getContext()

Description copied from interface: Transport

Get context transport is living in.

Specified by:

getContext in interface Transport

Returns:

context transport is living in.

getRevision

public byte getRevision()

Description copied from interface: Transport

Transport protocol revision.

Specified by:

getRevision in interface Transport

Returns:

protocol revision.

getReceiveBufferSize

public int getReceiveBufferSize()

Description copied from interface: Transport

Get receive buffer size.

Specified by:

getReceiveBufferSize in interface Transport

Returns:

receive buffer size.

getSocketReceiveBufferSize

public int getSocketReceiveBufferSize()

Description copied from interface: Transport

Get socket receive buffer size.

Specified by:

getSocketReceiveBufferSize in interface Transport

Returns:

socket receive buffer size.

getPriority

public short getPriority()

Description copied from interface: Transport

Transport priority.

Specified by:

getPriority in interface Transport

Returns:

protocol priority.

setRemoteRevision

public void setRemoteRevision(byte minor)

Description copied from interface: Transport

Set remote transport protocol revision.

Specified by:

setRemoteRevision in interface Transport

Parameters:

minor - protocol revision.

setRemoteTransportReceiveBufferSize

public void setRemoteTransportReceiveBufferSize(int receiveBufferSize)

Description copied from interface: Transport

Set remote transport receive buffer size.

Specified by:

setRemoteTransportReceiveBufferSize in interface Transport

Parameters:

receiveBufferSize - receive buffer size.

setRemoteTransportSocketReceiveBufferSize

public void setRemoteTransportSocketReceiveBufferSize(int socketReceiveBufferSize)

Description copied from interface: Transport

Set remote transport socket receive buffer size.

Specified by:

setRemoteTransportSocketReceiveBufferSize in interface Transport

Parameters:

socketReceiveBufferSize - remote socket receive buffer size.

changedTransport

public void changedTransport()

Description copied from interface: Transport

Notification that transport has changed (server restarted).

Specified by:

changedTransport in interface Transport

processControlMessage

public void processControlMessage()

Specified by:

processControlMessage in class AbstractCodec

processApplicationMessage

public void processApplicationMessage()
                               throws IOException

Specified by:

processApplicationMessage in class AbstractCodec

Throws:

IOException

cachedDeserialize

public org.epics.pvdata.pv.Field cachedDeserialize(ByteBuffer buffer)

Specified by:

cachedDeserialize in interface org.epics.pvdata.pv.DeserializableControl

cachedSerialize

public void cachedSerialize(org.epics.pvdata.pv.Field field,
                            ByteBuffer buffer)

Specified by:

cachedSerialize in interface org.epics.pvdata.pv.SerializableControl

verified

public void verified(org.epics.pvdata.pv.Status status)

Description copied from interface: Transport

Acknowledge that transport was verified.

Specified by:

verified in interface Transport

Parameters:

status - verification status.

verify

public boolean verify(long timeoutMs)

Description copied from interface: Transport

Waits (if needed) until transport is verified, i.e. verified() method is being called.

Specified by:

verify in interface Transport

Parameters:

timeoutMs - timeout to wait for verification, infinite if 0.

Returns:

completion status.