#include "responseHandlers.h"

Inheritance diagram for epics::pvAccess::ServerChannelFindRequesterImpl:

Collaboration diagram for epics::pvAccess::ServerChannelFindRequesterImpl:

Public Member Functions
	ServerChannelFindRequesterImpl (ServerContextImpl::shared_pointer const &context, const PeerInfo::const_shared_pointer &peer, epics::pvData::int32 expectedResponseCount)

virtual	~ServerChannelFindRequesterImpl ()

void	clear ()

ServerChannelFindRequesterImpl *	set (std::string _name, epics::pvData::int32 searchSequenceId, epics::pvData::int32 cid, osiSockAddr const &sendTo, bool responseRequired, bool serverSearch)

virtual void	channelFindResult (const epics::pvData::Status &status, ChannelFind::shared_pointer const &channelFind, bool wasFound) OVERRIDE FINAL

virtual std::tr1::shared_ptr< const PeerInfo >	getPeerInfo () OVERRIDE FINAL
	Return information on requesting peer if applicable. More...

virtual void	send (epics::pvData::ByteBuffer buffer, TransportSendControl control) OVERRIDE FINAL

virtual void	callback () OVERRIDE FINAL

virtual void	timerStopped () OVERRIDE FINAL

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

virtual	~ChannelFindRequester ()

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

	TransportSender ()

virtual	~TransportSender ()

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

virtual	~Lockable ()

virtual void	lock ()

virtual void	unlock ()

Public Member Functions inherited from epics::pvAccess::fair_queue< T >::entry
	entry ()

	~entry ()

Public Member Functions inherited from epics::pvData::TimerCallback
	POINTER_DEFINITIONS (TimerCallback)

	TimerCallback ()

virtual	~TimerCallback ()

Additional Inherited Members
Public Types inherited from epics::pvAccess::ChannelFindRequester
typedef ChannelFind	operation_type

Public Attributes inherited from epics::pvAccess::TransportSender
size_t	bytesTX

size_t	bytesRX

Detailed Description

Definition at line 134 of file responseHandlers.h.

Constructor & Destructor Documentation

epics::pvAccess::ServerChannelFindRequesterImpl::ServerChannelFindRequesterImpl	(	ServerContextImpl::shared_pointer const &	context,
		const PeerInfo::const_shared_pointer &	peer,
		epics::pvData::int32	expectedResponseCount
	)

Definition at line 384 of file responseHandlers.cpp.

                                      :
     _guid(context->getGUID()),
     _sendTo(),
     _wasFound(false),
     _context(context),
     _peer(peer),
     _expectedResponseCount(expectedResponseCount),
     _responseCount(0),
     _serverSearch(false)
 {}

virtual epics::pvAccess::ServerChannelFindRequesterImpl::~ServerChannelFindRequesterImpl ( )

inlinevirtual

Definition at line 144 of file responseHandlers.h.

144 {}

Member Function Documentation

void epics::pvAccess::ServerChannelFindRequesterImpl::callback ( )

virtual

The method that is called when a timer expires.

Implements epics::pvData::TimerCallback.

Definition at line 404 of file responseHandlers.cpp.

 {
     channelFindResult(Status::Ok, ChannelFind::shared_pointer(), false);
 }

void epics::pvAccess::ServerChannelFindRequesterImpl::channelFindResult	(	const epics::pvData::Status &	status,
		ChannelFind::shared_pointer const &	channelFind,
		bool	wasFound
	)

virtual

Parameters

status Completion status.

Implements epics::pvAccess::ChannelFindRequester.

Definition at line 427 of file responseHandlers.cpp.

 {
     // TODO status
     Lock guard(_mutex);
 
     _responseCount++;
     if (_responseCount > _expectedResponseCount)
     {
         if ((_responseCount+1) == _expectedResponseCount)
         {
             LOG(logLevelDebug,"[ServerChannelFindRequesterImpl::channelFindResult] More responses received than expected fpr channel '%s'!", _name.c_str());
         }
         return;
     }
 
     if (wasFound && _wasFound)
     {
         LOG(logLevelDebug,"[ServerChannelFindRequesterImpl::channelFindResult] Channel '%s' is hosted by different channel providers!", _name.c_str());
         return;
     }
 
     if (wasFound || (_responseRequired && (_responseCount == _expectedResponseCount)))
     {
         if (wasFound && _expectedResponseCount > 1)
         {
             Lock L(_context->_mutex);
             _context->s_channelNameToProvider[_name] = channelFind->getChannelProvider();
         }
         _wasFound = wasFound;
 
         BlockingUDPTransport::shared_pointer bt = _context->getBroadcastTransport();
         if (bt)
         {
             TransportSender::shared_pointer thisSender = shared_from_this();
             bt->enqueueSendRequest(thisSender);
         }
     }
 }

