#include "responseHandlers.h"

Inheritance diagram for epics::pvAccess::ServerChannelRequesterImpl:

Collaboration diagram for epics::pvAccess::ServerChannelRequesterImpl:

Public Types
typedef std::tr1::shared_ptr< ServerChannelRequesterImpl >	shared_pointer

typedef std::tr1::shared_ptr< const ServerChannelRequesterImpl >	const_shared_pointer

Public Types inherited from epics::pvAccess::ChannelRequester
typedef Channel	operation_type

Public Member Functions
virtual	~ServerChannelRequesterImpl ()

virtual void	channelCreated (const epics::pvData::Status &status, Channel::shared_pointer const &channel) OVERRIDE FINAL

virtual void	channelStateChange (Channel::shared_pointer const &c, const Channel::ConnectionState isConnected) OVERRIDE FINAL

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

virtual std::string	getRequesterName () OVERRIDE FINAL

virtual void	message (std::string const &message, epics::pvData::MessageType messageType) OVERRIDE FINAL

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

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

	ChannelRequester ()

virtual	~ChannelRequester ()

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

virtual	~Requester ()

virtual void	message (std::string const &message, MessageType messageType=errorMessage)

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 ()

Static Public Member Functions
static ChannelRequester::shared_pointer	create (ChannelProvider::shared_pointer const &provider, Transport::shared_pointer const &transport, const std::string channelName, const pvAccessID cid)

Protected Member Functions
	ServerChannelRequesterImpl (Transport::shared_pointer const &transport, const std::string channelName, const pvAccessID cid)

Friends
class	ServerCreateChannelHandler

Additional Inherited Members
Public Attributes inherited from epics::pvAccess::TransportSender
size_t	bytesTX

size_t	bytesRX

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

Detailed Description

Definition at line 199 of file responseHandlers.h.

Member Typedef Documentation

typedef std::tr1::shared_ptr<const ServerChannelRequesterImpl> epics::pvAccess::ServerChannelRequesterImpl::const_shared_pointer

Definition at line 207 of file responseHandlers.h.

typedef std::tr1::shared_ptr<ServerChannelRequesterImpl> epics::pvAccess::ServerChannelRequesterImpl::shared_pointer

Definition at line 206 of file responseHandlers.h.

Constructor & Destructor Documentation

epics::pvAccess::ServerChannelRequesterImpl::ServerChannelRequesterImpl	(	Transport::shared_pointer const &	transport,
		const std::string	channelName,
		const pvAccessID	cid
	)

protected

Definition at line 791 of file responseHandlers.cpp.

                                                         :
     _serverChannel(),
     _transport(std::tr1::static_pointer_cast<detail::BlockingServerTCPTransportCodec>(transport)),
     _channelName(channelName),
     _cid(cid),
     _created(false)
 {
 }

virtual epics::pvAccess::ServerChannelRequesterImpl::~ServerChannelRequesterImpl ( )

inlinevirtual

Definition at line 213 of file responseHandlers.h.

213 {}

Member Function Documentation

void epics::pvAccess::ServerChannelRequesterImpl::channelCreated	(	const epics::pvData::Status &	status,
		Channel::shared_pointer const &	channel
	)

virtual

The request made with ChannelProvider::createChannel() is satisfied.

Will be called at most once for each call to createChannel().

The Channel passed here must be the same as was returned by createChannel(), if it has returned. Note that this method may be called before createChanel() returns.

Status::isOk() indicates that the Channel is valid. Calls to Channel methods can be made from this method, and later until Channel::destroy() is called.

!Status::isOk() indicates that the Channel is not available. No calls to the Channel are permitted. channelStateChange() will never be called.

Caller must hold no locks.

Parameters

status	Completion status.
channel	The channel.

Implements epics::pvAccess::ChannelRequester.

Definition at line 813 of file responseHandlers.cpp.

 {
     if(_created)
         throw std::logic_error("Channel already created");
     if(detail::BlockingServerTCPTransportCodec::shared_pointer transport = _transport.lock())
     {
         ServerChannel::shared_pointer serverChannel;
         try
         {
             if (status.isSuccess())
             {
                 //
                 // create a new channel instance
                 //
                 pvAccessID sid = transport->preallocateChannelSID();
                 try
                 {
                     serverChannel.reset(new ServerChannel(channel, shared_from_this(), _cid, sid));
 
                     // ack allocation and register
                     transport->registerChannel(sid, serverChannel);
 
                 } catch (...)
                 {
                     // depreallocate and rethrow
                     transport->depreallocateChannelSID(sid);
                     throw;
                 }
             }
 
 
             {
                 Lock guard(_mutex);
                 _status = status;
                 _serverChannel = serverChannel;
                 _created = true;
             }
 
             TransportSender::shared_pointer thisSender = shared_from_this();
             transport->enqueueSendRequest(thisSender);
         }
         catch (std::exception& e)
         {
             LOG(logLevelDebug, "Exception caught when creating channel '%s': %s", _channelName.c_str(), e.what());
             {
                 Lock guard(_mutex);
                 _status = Status(Status::STATUSTYPE_FATAL, "failed to create channel", e.what());
             }
             TransportSender::shared_pointer thisSender = shared_from_this();
             transport->enqueueSendRequest(thisSender);
         }
         catch (...)
         {
             LOG(logLevelDebug, "Exception caught when creating channel: %s", _channelName.c_str());
             {
                 Lock guard(_mutex);
                 _status = Status(Status::STATUSTYPE_FATAL, "failed to create channel");
             }
             TransportSender::shared_pointer thisSender = shared_from_this();
             transport->enqueueSendRequest(thisSender);
         }
     }
 }

void epics::pvAccess::ServerChannelRequesterImpl::channelStateChange	(	Channel::shared_pointer const &	channel,
		const Channel::ConnectionState	connectionState
	)

virtual

Called occasionally after channelCreated() with Status::isOk() to give notification of connection state changes.

Caller must hold no locks.

Parameters

c	The channel.
connectionState	The new connection state.

Implements epics::pvAccess::ChannelRequester.

Definition at line 877 of file responseHandlers.cpp.

 {
     if(isConnected==Channel::CONNECTED || isConnected==Channel::NEVER_CONNECTED)
         return;
 
     if(detail::BlockingServerTCPTransportCodec::shared_pointer transport = _transport.lock())
     {
         ServerChannel::shared_pointer channel;
         {
             Lock guard(_mutex);
             _created = false;
             channel= dynamic_pointer_cast<ServerChannel>(_serverChannel.lock());
         }
 
         if (!channel)
             return;
 
         // destroy
         channel->destroy();
 
         // .. and unregister
         transport->unregisterChannel(channel->getSID());
 
         // send response back
         TransportSender::shared_pointer sr(new ServerDestroyChannelHandlerTransportSender(channel->getCID(), channel->getSID()));
         transport->enqueueSendRequest(sr);
     }
 }

ChannelRequester::shared_pointer epics::pvAccess::ServerChannelRequesterImpl::create	(	ChannelProvider::shared_pointer const &	provider,
		Transport::shared_pointer const &	transport,
		const std::string	channelName,
		const pvAccessID	cid
	)

static

Definition at line 801 of file responseHandlers.cpp.

 {
     // TODO use std::make_shared
     std::tr1::shared_ptr<ServerChannelRequesterImpl> tp(new ServerChannelRequesterImpl(transport, channelName, cid));
     ChannelRequester::shared_pointer cr = tp;
     // TODO exception guard and report error back
     provider->createChannel(channelName, cr, transport->getPriority());
     return cr;
 }

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

virtual

Return information on connected 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.

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::ChannelRequester.

Definition at line 906 of file responseHandlers.cpp.

 {
     if(detail::BlockingServerTCPTransportCodec::shared_pointer transport = _transport.lock()) {
         epicsGuard<epicsMutex> G(transport->_mutex);
         return transport->_peerInfo;
 
     } else {
         return std::tr1::shared_ptr<const PeerInfo>();
     }
 }

string epics::pvAccess::ServerChannelRequesterImpl::getRequesterName ( )

virtual

The requester must have a name.

Returns: The requester's name.

Implements epics::pvAccess::Requester.

Definition at line 917 of file responseHandlers.cpp.

 {
     detail::BlockingServerTCPTransportCodec::shared_pointer transport = _transport.lock();
     if (transport)
         return transport->getRemoteName();
     else
         return "<unknown>:0";
 }

void epics::pvAccess::ServerChannelRequesterImpl::message	(	std::string const &	message,
		epics::pvData::MessageType	messageType
	)

virtual

Definition at line 926 of file responseHandlers.cpp.

 {
     LOG(logLevelDebug, "[%s] %s", getMessageTypeName(messageType).c_str(), message.c_str());
 }

void epics::pvAccess::ServerChannelRequesterImpl::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 931 of file responseHandlers.cpp.

 {
     ServerChannel::shared_pointer serverChannel;
     Status status;
     {
         Lock guard(_mutex);
         serverChannel = _serverChannel.lock();
         status = _status;
     }
 
     if (detail::BlockingServerTCPTransportCodec::shared_pointer transport = _transport.lock())
     {
         // error response
         if (!serverChannel)
         {
             control->startMessage((int8)CMD_CREATE_CHANNEL, 2*sizeof(int32)/sizeof(int8));
             buffer->putInt(_cid);
             buffer->putInt(-1);
             // error status is expected or channel has been destroyed locally
             if (status.isSuccess())
                 status = Status(Status::STATUSTYPE_ERROR, "channel has been destroyed");
             status.serialize(buffer, control);
         }
         // OK
         else
         {
             ServerChannel::shared_pointer serverChannelImpl = dynamic_pointer_cast<ServerChannel>(serverChannel);
             control->startMessage((int8)CMD_CREATE_CHANNEL, 2*sizeof(int32)/sizeof(int8));
             buffer->putInt(serverChannelImpl->getCID());
             buffer->putInt(serverChannelImpl->getSID());
             status.serialize(buffer, control);
         }
     }
 }

Friends And Related Function Documentation

friend class ServerCreateChannelHandler

friend

Definition at line 204 of file responseHandlers.h.

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 Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation