#include "codec.h"

Inheritance diagram for epics::pvAccess::detail::BlockingTCPTransportCodec:

Collaboration diagram for epics::pvAccess::detail::BlockingTCPTransportCodec:

Public Member Functions
	POINTER_DEFINITIONS (BlockingTCPTransportCodec)

	BlockingTCPTransportCodec (bool serverFlag, Context::shared_pointer const &context, SOCKET channel, ResponseHandler::shared_pointer const &responseHandler, size_t sendBufferSize, size_t receiveBufferSize, epics::pvData::int16 priority)

virtual	~BlockingTCPTransportCodec ()

virtual void	readPollOne () OVERRIDE FINAL

virtual void	writePollOne () OVERRIDE FINAL

virtual void	scheduleSend () OVERRIDE FINAL

virtual void	sendCompleted () OVERRIDE FINAL

virtual void	close () OVERRIDE FINAL

virtual void	waitJoin () OVERRIDE FINAL
	Call after close() to wait for any worker threads to exit. More...

virtual bool	terminated () OVERRIDE FINAL

virtual bool	isOpen () OVERRIDE FINAL

virtual void	start ()

virtual int	read (epics::pvData::ByteBuffer *dst) OVERRIDE FINAL

virtual int	write (epics::pvData::ByteBuffer *src) OVERRIDE FINAL

virtual const osiSockAddr *	getLastReadBufferSocketAddress () OVERRIDE FINAL

virtual void	invalidDataStreamHandler () OVERRIDE FINAL

virtual std::string	getType () const OVERRIDE FINAL

virtual void	processControlMessage () OVERRIDE FINAL

virtual void	processApplicationMessage () OVERRIDE FINAL

virtual const osiSockAddr &	getRemoteAddress () const OVERRIDE FINAL

virtual const std::string &	getRemoteName () const OVERRIDE FINAL

virtual std::size_t	getReceiveBufferSize () const OVERRIDE FINAL

virtual epics::pvData::int16	getPriority () const OVERRIDE FINAL

virtual void	setRemoteTransportReceiveBufferSize (std::size_t remoteTransportReceiveBufferSize) OVERRIDE FINAL

virtual void	setRemoteTransportSocketReceiveBufferSize (std::size_t socketReceiveBufferSize) OVERRIDE FINAL

virtual std::tr1::shared_ptr< const epics::pvData::Field >	cachedDeserialize (epics::pvData::ByteBuffer *buffer) OVERRIDE FINAL

virtual void	cachedSerialize (const std::tr1::shared_ptr< const epics::pvData::Field > &field, epics::pvData::ByteBuffer *buffer) OVERRIDE FINAL

virtual void	flushSendQueue () OVERRIDE FINAL

virtual bool	isClosed () OVERRIDE FINAL

void	activate ()

virtual bool	verify (epics::pvData::int32 timeoutMs) OVERRIDE

virtual void	verified (epics::pvData::Status const &status) OVERRIDE

virtual void	authNZMessage (epics::pvData::PVStructure::shared_pointer const &data) OVERRIDE FINAL

virtual void	sendSecurityPluginMessage (epics::pvData::PVStructure::const_shared_pointer const &data) OVERRIDE FINAL

Public Member Functions inherited from epics::pvAccess::detail::AbstractCodec
	AbstractCodec (bool serverFlag, size_t sendBufferSize, size_t receiveBufferSize, int32_t socketSendBufferSize, bool blockingProcessQueue)

virtual	~AbstractCodec ()

virtual void	alignBuffer (std::size_t alignment) OVERRIDE FINAL

virtual void	ensureData (std::size_t size) OVERRIDE FINAL

virtual void	alignData (std::size_t alignment) OVERRIDE FINAL

virtual void	startMessage (epics::pvData::int8 command, std::size_t ensureCapacity=0, epics::pvData::int32 payloadSize=0) OVERRIDE FINAL

void	putControlMessage (epics::pvData::int8 command, epics::pvData::int32 data)

virtual void	endMessage () OVERRIDE FINAL

virtual void	ensureBuffer (std::size_t size) OVERRIDE FINAL

virtual void	flushSerializeBuffer () OVERRIDE FINAL

virtual void	flush (bool lastMessageCompleted) OVERRIDE FINAL