void epics::pvAccess::ServerChannelFindRequesterImpl::clear ( )

Definition at line 396 of file responseHandlers.cpp.

 {
     Lock guard(_mutex);
     _wasFound = false;
     _responseCount = 0;
     _serverSearch = false;
 }

std::tr1::shared_ptr< const PeerInfo > epics::pvAccess::ServerChannelFindRequesterImpl::getPeerInfo ( )

virtual

Return information on requesting peer if applicable.

A server-type ChannelProvider will use this method to discover if a remote client has provided credentials which may be used in access control decisions.

The returned PeerInfo is only required to have valid values for: peer, transport, and transportVersion. PeerInfo::authority may be empty if authentication has not yet occured (UDP search).

Default implementation returns NULL.

isConnected()==true and getPeerInfo()==NULL when the ChannelProvider does not provide information about the peer. This should be treated as an unauthenticated, anonymous, peer.

The returned instance must not change, and a different instance should be returned if/when peer information changes (eg. after reconnect).

May return !NULL when !isConnected(). getPeerInfo() must be called before testing isConnected() in situations where connection state is being polled.

Reimplemented from epics::pvAccess::ChannelFindRequester.

Definition at line 466 of file responseHandlers.cpp.

 {
     return _peer;
 }

void epics::pvAccess::ServerChannelFindRequesterImpl::send	(	epics::pvData::ByteBuffer *	buffer,
		TransportSendControl *	control
	)

virtual

Called by transport. By this call transport gives callee ownership over the buffer. Calls on TransportSendControl instance must be made from calling thread. Moreover, ownership is valid only for the time of call of this method. NOTE: these limitations allow efficient implementation.

Implements epics::pvAccess::TransportSender.

Definition at line 471 of file responseHandlers.cpp.

 {
     control->startMessage(CMD_SEARCH_RESPONSE, 12+4+16+2);
 
     Lock guard(_mutex);
     buffer->put(_guid.value, 0, sizeof(_guid.value));
     buffer->putInt(_searchSequenceId);
 
     // NOTE: is it possible (very likely) that address is any local address ::ffff:0.0.0.0
     encodeAsIPv6Address(buffer, _context->getServerInetAddress());
     buffer->putShort((int16)_context->getServerPort());
 
     SerializeHelper::serializeString(ServerSearchHandler::SUPPORTED_PROTOCOL, buffer, control);
 
     control->ensureBuffer(1);
     buffer->putByte(_wasFound ? (int8)1 : (int8)0);
 
     if (!_serverSearch)
     {
         // TODO for now we do not gather search responses
         buffer->putShort((int16)1);
         buffer->putInt(_cid);
     }
     else
     {
         buffer->putShort((int16)0);
     }
 
     control->setRecipient(_sendTo);
 }

ServerChannelFindRequesterImpl * epics::pvAccess::ServerChannelFindRequesterImpl::set	(	std::string	_name,
		epics::pvData::int32	searchSequenceId,
		epics::pvData::int32	cid,
		osiSockAddr const &	sendTo,
		bool	responseRequired,
		bool	serverSearch
	)

Definition at line 414 of file responseHandlers.cpp.

 {
     Lock guard(_mutex);
     _name = name;
     _searchSequenceId = searchSequenceId;
     _cid = cid;
     _sendTo = sendTo;
     _responseRequired = responseRequired;
     _serverSearch = serverSearch;
     return this;
 }

void epics::pvAccess::ServerChannelFindRequesterImpl::timerStopped ( )

virtual

The timer has stopped.

Implements epics::pvData::TimerCallback.

Definition at line 409 of file responseHandlers.cpp.

 {
     // noop
 }

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

modules/pvAccess/src/server/pv/responseHandlers.h
modules/pvAccess/src/server/responseHandlers.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation