PDBSinglePut Struct Reference

#include "pdbsingle.h"

Inheritance diagram for PDBSinglePut:

Collaboration diagram for PDBSinglePut:

Public Types
typedef epics::pvAccess::ChannelPutRequester	requester_t
Public Types inherited from epics::pvAccess::ChannelPut
typedef ChannelPutRequester	requester_type

Public Member Functions
	POINTER_DEFINITIONS (PDBSinglePut)
	PDBSinglePut (const PDBSingleChannel::shared_pointer &channel, const epics::pvAccess::ChannelPutRequester::shared_pointer &requester, const epics::pvData::PVStructure::shared_pointer &pvReq)
virtual	~PDBSinglePut ()
virtual void	destroy () OVERRIDE FINAL
virtual std::tr1::shared_ptr< epics::pvAccess::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
PDBSingleChannel::shared_pointer	channel
requester_t::weak_pointer	requester
epics::pvData::BitSetPtr	changed
epics::pvData::BitSetPtr	wait_changed
epics::pvData::PVStructurePtr	pvf
p2p::auto_ptr< PVIF >	pvif
p2p::auto_ptr< PVIF >	wait_pvif
processNotify	notify
int	notifyBusy
PVIF::proc_t	doProc
bool	doWait

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

Additional Inherited Members
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 102 of file pdbsingle.h.

Member Typedef Documentation

typedef epics::pvAccess::ChannelPutRequester PDBSinglePut::requester_t

Definition at line 107 of file pdbsingle.h.

Constructor & Destructor Documentation

PDBSinglePut::PDBSinglePut	(	const PDBSingleChannel::shared_pointer &	channel,
		const epics::pvAccess::ChannelPutRequester::shared_pointer &	requester,
		const epics::pvData::PVStructure::shared_pointer &	pvReq
	)

Definition at line 299 of file pdbsingle.cpp.

    :channel(channel)
    ,requester(requester)
    ,changed(new pvd::BitSet(channel->fielddesc->getNumberFields()))
    ,pvf(pvd::getPVDataCreate()->createPVStructure(channel->fielddesc))
    ,pvif(channel->pv->builder->attach(channel->pv->chan, pvf, FieldName()))
    ,notifyBusy(0)
    ,doProc(PVIF::ProcPassive)
    ,doWait(false)
{
    epics::atomic::increment(num_instances);
    dbChannel *chan = channel->pv->chan;

    try {
        getS<pvd::boolean>(pvReq, "record._options.block", doWait);
    } catch(std::runtime_error& e) {
        requester->message(std::string("block= not understood : ")+e.what(), pva::warningMessage);
    }

    std::string proccmd;
    if(getS<std::string>(pvReq, "record._options.process", proccmd)) {
        if(proccmd=="true") {
            doProc = PVIF::ProcForce;
        } else if(proccmd=="false") {
            doProc = PVIF::ProcInhibit;
            doWait = false; // no point in waiting
        } else if(proccmd=="passive") {
            doProc = PVIF::ProcPassive;
        } else {
            requester->message("process= expects: true|false|passive", pva::warningMessage);
        }
    }

    memset((void*)&notify, 0, sizeof(notify));
    notify.usrPvt = (void*)this;
    notify.chan = chan;
    notify.putCallback = &single_put_callback;
    notify.doneCallback = &single_done_callback;
}

PDBSinglePut::~PDBSinglePut ( )

virtual

Definition at line 341 of file pdbsingle.cpp.

{
    cancel();
    epics::atomic::decrement(num_instances);
}

Member Function Documentation

void PDBSinglePut::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 409 of file pdbsingle.cpp.

{
    if(epics::atomic::compareAndSwap(notifyBusy, 1, 2)==1) {
        dbNotifyCancel(&notify);
        wait_changed.reset();
        wait_pvif.reset();
        epics::atomic::set(notifyBusy, 0);
    }
}

virtual void PDBSinglePut::destroy ( )

inlinevirtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 128 of file pdbsingle.h.

{ pvif.reset(); channel.reset(); requester.reset(); }

void PDBSinglePut::get ( )

virtual

Get the current data.

Ownership transfer as with ChannelGet::get()

Implements epics::pvAccess::ChannelPut.

Definition at line 419 of file pdbsingle.cpp.

{
    changed->clear();
    {
        DBScanLocker L(pvif->chan);
        pvif->put(*changed, DBE_VALUE|DBE_ALARM|DBE_PROPERTY, NULL);
    }
    //TODO: report unused fields as changed?
    changed->clear();
    changed->set(0);

    requester_type::shared_pointer req(requester.lock());
    if(req)
        req->getDone(pvd::Status(), shared_from_this(), pvf, changed);
}

virtual std::tr1::shared_ptr<epics::pvAccess::Channel> PDBSinglePut::getChannel ( )

inlinevirtual

Get a channel instance this request belongs to.

Returns

the channel instance.

Implements epics::pvAccess::ChannelRequest.

Definition at line 129 of file pdbsingle.h.

{ return channel; }

virtual void PDBSinglePut::lastRequest ( )

inlinevirtual

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 131 of file pdbsingle.h.

{}

PDBSinglePut::POINTER_DEFINITIONS

(

PDBSinglePut

)

void PDBSinglePut::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 347 of file pdbsingle.cpp.

{
    dbChannel *chan = channel->pv->chan;
    dbFldDes *fld = dbChannelFldDes(chan);

    pvd::Status ret;
    if(!channel->aspvt.canWrite()) {
        ret = pvd::Status::error("Put not permitted");

    } else if(dbChannelFieldType(chan)>=DBF_INLINK && dbChannelFieldType(chan)<=DBF_FWDLINK) {
        try{
            std::string lval(value->getSubFieldT<pvd::PVScalar>("value")->getAs<std::string>());
            long status = dbChannelPutField(chan, DBF_STRING, lval.c_str(), 1);
            if(status)
                ret = pvd::Status(pvd::Status::error("dbPutField() error"));
        }catch(std::exception& e) {
            std::ostringstream strm;
            strm<<"Failed to put link field "<<dbChannelName(chan)<<"."<<fld->name<<" : "<<e.what()<<"\n";
            ret = pvd::Status(pvd::Status::error(strm.str()));
        }

    } else if(doWait) {
        // TODO: dbNotify doesn't allow us for force processing

        // assume value may be a different struct each time
        p2p::auto_ptr<PVIF> putpvif(channel->pv->builder->attach(channel->pv->chan, value, FieldName()));
        unsigned mask = putpvif->dbe(*changed);

        if(mask!=DBE_VALUE) {
            requester_type::shared_pointer req(requester.lock());
            if(req)
                req->message("block=true only supports .value (empty put mask)", pva::warningMessage);
        }

        if(epics::atomic::compareAndSwap(notifyBusy, 0, 1)!=0)
            throw std::logic_error("Previous put() not complete");

        notify.requestType = (mask&DBE_VALUE) ? putProcessRequest : processRequest;

        wait_pvif = PTRMOVE(putpvif);
        wait_changed = changed;

        dbProcessNotify(&notify);

        return; // skip notification
    } else {
        // assume value may be a different struct each time
        p2p::auto_ptr<PVIF> putpvif(channel->pv->builder->attach(channel->pv->chan, value, FieldName()));
        try{
            DBScanLocker L(chan);
            putpvif->get(*changed, doProc);

        }catch(std::runtime_error& e){
            ret = pvd::Status::error(e.what());
        }
    }
    requester_type::shared_pointer req(requester.lock());
    if(req)
        req->putDone(ret, shared_from_this());
}

Member Data Documentation

epics::pvData::BitSetPtr PDBSinglePut::changed

Definition at line 111 of file pdbsingle.h.

PDBSingleChannel::shared_pointer PDBSinglePut::channel

Definition at line 108 of file pdbsingle.h.

PVIF::proc_t PDBSinglePut::doProc

Definition at line 118 of file pdbsingle.h.

bool PDBSinglePut::doWait

Definition at line 119 of file pdbsingle.h.

processNotify PDBSinglePut::notify

Definition at line 114 of file pdbsingle.h.

int PDBSinglePut::notifyBusy

Definition at line 115 of file pdbsingle.h.

size_t PDBSinglePut::num_instances

static

Definition at line 121 of file pdbsingle.h.

epics::pvData::PVStructurePtr PDBSinglePut::pvf

Definition at line 112 of file pdbsingle.h.

p2p::auto_ptr<PVIF> PDBSinglePut::pvif

Definition at line 113 of file pdbsingle.h.

requester_t::weak_pointer PDBSinglePut::requester

Definition at line 109 of file pdbsingle.h.

epics::pvData::BitSetPtr PDBSinglePut::wait_changed

Definition at line 111 of file pdbsingle.h.

p2p::auto_ptr<PVIF> PDBSinglePut::wait_pvif

Definition at line 113 of file pdbsingle.h.

---

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

• modules/pva2pva/pdbApp/pdbsingle.h
• modules/pva2pva/pdbApp/pdbsingle.cpp