void	processWrite ()

void	processRead ()

void	processSendQueue ()

virtual void	enqueueSendRequest (TransportSender::shared_pointer const &sender) OVERRIDE FINAL

void	enqueueSendRequest (TransportSender::shared_pointer const &sender, std::size_t requiredBufferSize)

void	setSenderThread ()

virtual void	setRecipient (osiSockAddr const &sendTo) OVERRIDE FINAL

virtual void	setByteOrder (int byteOrder) OVERRIDE FINAL

virtual bool	directSerialize (epics::pvData::ByteBuffer , const char , std::size_t, std::size_t) OVERRIDE

virtual bool	directDeserialize (epics::pvData::ByteBuffer , char , std::size_t, std::size_t) OVERRIDE

bool	sendQueueEmpty () const

epics::pvData::int8	getRevision () const

Public Member Functions inherited from epics::pvAccess::TransportSendControl
	POINTER_DEFINITIONS (TransportSendControl)

virtual	~TransportSendControl ()

Public Member Functions inherited from epics::pvData::SerializableControl
virtual	~SerializableControl ()

virtual void	cachedSerialize (std::tr1::shared_ptr< const Field > const &field, ByteBuffer *buffer)=0

Public Member Functions inherited from epics::pvAccess::Transport
	POINTER_DEFINITIONS (Transport)

	Transport ()

virtual	~Transport ()

virtual bool	acquire (std::tr1::shared_ptr< ClientChannelImpl > const &client)=0

virtual void	release (pvAccessID clientId)=0

Public Member Functions inherited from epics::pvData::DeserializableControl
virtual	~DeserializableControl ()

Public Member Functions inherited from epics::pvAccess::AuthenticationPluginControl
	POINTER_DEFINITIONS (AuthenticationPluginControl)

virtual	~AuthenticationPluginControl ()

virtual void	authenticationCompleted (const epics::pvData::Status &status, const std::tr1::shared_ptr< PeerInfo > &peer)=0

Public Attributes
PeerInfo::const_shared_pointer	_peerInfo

Public Attributes inherited from epics::pvAccess::detail::AbstractCodec
epics::pvData::Mutex	_mutex

Public Attributes inherited from epics::pvAccess::Transport
size_t	_totalBytesSent

size_t	_totalBytesRecv

Static Public Attributes
static size_t	num_instances

Static Public Attributes inherited from epics::pvAccess::detail::AbstractCodec
static const std::size_t	MAX_MESSAGE_PROCESS = 100

static const std::size_t	MAX_MESSAGE_SEND = 100

static const std::size_t	MAX_ENSURE_SIZE = 1024

static const std::size_t	MAX_ENSURE_DATA_SIZE = MAX_ENSURE_SIZE/2

static const std::size_t	MAX_ENSURE_BUFFER_SIZE = MAX_ENSURE_SIZE

static const std::size_t	MAX_ENSURE_DATA_BUFFER_SIZE = 1024

Static Public Attributes inherited from epics::pvAccess::Transport
static size_t	num_instances

Protected Member Functions
virtual void	setRxTimeout (bool ena) OVERRIDE FINAL

virtual void	sendBufferFull (int tries) OVERRIDE FINAL

virtual void	internalClose ()

Protected Member Functions inherited from epics::pvAccess::detail::AbstractCodec
void	send (epics::pvData::ByteBuffer *buffer)

void	flushSendBuffer ()

Protected Attributes
osiSockAddr	_socketAddress

std::string	_socketName

Context::shared_pointer	_context

IntrospectionRegistry	_incomingIR

IntrospectionRegistry	_outgoingIR

std::string	_authSessionName

AuthenticationSession::shared_pointer	_authSession

bool	_verified

epics::pvData::Event	_verifiedEvent

Protected Attributes inherited from epics::pvAccess::detail::AbstractCodec
ReadMode	_readMode

int8_t	_version

int8_t	_flags

int8_t	_command

int32_t	_payloadSize

epics::pvData::int32	_remoteTransportSocketReceiveBufferSize

osiSockAddr	_sendTo

epicsThreadId	_senderThread

WriteMode	_writeMode

bool	_writeOpReady

epics::pvData::ByteBuffer	_socketBuffer

epics::pvData::ByteBuffer	_sendBuffer

fair_queue< TransportSender >	_sendQueue

const epics::pvData::int8	_clientServerFlag

Additional Inherited Members
Static Public Member Functions inherited from epics::pvAccess::detail::AbstractCodec
static std::size_t	alignedValue (std::size_t value, std::size_t alignment)

Detailed Description

Definition at line 268 of file codec.h.

Constructor & Destructor Documentation

epics::pvAccess::detail::BlockingTCPTransportCodec::BlockingTCPTransportCodec	(	bool	serverFlag,
		Context::shared_pointer const &	context,
		SOCKET	channel,
		ResponseHandler::shared_pointer const &	responseHandler,
		size_t	sendBufferSize,
		size_t	receiveBufferSize,
		epics::pvData::int16	priority
	)

Definition at line 1226 of file codec.cpp.

     :AbstractCodec(
          serverFlag,
          sendBufferSize,
          receiveBufferSize,
          sendBufferSize,
          true)
     ,_readThread(epics::pvData::Thread::Config(this, &BlockingTCPTransportCodec::receiveThread)
                  .prio(epicsThreadPriorityCAServerLow)
                  .name("TCP-rx")
                  .stack(epicsThreadStackBig)
                  .autostart(false))
     ,_sendThread(epics::pvData::Thread::Config(this, &BlockingTCPTransportCodec::sendThread)
                  .prio(epicsThreadPriorityCAServerLow)
                  .name("TCP-tx")
                  .stack(epicsThreadStackBig)
                  .autostart(false))
     ,_channel(channel)
     ,_context(context), _responseHandler(responseHandler)
     ,_remoteTransportReceiveBufferSize(MAX_TCP_RECV)
     ,_priority(priority)
     ,_verified(false)
 {
     REFTRACE_INCREMENT(num_instances);
 
     _isOpen.getAndSet(true);
 
     // get remote address
     osiSocklen_t saSize = sizeof(sockaddr);
     int retval = getpeername(_channel, &(_socketAddress.sa), &saSize);
     if(unlikely(retval<0)) {
         char errStr[64];
         epicsSocketConvertErrnoToString(errStr, sizeof(errStr));
         LOG(logLevelError,
             "Error fetching socket remote address: %s.",
             errStr);
         _socketName = "<unknown>:0";
     } else {
         char ipAddrStr[24];
         ipAddrToDottedIP(&_socketAddress.ia, ipAddrStr, sizeof(ipAddrStr));
         _socketName = ipAddrStr;
     }
 }

epics::pvAccess::detail::BlockingTCPTransportCodec::~BlockingTCPTransportCodec ( )

virtual

Definition at line 1016 of file codec.cpp.

 {
     REFTRACE_DECREMENT(num_instances);
 
     waitJoin();
 }

Member Function Documentation

void epics::pvAccess::detail::BlockingTCPTransportCodec::activate ( )

inline

Definition at line 380 of file codec.h.

                     {
         Transport::shared_pointer thisSharedPtr = shared_from_this();
         _context->getTransportRegistry()->install(thisSharedPtr);
 
         start();
     }

void epics::pvAccess::detail::BlockingTCPTransportCodec::authNZMessage ( epics::pvData::PVStructure::shared_pointer const & data )

virtual

Pass data to the active security plug-in session.

Parameters

data	the data (any data), can be `null`.

Implements epics::pvAccess::Transport.

Definition at line 1388 of file codec.cpp.

                                                                                                {
     AuthenticationSession::shared_pointer sess;
     {
         Guard G(_mutex);
         sess = _authSession;
     }
     if (sess)
         sess->messageReceived(data);
     else
     {
         char ipAddrStr[24];
         ipAddrToDottedIP(&_socketAddress.ia, ipAddrStr, sizeof(ipAddrStr));
         LOG(logLevelWarn, "authNZ message received from '%s' but no security plug-in session active.", ipAddrStr);
     }
 }

virtual std::tr1::shared_ptr<const epics::pvData::Field> epics::pvAccess::detail::BlockingTCPTransportCodec::cachedDeserialize ( epics::pvData::ByteBuffer * buffer )

inlinevirtual

deserialize via cache

Parameters

buffer buffer to be deserialized from

Implements epics::pvData::DeserializableControl.

Definition at line 358 of file codec.h.

     {
         return _incomingIR.deserialize(buffer, this);
     }

virtual void epics::pvAccess::detail::BlockingTCPTransportCodec::cachedSerialize	(	const std::tr1::shared_ptr< const epics::pvData::Field > &	field,
		epics::pvData::ByteBuffer *	buffer
	)

inlinevirtual

Definition at line 364 of file codec.h.

     {
         _outgoingIR.serialize(field, buffer, this);
     }

void epics::pvAccess::detail::BlockingTCPTransportCodec::close ( )

virtual

Close transport.

Implements epics::pvAccess::Transport.

Definition at line 1033 of file codec.cpp.

                                       {
 
     if (_isOpen.getAndSet(false))
     {
         // always close in the same thread, same way, etc.
         // wakeup processSendQueue
 
         // clean resources (close socket)
         internalClose();
 
         // Break sender from queue wait
         BreakTransport::shared_pointer B(new BreakTransport);
         enqueueSendRequest(B);
     }
 }

virtual void epics::pvAccess::detail::BlockingTCPTransportCodec::flushSendQueue ( )

inlinevirtual

Flush send queue (sent messages).

Implements epics::pvAccess::Transport.

Definition at line 372 of file codec.h.

372 { }

virtual const osiSockAddr* epics::pvAccess::detail::BlockingTCPTransportCodec::getLastReadBufferSocketAddress ( )

inlinevirtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 302 of file codec.h.

                                                                                 {
         return &_socketAddress;
     }

virtual epics::pvData::int16 epics::pvAccess::detail::BlockingTCPTransportCodec::getPriority ( ) const

inlinevirtual

Transport priority.

Returns: protocol priority.

Implements epics::pvAccess::Transport.

Definition at line 340 of file codec.h.

                                                                 {
         return _priority;
     }

virtual std::size_t epics::pvAccess::detail::BlockingTCPTransportCodec::getReceiveBufferSize ( ) const

inlinevirtual

Get receive buffer size.

Returns: receive buffer size.

Implements epics::pvAccess::Transport.

Definition at line 335 of file codec.h.

                                                                   {
         return _socketBuffer.getSize();
     }

virtual const osiSockAddr& epics::pvAccess::detail::BlockingTCPTransportCodec::getRemoteAddress ( ) const

inlinevirtual

Implements epics::pvAccess::Transport.

Definition at line 326 of file codec.h.

                                                                        {
         return _socketAddress;
     }

virtual const std::string& epics::pvAccess::detail::BlockingTCPTransportCodec::getRemoteName ( ) const

inlinevirtual

Implements epics::pvAccess::Transport.

Definition at line 330 of file codec.h.

                                                                   {
         return _socketName;
     }

virtual std::string epics::pvAccess::detail::BlockingTCPTransportCodec::getType ( ) const

inlinevirtual

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

Returns: protocol type.

Implements epics::pvAccess::Transport.

Definition at line 307 of file codec.h.

                                                      {
         return std::string("tcp");
     }

void epics::pvAccess::detail::BlockingTCPTransportCodec::internalClose ( )

protectedvirtual

Called from close(). after start of shutdown (isOpen()==false) but before worker thread shutdown.

Reimplemented in epics::pvAccess::detail::BlockingClientTCPTransportCodec, and epics::pvAccess::detail::BlockingServerTCPTransportCodec.

Definition at line 1056 of file codec.cpp.

 {
     {
 
         epicsSocketSystemCallInterruptMechanismQueryInfo info  =
             epicsSocketSystemCallInterruptMechanismQuery ();
         switch ( info )
         {
         case esscimqi_socketCloseRequired:
             epicsSocketDestroy ( _channel );
             break;
         case esscimqi_socketBothShutdownRequired:
         {
             /*int status =*/ ::shutdown ( _channel, SHUT_RDWR );
             /*
             if ( status ) {
                 char sockErrBuf[64];
                 epicsSocketConvertErrnoToString (
                     sockErrBuf, sizeof ( sockErrBuf ) );
             LOG(logLevelDebug,
                 "TCP socket to %s failed to shutdown: %s.",
                 inetAddressToString(_socketAddress).c_str(), sockErrBuf);
             }
             */
             epicsSocketDestroy ( _channel );
         }
         break;
         case esscimqi_socketSigAlarmRequired:
         // not supported anymore anyway
         default:
             epicsSocketDestroy(_channel);
         }
     }
 
     Transport::shared_pointer thisSharedPtr = this->shared_from_this();
     _context->getTransportRegistry()->remove(thisSharedPtr);
 
     if (IS_LOGGABLE(logLevelDebug))
     {
         LOG(logLevelDebug,
             "TCP socket to %s is to be closed.",
             _socketName.c_str());
     }
 }

