pvalink::pvaLinkChannel Struct Reference

#include "pvalink.h"

Inheritance diagram for pvalink::pvaLinkChannel:

Collaboration diagram for pvalink::pvaLinkChannel:

Classes
struct	LinkSort

Public Types
typedef std::set< pvaLink *, LinkSort >	links_t

Public Member Functions
	pvaLinkChannel (const pvaGlobal_t::channels_key_t &key, const epics::pvData::PVStructure::const_shared_pointer &pvRequest)
virtual	~pvaLinkChannel ()
void	open ()
void	put (bool force=false)
virtual void	monitorEvent (const pvac::MonitorEvent &evt) OVERRIDE FINAL
virtual void	putBuild (const epics::pvData::StructureConstPtr &build, pvac::ClientChannel::PutCallback::Args &args) OVERRIDE FINAL
virtual void	putDone (const pvac::PutEvent &evt) OVERRIDE FINAL
	Put operation is complete. More...
Public Member Functions inherited from pvac::ClientChannel::MonitorCallback
virtual	~MonitorCallback ()
Public Member Functions inherited from pvac::ClientChannel::PutCallback
virtual	~PutCallback ()

Public Attributes
const pvaGlobal_t::channels_key_t	key
const pvd::PVStructure::const_shared_pointer	pvRequest
pvd::Mutex	lock
epicsEvent	run_done
pvac::ClientChannel	chan
pvac::Monitor	op_mon
pvac::Operation	op_put
std::string	providerName
size_t	num_disconnect
size_t	num_type_change
bool	connected
bool	connected_latched
bool	isatomic
bool	queued
bool	debug
std::tr1::shared_ptr< const void >	previous_root
links_t	links
bool	links_changed

Static Public Attributes
static size_t	num_instances

Detailed Description

Definition at line 132 of file pvalink.h.

Member Typedef Documentation

typedef std::set<pvaLink*, LinkSort> pvalink::pvaLinkChannel::links_t

Definition at line 162 of file pvalink.h.

Constructor & Destructor Documentation

pvalink::pvaLinkChannel::pvaLinkChannel	(	const pvaGlobal_t::channels_key_t &	key,
		const epics::pvData::PVStructure::const_shared_pointer &	pvRequest
	)

Definition at line 39 of file pvalink_channel.cpp.

    :key(key)
    ,pvRequest(pvRequest)
    ,num_disconnect(0u)
    ,num_type_change(0u)
    ,connected(false)
    ,connected_latched(false)
    ,isatomic(false)
    ,queued(false)
    ,debug(false)
    ,links_changed(false)
{}

pvalink::pvaLinkChannel::~pvaLinkChannel ( )

virtual

Definition at line 52 of file pvalink_channel.cpp.

                                {
    {
        Guard G(pvaGlobal->lock);
        pvaGlobal->channels.erase(key);
    }

    Guard G(lock);

    assert(links.empty());
    REFTRACE_DECREMENT(num_instances);
}

Member Function Documentation

void pvalink::pvaLinkChannel::monitorEvent ( const pvac::MonitorEvent &  evt )

virtual

New monitor event

• MonitorEvent::Fail - An Error occurred. Check evt.message
• MonitorEvent::Cancel - Monitor::cancel() called
• MonitorEvent::Disconnect - Underlying ClientChannel becomes disconnected
• MonitorEvent::Data - FIFO becomes not empty.Call Monitor::poll()

Implements pvac::ClientChannel::MonitorCallback.

Definition at line 212 of file pvalink_channel.cpp.

{
    bool queue = false;

    {
        DEBUG(this, <<key.first<<" EVENT "<<evt.event);
        Guard G(lock);

        switch(evt.event) {
        case pvac::MonitorEvent::Disconnect:
        case pvac::MonitorEvent::Data:
            connected = evt.event == pvac::MonitorEvent::Data;
            queue = true;
            break;
        case pvac::MonitorEvent::Cancel:
            break; // no-op
        case pvac::MonitorEvent::Fail:
            connected = false;
            queue = true;
            errlogPrintf("%s: PVA link monitor ERROR: %s\n", chan.name().c_str(), evt.message.c_str());
            break;
        }

        if(queued)
            return; // already scheduled

        queued = queue;
    }

    if(queue) {
        pvaGlobal->queue.add(shared_from_this());
    }
}

void pvalink::pvaLinkChannel::open

(

)

Definition at line 64 of file pvalink_channel.cpp.

{
    Guard G(lock);

    try {
        chan = pvaGlobal->provider_local.connect(key.first);
        DEBUG(this, <<key.first<<" OPEN Local");
        providerName = pvaGlobal->provider_local.name();
    } catch(std::exception& e){
        // The PDBProvider doesn't have a way to communicate to us
        // whether this is an invalid record or group name,
        // or if this is some sort of internal error.
        // So we are forced to assume it is an invalid name.
        DEBUG(this, <<key.first<<" OPEN Not local "<<e.what());
    }
    if(!pvaLinkIsolate && !chan) {
        chan = pvaGlobal->provider_remote.connect(key.first);
        DEBUG(this, <<key.first<<" OPEN Remote ");
        providerName = pvaGlobal->provider_remote.name();
    }

    op_mon = chan.monitor(this, pvRequest);

    REFTRACE_INCREMENT(num_instances);
}

void pvalink::pvaLinkChannel::put

(

bool

force = false

)

Definition at line 103 of file pvalink_channel.cpp.

{
    pvd::PVStructurePtr pvReq(pvd::getPVDataCreate()->createPVStructure(putRequestType));
    pvReq->getSubFieldT<pvd::PVBoolean>("record._options.block")->put(false); // TODO: some way to expose completion...

    unsigned reqProcess = 0;
    bool doit = force;
    for(links_t::iterator it(links.begin()), end(links.end()); it!=end; ++it)
    {
        pvaLink *link = *it;

        if(!link->used_scratch) continue;

        pvd::shared_vector<const void> temp;
        temp.swap(link->put_scratch);
        link->used_scratch = false;
        temp.swap(link->put_queue);
        link->used_queue = true;

        doit = true;

        switch(link->pp) {
        case pvaLink::NPP:
            reqProcess |= 1;
            break;
        case pvaLink::Default:
            break;
        case pvaLink::PP:
        case pvaLink::CP:
        case pvaLink::CPP:
            reqProcess |= 2;
            break;
        }
    }

    /* By default, use remote default (passive).
     * Request processing, or not, if any link asks.
     * Prefer PP over NPP if both are specified.
     *
     * TODO: per field granularity?
     */
    const char *proc = "passive";
    if((reqProcess&2) || force) {
        proc = "true";
    } else if(reqProcess&1) {
        proc = "false";
    }
    pvReq->getSubFieldT<pvd::PVString>("record._options.process")->put(proc);

    DEBUG(this, <<key.first<<"Start put "<<doit);
    if(doit) {
        // start net Put, cancels in-progress put
        op_put = chan.put(this, pvReq);
    }
}

void pvalink::pvaLinkChannel::putBuild ( const epics::pvData::StructureConstPtr &  build, pvac::ClientChannel::PutCallback::Args &  args  )

virtual

Server provides expected structure.

Implementation must instanciate (or re-use) a PVStructure into args.root, then initialize any necessary fields and set bits in args.tosend as approprate.

If this method throws, then putDone() is called with PutEvent::Fail

Implements pvac::ClientChannel::PutCallback.

Definition at line 159 of file pvalink_channel.cpp.

{
    Guard G(lock);

    pvd::PVStructurePtr top(pvaGlobal->create->createPVStructure(build));

    for(links_t::iterator it(links.begin()), end(links.end()); it!=end; ++it)
    {
        pvaLink *link = *it;

        if(!link->used_queue) continue;
        link->used_queue = false; // clear early so unexpected exception won't get us in a retry loop

        pvd::PVFieldPtr value(link->fieldName.empty() ? pvd::PVFieldPtr(top) : top->getSubField(link->fieldName));
        if(value && value->getField()->getType()==pvd::structure) {
            // maybe drill into NTScalar et al.
            pvd::PVFieldPtr sub(static_cast<pvd::PVStructure*>(value.get())->getSubField("value"));
            if(sub)
                value.swap(sub);
        }

        if(!value) continue; // TODO: how to signal error?

        pvd::PVStringArray::const_svector choices; // TODO populate from op_mon

        DEBUG(this, <<key.first<<" <- "<<value->getFullName());
        copyDBF2PVD(link->put_queue, value, args.tosend, choices);

        link->put_queue.clear();
    }
    DEBUG(this, <<key.first<<" Put built");

    args.root = top;
}

void pvalink::pvaLinkChannel::putDone ( const pvac::PutEvent &  evt )

virtual

Put operation is complete.

Implements pvac::ClientChannel::PutCallback.

Definition at line 194 of file pvalink_channel.cpp.

{
    if(evt.event==pvac::PutEvent::Fail) {
        errlogPrintf("%s PVA link put ERROR: %s\n", key.first.c_str(), evt.message.c_str());
    }

    Guard G(lock);

    DEBUG(this, <<key.first<<" Put result "<<evt.event);

    op_put = pvac::Operation();

    if(evt.event==pvac::PutEvent::Success) {
        // see if we need start a queue'd put
        put();
    }
}

Member Data Documentation

pvac::ClientChannel pvalink::pvaLinkChannel::chan

Definition at line 145 of file pvalink.h.

bool pvalink::pvaLinkChannel::connected

Definition at line 151 of file pvalink.h.

bool pvalink::pvaLinkChannel::connected_latched

Definition at line 152 of file pvalink.h.

bool pvalink::pvaLinkChannel::debug

Definition at line 155 of file pvalink.h.

bool pvalink::pvaLinkChannel::isatomic

Definition at line 153 of file pvalink.h.

const pvaGlobal_t::channels_key_t pvalink::pvaLinkChannel::key

Definition at line 137 of file pvalink.h.

links_t pvalink::pvaLinkChannel::links

Definition at line 166 of file pvalink.h.

bool pvalink::pvaLinkChannel::links_changed

Definition at line 169 of file pvalink.h.

pvd::Mutex pvalink::pvaLinkChannel::lock

Definition at line 142 of file pvalink.h.

size_t pvalink::pvaLinkChannel::num_disconnect

Definition at line 150 of file pvalink.h.

size_t pvalink::pvaLinkChannel::num_instances

static

Definition at line 140 of file pvalink.h.

size_t pvalink::pvaLinkChannel::num_type_change

Definition at line 150 of file pvalink.h.

pvac::Monitor pvalink::pvaLinkChannel::op_mon

Definition at line 146 of file pvalink.h.

pvac::Operation pvalink::pvaLinkChannel::op_put

Definition at line 147 of file pvalink.h.

std::tr1::shared_ptr<const void> pvalink::pvaLinkChannel::previous_root

Definition at line 156 of file pvalink.h.

std::string pvalink::pvaLinkChannel::providerName

Definition at line 149 of file pvalink.h.

const pvd::PVStructure::const_shared_pointer pvalink::pvaLinkChannel::pvRequest

Definition at line 138 of file pvalink.h.

bool pvalink::pvaLinkChannel::queued

Definition at line 154 of file pvalink.h.

epicsEvent pvalink::pvaLinkChannel::run_done

Definition at line 143 of file pvalink.h.

---

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

• modules/pva2pva/pdbApp/pvalink.h
• modules/pva2pva/pdbApp/pvalink_channel.cpp