pvas::detail::SharedPut Struct Reference

#include "sharedstateimpl.h"

Inheritance diagram for pvas::detail::SharedPut:

Collaboration diagram for pvas::detail::SharedPut:

Public Member Functions
	SharedPut (const std::tr1::shared_ptr< SharedChannel > &channel, const requester_type::shared_pointer &requester, const pvd::PVStructure::const_shared_pointer &pvRequest)
virtual	~SharedPut ()
virtual void	destroy () OVERRIDE FINAL
virtual std::tr1::shared_ptr< pva::Channel >	getChannel () OVERRIDE FINAL
virtual void	cancel () OVERRIDE FINAL
virtual void	lastRequest () OVERRIDE FINAL
virtual void	put (epics::pvData::PVStructure::shared_pointer const &pvPutStructure, epics::pvData::BitSet::shared_pointer const &putBitSet) OVERRIDE FINAL
virtual void	get () OVERRIDE FINAL
Public Member Functions inherited from epics::pvAccess::ChannelPut
	POINTER_DEFINITIONS (ChannelPut)
virtual	~ChannelPut ()
Public Member Functions inherited from epics::pvAccess::ChannelRequest
	POINTER_DEFINITIONS (ChannelRequest)
	ChannelRequest ()
virtual	~ChannelRequest ()
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)
Public Member Functions inherited from epics::pvAccess::Lockable
	POINTER_DEFINITIONS (Lockable)
virtual	~Lockable ()
virtual void	lock ()
virtual void	unlock ()

Public Attributes
const std::tr1::shared_ptr< SharedChannel >	channel
const requester_type::weak_pointer	requester
const pvd::PVStructure::const_shared_pointer	pvRequest
pvd::PVRequestMapper	mapper

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

Additional Inherited Members
Public Types inherited from epics::pvAccess::ChannelPut
typedef ChannelPutRequester	requester_type
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 76 of file sharedstateimpl.h.

Constructor & Destructor Documentation

pvas::detail::SharedPut::SharedPut	(	const std::tr1::shared_ptr< SharedChannel > &	channel,
		const requester_type::shared_pointer &	requester,
		const pvd::PVStructure::const_shared_pointer &	pvRequest
	)

Definition at line 80 of file sharedstate_put.cpp.

    :channel(channel)
    ,requester(requester)
    ,pvRequest(pvRequest)
{
    REFTRACE_INCREMENT(num_instances);
}

pvas::detail::SharedPut::~SharedPut ( )

virtual

Definition at line 90 of file sharedstate_put.cpp.

{
    Guard G(channel->owner->mutex);
    channel->owner->puts.remove(this);
    REFTRACE_DECREMENT(num_instances);
}

Member Function Documentation

void pvas::detail::SharedPut::cancel ( )

virtual

Cancel any pending request. Completion will be reported via request's response callback:

• if cancel() request is issued after the request was already complete, request success/failure completion will be reported and cancel() request ignored.
• if the request was actually canceled, cancellation completion is reported.

Implements epics::pvAccess::ChannelRequest.

Definition at line 104 of file sharedstate_put.cpp.

{}

void pvas::detail::SharedPut::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 97 of file sharedstate_put.cpp.

{}

void pvas::detail::SharedPut::get ( )

virtual

Get the current data.

Ownership transfer as with ChannelGet::get()

Implements epics::pvAccess::ChannelPut.

Definition at line 152 of file sharedstate_put.cpp.

{
    pvd::Status sts;
    pvd::PVStructurePtr current;
    pvd::BitSetPtr changed;
    {
        Guard G(channel->owner->mutex);

        if(channel->dead) {
            sts = pvd::Status::error("Dead Channel");

        } else if(channel->owner->current) {
            assert(!!mapper.requested());

            current = mapper.buildRequested();
            changed.reset(new pvd::BitSet);

            mapper.copyBaseToRequested(*channel->owner->current, channel->owner->valid,
                                       *current, *changed);
        }
    }

    requester_type::shared_pointer req(requester.lock());
    if(!req) return;

    if(!sts.isOK()) {
        // no-op
    } else if(!current) {
        sts = pvd::Status::error("Get not possible, cache disabled");
    }

    req->getDone(sts, shared_from_this(), current, changed);
}

std::tr1::shared_ptr< pva::Channel > pvas::detail::SharedPut::getChannel ( )

virtual

Get a channel instance this request belongs to.

Returns

the channel instance.

Implements epics::pvAccess::ChannelRequest.

Definition at line 99 of file sharedstate_put.cpp.

{
    return channel;
}

void pvas::detail::SharedPut::lastRequest ( )

virtual

Announce next request as last request. When last request will be completed (regardless of completion status) the remote and local instance will be destroyed.

Implements epics::pvAccess::ChannelRequest.

Definition at line 106 of file sharedstate_put.cpp.

{}

void pvas::detail::SharedPut::put ( epics::pvData::PVStructure::shared_pointer const &  pvPutStructure, epics::pvData::BitSet::shared_pointer const &  putBitSet  )

virtual

Put data to a channel.

Completion status is reported by calling ChannelPutRequester::putDone()

Ownership of the PVStructure is transfered to the ChannelPut until ChannelPutRequester::putDone() or ChannelPutRequester::channelDisconnect() is called.

Parameters

pvPutStructure	The PVStructure that holds the putData.
putBitSet	putPVStructure bit-set (selects what fields to put).

Implements epics::pvAccess::ChannelPut.

Definition at line 108 of file sharedstate_put.cpp.

{
    std::tr1::shared_ptr<SharedPV::Handler> handler;
    pvd::PVStructure::shared_pointer realval;
    pvd::BitSet changed;
    pvd::Status sts;
    {
        Guard G(channel->owner->mutex);

        if(channel->dead) {
            sts = pvd::Status::error("Dead Channel");

        } else if(pvPutStructure->getStructure()!=mapper.requested()) {
            requester_type::shared_pointer req(requester.lock());
            sts = pvd::Status::error("Type changed");

        } else {

            handler = channel->owner->handler;

            realval = mapper.buildBase();

            mapper.copyBaseFromRequested(*realval, changed, *pvPutStructure, *putBitSet);
        }
    }

    if(!sts.isOK()) {
        requester_type::shared_pointer req(requester.lock());
        if(req)
            req->putDone(sts, pva::ChannelPut::shared_pointer());

    } else {
        std::tr1::shared_ptr<PutOP> impl(new PutOP(shared_from_this(), pvRequest, realval, changed),
                                         Operation::Impl::Cleanup());

        if(handler) {
            Operation op(impl);
            handler->onPut(channel->owner, op);
        }
    }
}

Member Data Documentation

const std::tr1::shared_ptr<SharedChannel> pvas::detail::SharedPut::channel

Definition at line 79 of file sharedstateimpl.h.

pvd::PVRequestMapper pvas::detail::SharedPut::mapper

Definition at line 84 of file sharedstateimpl.h.

size_t pvas::detail::SharedPut::num_instances

static

Definition at line 86 of file sharedstateimpl.h.

const pvd::PVStructure::const_shared_pointer pvas::detail::SharedPut::pvRequest

Definition at line 81 of file sharedstateimpl.h.

const requester_type::weak_pointer pvas::detail::SharedPut::requester

Definition at line 80 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_put.cpp