void epics::pvAccess::detail::BlockingTCPTransportCodec::invalidDataStreamHandler ( )

virtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 1274 of file codec.cpp.

                                                          {
     close();
 }

virtual bool epics::pvAccess::detail::BlockingTCPTransportCodec::isClosed ( )

inlinevirtual

Check connection status.

Returns: true if connected.

Implements epics::pvAccess::Transport.

Definition at line 375 of file codec.h.

                                            {
         return !isOpen();
     }

bool epics::pvAccess::detail::BlockingTCPTransportCodec::isOpen ( )

virtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 1106 of file codec.cpp.

                                        {
     return _isOpen.get();
 }

epics::pvAccess::detail::BlockingTCPTransportCodec::POINTER_DEFINITIONS ( BlockingTCPTransportCodec )

virtual void epics::pvAccess::detail::BlockingTCPTransportCodec::processApplicationMessage ( )

inlinevirtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 320 of file codec.h.

                                                             {
         _responseHandler->handleResponse(&_socketAddress, shared_from_this(),
                                          _version, _command, _payloadSize, &_socketBuffer);
     }

virtual void epics::pvAccess::detail::BlockingTCPTransportCodec::processControlMessage ( )

inlinevirtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 311 of file codec.h.

                                                         {
         if (_command == CMD_SET_ENDIANESS)
         {
             // check 7-th bit
             setByteOrder(_flags < 0 ? EPICS_ENDIAN_BIG : EPICS_ENDIAN_LITTLE);
         }
     }

int epics::pvAccess::detail::BlockingTCPTransportCodec::read ( epics::pvData::ByteBuffer * dst )

virtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 1316 of file codec.cpp.

                                                               {
 
     std::size_t remaining;
     while((remaining=dst->getRemaining()) > 0) {
 
         // read
         std::size_t pos = dst->getPosition();
 
         int bytesRead = ::recv(_channel,
                              (char*)(dst->getBuffer()+pos), remaining, 0);
 
         // NOTE: do not log here, you might override SOCKERRNO relevant to recv() operation above
 
         if(unlikely(bytesRead==0)) {
             return -1;    // 0 means connection loss for blocking transport, notify codec by returning -1
 
         } else if(unlikely(bytesRead<0)) {
             int err = SOCKERRNO;
 
             if(err==SOCK_EINTR) {
                 // interrupted by signal.  Retry
                 continue;
 
             } else if(err==SOCK_EWOULDBLOCK || err==EAGAIN || err==SOCK_EINPROGRESS
                       || err==SOCK_ETIMEDOUT
                       || err==SOCK_ECONNABORTED || err==SOCK_ECONNRESET
                       ) {
                 // different ways of saying timeout.
                 // Linux: EAGAIN or EWOULDBLOCK, or EINPROGRESS
                 // WIN32: WSAETIMEDOUT
                 // others that RSRV checks for, but may not need to, ECONNABORTED, ECONNRESET
 
                 // Note: with windows, after ETIMEOUT leaves the socket in an undefined state.
                 //       so it must be closed.  (cf. SO_RCVTIMEO)
 
                 return -1;
 
             } else {
                 // some other (fatal) error
                 if(_isOpen.get())
                     errlogPrintf("%s : Connection closed with RX socket error %d\n", _socketName.c_str(), err);
                 return -1;
             }
         }
 
         dst->setPosition(dst->getPosition() + bytesRead);
         return bytesRead;
     }
 
     return 0;
 }

void epics::pvAccess::detail::BlockingTCPTransportCodec::readPollOne ( )

virtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 1023 of file codec.cpp.

                                             {
     throw std::logic_error("should not be called for blocking IO");
 }

virtual void epics::pvAccess::detail::BlockingTCPTransportCodec::scheduleSend ( )

inlinevirtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 292 of file codec.h.

292 {}

void epics::pvAccess::detail::BlockingTCPTransportCodec::sendBufferFull ( int tries )

protectedvirtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 1211 of file codec.cpp.

                                                         {
     // TODO constants
     epicsThreadSleep(std::max<double>(tries * 0.1, 1));
 }

virtual void epics::pvAccess::detail::BlockingTCPTransportCodec::sendCompleted ( )

inlinevirtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 293 of file codec.h.

293 {}

void epics::pvAccess::detail::BlockingTCPTransportCodec::sendSecurityPluginMessage ( epics::pvData::PVStructure::const_shared_pointer const & data )

virtual

Send AUTHZ to peer with payload. caller gives up ownership of data, which must not be modified.

Implements epics::pvAccess::AuthenticationPluginControl.

Definition at line 1425 of file codec.cpp.

                                                                                                                  {
     SecurityPluginMessageTransportSender::shared_pointer spmts(new SecurityPluginMessageTransportSender(data));
     enqueueSendRequest(spmts);
 }

virtual void epics::pvAccess::detail::BlockingTCPTransportCodec::setRemoteTransportReceiveBufferSize ( std::size_t receiveBufferSize )

inlinevirtual

Set remote transport receive buffer size.

Parameters

receiveBufferSize receive buffer size.

Implements epics::pvAccess::Transport.

Definition at line 345 of file codec.h.

                                                                    {
         _remoteTransportReceiveBufferSize = remoteTransportReceiveBufferSize;
     }

virtual void epics::pvAccess::detail::BlockingTCPTransportCodec::setRemoteTransportSocketReceiveBufferSize ( std::size_t socketReceiveBufferSize )

inlinevirtual

Set remote transport socket receive buffer size.

Parameters

socketReceiveBufferSize remote socket receive buffer size.

Implements epics::pvAccess::Transport.

Definition at line 351 of file codec.h.

                                                           {
         _remoteTransportSocketReceiveBufferSize = socketReceiveBufferSize;
     }

void epics::pvAccess::detail::BlockingTCPTransportCodec::setRxTimeout ( bool ena )

protectedvirtual

Reimplemented from epics::pvAccess::detail::AbstractCodec.

Definition at line 1189 of file codec.cpp.

 {
     double timeout = !ena ? 0.0 : std::max(0.0, _context->getConfiguration()->getPropertyAsDouble("EPICS_PVA_CONN_TMO", 30.0));
 #ifdef _WIN32
     DWORD timo = DWORD(timeout*1000); // in milliseconds
 #else
     timeval timo;
     timo.tv_sec = unsigned(timeout);
     timo.tv_usec = (timeout-timo.tv_sec)*1e6;
 #endif
 
     int ret = setsockopt(_channel, SOL_SOCKET, SO_RCVTIMEO, (char*)&timo, sizeof(timo));
     if(ret==-1) {
         int err = SOCKERRNO;
         static int lasterr;
         if(err!=lasterr) {
             errlogPrintf("%s: Unable to set RX timeout: %d\n", _socketName.c_str(), err);
             lasterr = err;
         }
     }
 }

void epics::pvAccess::detail::BlockingTCPTransportCodec::start ( )

virtual

Reimplemented in epics::pvAccess::detail::BlockingClientTCPTransportCodec.

Definition at line 1112 of file codec.cpp.

                                       {
 
     _readThread.start();
 
     _sendThread.start();
 
 }

bool epics::pvAccess::detail::BlockingTCPTransportCodec::terminated ( )

virtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 1101 of file codec.cpp.

                                            {
     return !isOpen();
 }

void epics::pvAccess::detail::BlockingTCPTransportCodec::verified ( epics::pvData::Status const & status )

virtual

Notify transport that it is has been verified.

Parameters

status vefification status;

Implements epics::pvAccess::Transport.

Reimplemented in epics::pvAccess::detail::BlockingClientTCPTransportCodec, and epics::pvAccess::detail::BlockingServerTCPTransportCodec.

Definition at line 1373 of file codec.cpp.

                                                                          {
     epics::pvData::Lock lock(_mutex);
 
     if (IS_LOGGABLE(logLevelDebug) && !status.isOK())
     {
         LOG(logLevelDebug, "Failed to verify connection to %s: %s.", _socketName.c_str(), status.getMessage().c_str());
     }
 
     {
         Guard G(_mutex);
         _verified = status.isSuccess();
     }
     _verifiedEvent.signal();
 }

bool epics::pvAccess::detail::BlockingTCPTransportCodec::verify ( epics::pvData::int32 timeoutMs )

virtual

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

Parameters

timeoutMs timeout to wait for verification, infinite if 0.

Implements epics::pvAccess::Transport.

Reimplemented in epics::pvAccess::detail::BlockingServerTCPTransportCodec.

Definition at line 1369 of file codec.cpp.

                                                                  {
     return _verifiedEvent.wait(timeoutMs/1000.0) && _verified;
 }

void epics::pvAccess::detail::BlockingTCPTransportCodec::waitJoin ( )

virtual

Call after close() to wait for any worker threads to exit.

Reimplemented from epics::pvAccess::Transport.

Definition at line 1049 of file codec.cpp.

 {
     assert(!_isOpen.get());
     _sendThread.exitWait();
     _readThread.exitWait();
 }

int epics::pvAccess::detail::BlockingTCPTransportCodec::write ( epics::pvData::ByteBuffer * src )

virtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 1279 of file codec.cpp.

                                 {
 
     std::size_t remaining;
     while((remaining=src->getRemaining()) > 0) {
 
         int bytesSent = ::send(_channel,
                                &src->getBuffer()[src->getPosition()],
                                remaining, 0);
 
         // NOTE: do not log here, you might override SOCKERRNO relevant to recv() operation above
 
         // TODO winsock return 0 on disconnect (blocking socket) ?
 
         if(unlikely(bytesSent<0)) {
 
             int socketError = SOCKERRNO;
 
             // spurious EINTR check
             if (socketError==SOCK_EINTR)
                 continue;
             else if (socketError==SOCK_ENOBUFS)
                 return 0;
         }
 
         if (bytesSent > 0) {
             src->setPosition(src->getPosition() + bytesSent);
         }
 
         return bytesSent;
 
     }
 
     return 0;
 }

void epics::pvAccess::detail::BlockingTCPTransportCodec::writePollOne ( )

virtual

Implements epics::pvAccess::detail::AbstractCodec.

Definition at line 1028 of file codec.cpp.

                                              {
     throw std::logic_error("should not be called for blocking IO");
 }

Member Data Documentation

AuthenticationSession::shared_pointer epics::pvAccess::detail::BlockingTCPTransportCodec::_authSession

protected

Definition at line 425 of file codec.h.

std::string epics::pvAccess::detail::BlockingTCPTransportCodec::_authSessionName

protected

Definition at line 424 of file codec.h.

Context::shared_pointer epics::pvAccess::detail::BlockingTCPTransportCodec::_context

protected

Definition at line 418 of file codec.h.

IntrospectionRegistry epics::pvAccess::detail::BlockingTCPTransportCodec::_incomingIR

protected

Definition at line 420 of file codec.h.

IntrospectionRegistry epics::pvAccess::detail::BlockingTCPTransportCodec::_outgoingIR

protected

Definition at line 421 of file codec.h.

PeerInfo::const_shared_pointer epics::pvAccess::detail::BlockingTCPTransportCodec::_peerInfo

Definition at line 428 of file codec.h.

osiSockAddr epics::pvAccess::detail::BlockingTCPTransportCodec::_socketAddress

protected

Definition at line 415 of file codec.h.

std::string epics::pvAccess::detail::BlockingTCPTransportCodec::_socketName

protected

Definition at line 416 of file codec.h.

bool epics::pvAccess::detail::BlockingTCPTransportCodec::_verified

protected

Definition at line 437 of file codec.h.

epics::pvData::Event epics::pvAccess::detail::BlockingTCPTransportCodec::_verifiedEvent

protected

Definition at line 438 of file codec.h.

size_t epics::pvAccess::detail::BlockingTCPTransportCodec::num_instances

static

Definition at line 278 of file codec.h.

The documentation for this class was generated from the following files:

modules/pvAccess/src/remote/pv/codec.h
modules/pvAccess/src/remote/codec.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation