pvas::detail::SharedChannel Struct Reference

#include "sharedstateimpl.h"

Inheritance diagram for pvas::detail::SharedChannel:

Collaboration diagram for pvas::detail::SharedChannel:

Public Member Functions
	SharedChannel (const std::tr1::shared_ptr< SharedPV > &owner, const pva::ChannelProvider::shared_pointer provider, const std::string &channelName, const requester_type::shared_pointer &requester)
virtual	~SharedChannel ()
virtual void	destroy () OVERRIDE FINAL
virtual std::tr1::shared_ptr< pva::ChannelProvider >	getProvider () OVERRIDE FINAL
virtual std::string	getRemoteAddress () OVERRIDE FINAL
virtual std::string	getChannelName () OVERRIDE FINAL
virtual std::tr1::shared_ptr< pva::ChannelRequester >	getChannelRequester () OVERRIDE FINAL
virtual void	getField (pva::GetFieldRequester::shared_pointer const &requester, std::string const &subField) OVERRIDE FINAL
virtual pva::ChannelPut::shared_pointer	createChannelPut (pva::ChannelPutRequester::shared_pointer const &requester, pvd::PVStructure::shared_pointer const &pvRequest) OVERRIDE FINAL
virtual pva::ChannelRPC::shared_pointer	createChannelRPC (pva::ChannelRPCRequester::shared_pointer const &requester, pvd::PVStructure::shared_pointer const &pvRequest) OVERRIDE FINAL
virtual pva::Monitor::shared_pointer	createMonitor (pva::MonitorRequester::shared_pointer const &requester, pvd::PVStructure::shared_pointer const &pvRequest) OVERRIDE FINAL
Public Member Functions inherited from epics::pvAccess::Channel
	POINTER_DEFINITIONS (Channel)
	Channel ()
virtual	~Channel ()
virtual std::string	getRequesterName ()
virtual void	message (std::string const &message, epics::pvData::MessageType messageType)
virtual ConnectionState	getConnectionState ()
virtual bool	isConnected ()
virtual void	getField (GetFieldRequester::shared_pointer const &requester, std::string const &subField)
virtual AccessRights	getAccessRights (epics::pvData::PVField::shared_pointer const &pvField)
virtual ChannelProcess::shared_pointer	createChannelProcess (ChannelProcessRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelGet::shared_pointer	createChannelGet (ChannelGetRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelPut::shared_pointer	createChannelPut (ChannelPutRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelPutGet::shared_pointer	createChannelPutGet (ChannelPutGetRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelRPC::shared_pointer	createChannelRPC (ChannelRPCRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual Monitor::shared_pointer	createMonitor (MonitorRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelArray::shared_pointer	createChannelArray (ChannelArrayRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual void	printInfo ()
virtual void	printInfo (std::ostream &out)
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::Destroyable
	POINTER_DEFINITIONS (Destroyable)

Public Attributes
const std::tr1::shared_ptr< SharedPV >	owner
const std::string	channelName
const requester_type::weak_pointer	requester
const pva::ChannelProvider::weak_pointer	provider
bool	dead

Static Public Attributes
static size_t	num_instances
Static Public Attributes inherited from epics::pvAccess::Channel
static size_t	num_instances
static const char *	ConnectionStateNames [] = { "NEVER_CONNECTED", "CONNECTED", "DISCONNECTED", "DESTROYED" }

Additional Inherited Members
Public Types inherited from epics::pvAccess::Channel
enum	ConnectionState { NEVER_CONNECTED, CONNECTED, DISCONNECTED, DESTROYED }
typedef ChannelRequester	requester_type
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 26 of file sharedstateimpl.h.

Constructor & Destructor Documentation

pvas::detail::SharedChannel::SharedChannel	(	const std::tr1::shared_ptr< SharedPV > &	owner,
		const pva::ChannelProvider::shared_pointer	provider,
		const std::string &	channelName,
		const requester_type::shared_pointer &	requester
	)

Definition at line 31 of file sharedstate_channel.cpp.

    :owner(owner)
    ,channelName(channelName)
    ,requester(requester)
    ,provider(provider)
    ,dead(false)
{
    REFTRACE_INCREMENT(num_instances);

    if(owner->debugLvl>5) {
        errlogPrintf("%s : Open channel to %s > %p\n",
                     requester->getRequesterName().c_str(),
                     channelName.c_str(),
                     this);
    }

    {
        Guard G(owner->mutex);
        owner->channels.push_back(this);
    }
}

pvas::detail::SharedChannel::~SharedChannel ( )

virtual

Definition at line 56 of file sharedstate_channel.cpp.

{
    destroy();
    REFTRACE_DECREMENT(num_instances);
}

Member Function Documentation

pva::ChannelPut::shared_pointer pvas::detail::SharedChannel::createChannelPut ( pva::ChannelPutRequester::shared_pointer const &  requester, pvd::PVStructure::shared_pointer const &  pvRequest  )

virtual

Definition at line 141 of file sharedstate_channel.cpp.

{
    std::tr1::shared_ptr<SharedPut> ret(new SharedPut(shared_from_this(), requester, pvRequest));

    pvd::StructureConstPtr type;
    pvd::Status sts;
    std::string warning;
    SharedPV::Handler::shared_pointer handler;
    try {
        {
            Guard G(owner->mutex);
            if(dead) {
                sts = pvd::Status::error("Dead Channel");

            } else {
                // ~SharedPut removes
                owner->puts.push_back(ret.get());
                if(owner->current) {
                    ret->mapper.compute(*owner->current, *pvRequest, owner->config.mapperMode);
                    type = ret->mapper.requested();
                    warning = ret->mapper.warnings();
                }

                if(!owner->channels.empty() && !owner->notifiedConn) {
                    handler = owner->handler;
                    owner->notifiedConn = true;
                }
            }
        }
        if(!warning.empty())
            requester->message(warning, pvd::warningMessage);
        if(type || !sts.isOK())
            requester->channelPutConnect(sts, ret, type);
    }catch(std::runtime_error& e){
        ret.reset();
        type.reset();
        requester->channelPutConnect(pvd::Status::error(e.what()), ret, type);
    }
    if(handler) {
        handler->onFirstConnect(owner);
    }
    return ret;
}

pva::ChannelRPC::shared_pointer pvas::detail::SharedChannel::createChannelRPC ( pva::ChannelRPCRequester::shared_pointer const &  requester, pvd::PVStructure::shared_pointer const &  pvRequest  )

virtual

Definition at line 187 of file sharedstate_channel.cpp.

{
    std::tr1::shared_ptr<SharedRPC> ret(new SharedRPC(shared_from_this(), requester, pvRequest));
    ret->connected = true;

    pvd::Status sts;
    {
        Guard G(owner->mutex);
        if(dead) {
            sts = pvd::Status::error("Dead Channel");

        } else {
            owner->rpcs.push_back(ret.get());
        }
    }
    requester->channelRPCConnect(sts, ret);
    return ret;
}

pva::Monitor::shared_pointer pvas::detail::SharedChannel::createMonitor ( pva::MonitorRequester::shared_pointer const &  requester, pvd::PVStructure::shared_pointer const &  pvRequest  )

virtual

Definition at line 208 of file sharedstate_channel.cpp.

{
    SharedMonitorFIFO::Config mconf;
    SharedPV::Handler::shared_pointer handler;
    mconf.dropEmptyUpdates = owner->config.dropEmptyUpdates;
    mconf.mapperMode = owner->config.mapperMode;

    std::tr1::shared_ptr<SharedMonitorFIFO> ret(new SharedMonitorFIFO(shared_from_this(), requester, pvRequest, &mconf));

    bool notify;
    pvd::Status sts;
    {
        Guard G(owner->mutex);
        if(dead) {
            sts = pvd::Status::error("Dead Channel");
            notify = false;

        } else {
            owner->monitors.push_back(ret.get());
            notify = !!owner->type;
            if(notify) {
                ret->open(owner->type);
                // post initial update
                ret->post(*owner->current, owner->valid);
            }

            if(!owner->channels.empty() && !owner->notifiedConn) {
                handler = owner->handler;
                owner->notifiedConn = true;
            }
        }
    }
    if(!sts.isOK()) {
        requester->monitorConnect(sts, pvd::MonitorPtr(), pvd::StructureConstPtr());
        ret.reset();

    } else {
        if(notify) {
            ret->notify();
        }
        if(handler) {
            handler->onFirstConnect(owner);
        }
    }
    return ret;
}

void pvas::detail::SharedChannel::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 62 of file sharedstate_channel.cpp.

{
    std::tr1::shared_ptr<SharedPV::Handler> handler;
    {
        Guard G(owner->mutex);

        if(dead) return;
        dead = true;

        bool wasempty = owner->channels.empty();
        owner->channels.remove(this);
        if(!wasempty && owner->channels.empty() && owner->notifiedConn) {
            handler = owner->handler;
            owner->notifiedConn = false;
        }
    }
    if(handler) {
        handler->onLastDisconnect(owner);
    }
    if(owner->debugLvl>5)
    {
        pva::ChannelRequester::shared_pointer req(requester.lock());
        errlogPrintf("%s : Close channel to %s > %p\n",
                     req ? req->getRequesterName().c_str() : "<Defunct>",
                     channelName.c_str(),
                     this);
    }
}

std::string pvas::detail::SharedChannel::getChannelName ( )

virtual

The name passed to ChannelProvider::createChannel()

Implements epics::pvAccess::Channel.

Definition at line 101 of file sharedstate_channel.cpp.

{
    return channelName;
}

std::tr1::shared_ptr< pva::ChannelRequester > pvas::detail::SharedChannel::getChannelRequester ( )

virtual

The ChannelRequester passed to ChannelProvider::createChannel()

Exceptions

std::tr1::bad_weak_ptr

Implements epics::pvAccess::Channel.

Definition at line 106 of file sharedstate_channel.cpp.

{
    return requester.lock();
}

void pvas::detail::SharedChannel::getField ( pva::GetFieldRequester::shared_pointer const &  requester, std::string const &  subField  )

virtual

Definition at line 111 of file sharedstate_channel.cpp.

{
    pvd::FieldConstPtr desc;
    pvd::Status sts;
    SharedPV::Handler::shared_pointer handler;
    {
        Guard G(owner->mutex);
        if(dead) {
            sts = pvd::Status::error("Dead Channel");

        } else {
            if(owner->type) {
                desc = owner->type;
            }

            if(!owner->channels.empty() && !owner->notifiedConn) {
                handler = owner->handler;
                owner->notifiedConn = true;
            }
            owner->getfields.push_back(requester);
        }
    }
    if(desc || !sts.isOK()) {
        requester->getDone(sts, desc);
    }
    if(handler) {
        handler->onFirstConnect(owner);
    }
}

std::tr1::shared_ptr< pva::ChannelProvider > pvas::detail::SharedChannel::getProvider ( )

virtual

The ChannelProvider from which this Channel was requested. May never be NULL.

Implements epics::pvAccess::Channel.

Definition at line 91 of file sharedstate_channel.cpp.

{
    return provider.lock();
}

std::string pvas::detail::SharedChannel::getRemoteAddress ( )

virtual

Returns the channel's remote address, signal name, etc... For example:

• client side channel would return server's address, e.g. "/192.168.1.101:5064"
• server side channel would return underlying bus address, e.g. "#C0 S1".

The value returned here will changed depending on the connection status. A disconnected channel should return an empty() string.

Implements epics::pvAccess::Channel.

Definition at line 96 of file sharedstate_channel.cpp.

{
    return getChannelName(); // for lack of anything better to do...
}

Member Data Documentation

const std::string pvas::detail::SharedChannel::channelName

Definition at line 32 of file sharedstateimpl.h.

bool pvas::detail::SharedChannel::dead

Definition at line 36 of file sharedstateimpl.h.

size_t pvas::detail::SharedChannel::num_instances

static

Definition at line 29 of file sharedstateimpl.h.

const std::tr1::shared_ptr<SharedPV> pvas::detail::SharedChannel::owner

Definition at line 31 of file sharedstateimpl.h.

const pva::ChannelProvider::weak_pointer pvas::detail::SharedChannel::provider

Definition at line 34 of file sharedstateimpl.h.

const requester_type::weak_pointer pvas::detail::SharedChannel::requester

Definition at line 33 of file sharedstateimpl.h.

---

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

• modules/pvAccess/src/server/sharedstateimpl.h
• modules/pvAccess/src/server/sharedstate_channel.cpp