chancache.h

Go to the documentation of this file.

#ifndef CHANCACHE_H
#define CHANCACHE_H

#include <string>
#include <map>
#include <set>
#include <deque>

#include <epicsMutex.h>
#include <epicsTimer.h>

#include <pv/pvAccess.h>

#include "weakmap.h"
#include "weakset.h"

#include <shareLib.h>

struct ChannelCache;
struct ChannelCacheEntry;
struct MonitorUser;
struct GWChannel;

struct MonitorCacheEntry : public epics::pvData::MonitorRequester
{
    POINTER_DEFINITIONS(MonitorCacheEntry);
    static size_t num_instances;
    weak_pointer weakref;

    ChannelCacheEntry * const chan;

    const size_t bufferSize; // DS requested buffer size

    // to avoid yet another mutex borrow interested.mutex() for our members
    inline epicsMutex& mutex() const { return interested.mutex(); }

    typedef std::vector<epicsUInt8> pvrequest_t;

    bool havedata; // set when initial update is received
    bool done;     // set when unlisten() is received
    size_t nwakeups; // # of upstream monitorEvent() calls
    size_t nevents;  // # of upstream events poll()'d

    epics::pvData::StructureConstPtr typedesc;
    epics::pvData::MonitorElement::shared_pointer lastelem;
    epics::pvData::MonitorPtr mon;
    epics::pvData::Status startresult;

    typedef weak_set<MonitorUser> interested_t;
    interested_t interested;

    MonitorCacheEntry(ChannelCacheEntry *ent, const epics::pvData::PVStructure::shared_pointer& pvr);
    virtual ~MonitorCacheEntry();

    virtual void monitorConnect(epics::pvData::Status const & status,
                                epics::pvData::MonitorPtr const & monitor,
                                epics::pvData::StructureConstPtr const & structure);
    virtual void monitorEvent(epics::pvData::MonitorPtr const & monitor);
    virtual void unlisten(epics::pvData::MonitorPtr const & monitor);

    virtual std::string getRequesterName();
};

struct MonitorUser : public epics::pvData::Monitor
{
    POINTER_DEFINITIONS(MonitorUser);
    static size_t num_instances;
    weak_pointer weakref;

    inline epicsMutex& mutex() const { return entry->mutex(); }

    MonitorCacheEntry::shared_pointer entry;
    epics::pvData::MonitorRequester::weak_pointer req;
    std::tr1::weak_ptr<GWChannel> srvchan;

    // guards queues and member variables
    bool initial;
    bool running;
    bool inoverflow;
    size_t nwakeups; // # of monitorEvent() calls to req
    size_t nevents;  // total # events queued
    size_t ndropped; // # of events drop because our queue was full

    std::deque<epics::pvData::MonitorElementPtr> filled, empty;
    std::set<epics::pvData::MonitorElementPtr> inuse;

    epics::pvData::MonitorElementPtr overflowElement;

    MonitorUser(const MonitorCacheEntry::shared_pointer&);
    virtual ~MonitorUser();

    virtual void destroy();

    virtual epics::pvData::Status start();
    virtual epics::pvData::Status stop();
    virtual epics::pvData::MonitorElementPtr poll();
    virtual void release(epics::pvData::MonitorElementPtr const & monitorElement);

    virtual std::string getRequesterName();
};

struct ChannelCacheEntry
{
    POINTER_DEFINITIONS(ChannelCacheEntry);
    static size_t num_instances;

    const std::string channelName;
    ChannelCache * const cache;

    // to avoid yet another mutex borrow interested.mutex() for our members
    inline epicsMutex& mutex() const { return interested.mutex(); }

    // clientChannel
    epics::pvAccess::Channel::shared_pointer channel;
    epics::pvAccess::ChannelRequester::shared_pointer requester;

    bool dropPoke;

    typedef weak_set<GWChannel> interested_t;
    interested_t interested;

    typedef MonitorCacheEntry::pvrequest_t pvrequest_t;
    typedef weak_value_map<pvrequest_t, MonitorCacheEntry> mon_entries_t;
    mon_entries_t mon_entries;

    ChannelCacheEntry(ChannelCache*, const std::string& n);
    virtual ~ChannelCacheEntry();

    // this exists as a seperate object to prevent a reference loop
    // ChannelCacheEntry -> pva::Channel -> CRequester
    struct CRequester : public epics::pvAccess::ChannelRequester
    {
        static size_t num_instances;

        CRequester(const ChannelCacheEntry::shared_pointer& p);
        virtual ~CRequester();
        ChannelCacheEntry::weak_pointer chan;
        // for Requester
        virtual std::string getRequesterName();
        // for ChannelRequester
        virtual void channelCreated(const epics::pvData::Status& status,
                                    epics::pvAccess::Channel::shared_pointer const & channel);
        virtual void channelStateChange(epics::pvAccess::Channel::shared_pointer const & channel,
                                        epics::pvAccess::Channel::ConnectionState connectionState);
    };
};

struct ChannelCache
{
    typedef std::map<std::string, ChannelCacheEntry::shared_pointer > entries_t;

    // cacheLock should not be held while calling *Requester methods
    epicsMutex cacheLock;

    entries_t entries;

    epics::pvAccess::ChannelProvider::shared_pointer provider; // client Provider

    epicsTimerQueueActive *timerQueue;
    epicsTimer *cleanTimer;
    struct cacheClean;
    cacheClean *cleaner;
    size_t cleanerRuns;
    size_t cleanerDust;

    ChannelCache(const epics::pvAccess::ChannelProvider::shared_pointer& prov);
    ~ChannelCache();

    ChannelCacheEntry::shared_pointer lookup(const std::string& name);
};

#endif // CHANCACHE_H