Package org.epics.pvaccess.impl.remote
Interface Transport
-
- All Superinterfaces:
AutoCloseable
,Channel
,Closeable
,org.epics.pvdata.pv.DeserializableControl
- All Known Implementing Classes:
BlockingClientTCPTransport
,BlockingServerTCPTransport
,BlockingTCPTransport
,BlockingUDPTransport
,NonBlockingClientTCPTransport
,NonBlockingServerTCPTransport
,NonBlockingTCPTransport
public interface Transport extends org.epics.pvdata.pv.DeserializableControl, Channel
Interface defining transport (connection).- Version:
- $Id$
- Author:
- Matej Sekoranja
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
acquire(TransportClient client)
Acquires transport.void
aliveNotification()
Alive notification.void
authNZInitialize(Object data)
Used to initialize authNZ (select security plug-in).void
authNZMessage(org.epics.pvdata.pv.PVField data)
Pass data to the active security plug-in session.void
changedTransport()
Notification that transport has changed (server restarted).void
enqueueSendRequest(TransportSender sender)
Enqueue send request.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.SecurityPlugin.SecuritySession
getSecuritySession()
int
getSocketReceiveBufferSize()
Get socket receive buffer size.String
getType()
Get protocol type (tcp, udp, ssl, etc.).void
release(TransportClient client)
Releases transport.void
setByteOrder(ByteOrder byteOrder)
Set byte order.void
setRemoteRevision(byte revision)
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.
-
-
-
Method Detail
-
acquire
boolean acquire(TransportClient client)
Acquires transport.- Parameters:
client
- client (channel) acquiring the transport- Returns:
true
if transport was granted,false
otherwise.
-
release
void release(TransportClient client)
Releases transport.- Parameters:
client
- client (channel) releasing the transport
-
getType
String getType()
Get protocol type (tcp, udp, ssl, etc.).- Returns:
- protocol type.
-
getRemoteAddress
InetSocketAddress getRemoteAddress()
Get remote address.- Returns:
- remote address.
-
getContext
Context getContext()
Get context transport is living in.- Returns:
- context transport is living in.
-
getRevision
byte getRevision()
Transport protocol revision.- Returns:
- protocol revision.
-
getReceiveBufferSize
int getReceiveBufferSize()
Get receive buffer size.- Returns:
- receive buffer size.
-
getSocketReceiveBufferSize
int getSocketReceiveBufferSize()
Get socket receive buffer size.- Returns:
- socket receive buffer size.
-
getPriority
short getPriority()
Transport priority.- Returns:
- protocol priority.
-
setRemoteRevision
void setRemoteRevision(byte revision)
Set remote transport protocol revision.- Parameters:
revision
- protocol revision.
-
setRemoteTransportReceiveBufferSize
void setRemoteTransportReceiveBufferSize(int receiveBufferSize)
Set remote transport receive buffer size.- Parameters:
receiveBufferSize
- receive buffer size.
-
setRemoteTransportSocketReceiveBufferSize
void setRemoteTransportSocketReceiveBufferSize(int socketReceiveBufferSize)
Set remote transport socket receive buffer size.- Parameters:
socketReceiveBufferSize
- remote socket receive buffer size.
-
setByteOrder
void setByteOrder(ByteOrder byteOrder)
Set byte order.- Parameters:
byteOrder
- byte order to set.
-
changedTransport
void changedTransport()
Notification that transport has changed (server restarted).
-
enqueueSendRequest
void enqueueSendRequest(TransportSender sender)
Enqueue send request.- Parameters:
sender
- sender to enqueue.
-
verify
boolean verify(long timeoutMs)
Waits (if needed) until transport is verified, i.e. verified() method is being called.- Parameters:
timeoutMs
- timeout to wait for verification, infinite if 0.- Returns:
- completion status.
-
verified
void verified(org.epics.pvdata.pv.Status status)
Acknowledge that transport was verified.- Parameters:
status
- verification status.
-
aliveNotification
void aliveNotification()
Alive notification. This method needs to be called (by newly received data or beacon) at least once in this period, if not echo will be issued and if there is not response to it, transport will be considered as unresponsive.
-
authNZMessage
void authNZMessage(org.epics.pvdata.pv.PVField data)
Pass data to the active security plug-in session.- Parameters:
data
- the data (any data), can benull
.
-
authNZInitialize
void authNZInitialize(Object data)
Used to initialize authNZ (select security plug-in).- Parameters:
data
- any data.
-
getSecuritySession
SecurityPlugin.SecuritySession getSecuritySession()
-
-