epics::pvAccess::ChannelSearchManager Class Reference

#include "channelSearchManager.h"

Inheritance diagram for epics::pvAccess::ChannelSearchManager:

Collaboration diagram for epics::pvAccess::ChannelSearchManager:

Public Member Functions
	POINTER_DEFINITIONS (ChannelSearchManager)
virtual	~ChannelSearchManager ()
void	cancel ()
int32_t	registeredCount ()
void	registerSearchInstance (SearchInstance::shared_pointer const &channel, bool penalize=false)
void	unregisterSearchInstance (SearchInstance::shared_pointer const &channel)
void	searchResponse (const ServerGUID &guid, pvAccessID cid, int32_t seqNo, int8_t minorRevision, osiSockAddr *serverAddress)
void	newServerDetected ()
virtual void	callback () OVERRIDE FINAL
	Timer callback. More...
virtual void	timerStopped () OVERRIDE FINAL
	Timer stooped callback. More...
	ChannelSearchManager (Context::shared_pointer const &context)
void	activate ()
Public Member Functions inherited from epics::pvData::TimerCallback
	POINTER_DEFINITIONS (TimerCallback)
	TimerCallback ()
virtual	~TimerCallback ()

Detailed Description

Definition at line 54 of file channelSearchManager.h.

Constructor & Destructor Documentation

epics::pvAccess::ChannelSearchManager::~ChannelSearchManager ( )

virtual

Definition at line 107 of file channelSearchManager.cpp.

{
    Lock guard(m_mutex);
    if (!m_canceled.get()) {
        LOG(logLevelWarn, "Logic error: ChannelSearchManager destroyed w/o cancel()");
    }
}

epics::pvAccess::ChannelSearchManager::ChannelSearchManager

(

Context::shared_pointer const &

context

)

Private constructor.

Parameters

context

Definition at line 76 of file channelSearchManager.cpp.

                                                                                :
    m_context(context),
    m_responseAddress(), // initialized in activate()
    m_canceled(),
    m_sequenceNumber(0),
    m_sendBuffer(MAX_UDP_UNFRAGMENTED_SEND),
    m_channels(),
    m_lastTimeSent(),
    m_channelMutex(),
    m_userValueMutex(),
    m_mutex()
{
    // initialize random seed with some random value
    srand ( time(NULL) );
}

Member Function Documentation

void epics::pvAccess::ChannelSearchManager::activate

(

)

Definition at line 92 of file channelSearchManager.cpp.

{
    m_responseAddress = Context::shared_pointer(m_context)->getSearchTransport()->getRemoteAddress();

    // initialize send buffer
    initializeSendBuffer();

    // add some jitter so that all the clients do not send at the same time
    double period = ATOMIC_PERIOD + double(rand())/RAND_MAX*PERIOD_JITTER_MS;

    Context::shared_pointer context(m_context.lock());
    if (context)
        context->getTimer()->schedulePeriodic(shared_from_this(), period, period);
}

void epics::pvAccess::ChannelSearchManager::callback ( )

virtual

Timer callback.

Implements epics::pvData::TimerCallback.

Definition at line 317 of file channelSearchManager.cpp.

{
    // high-frequency beacon anomaly trigger guard
    {
        Lock guard(m_mutex);

        epics::pvData::TimeStamp now;
        now.getCurrent();
        int64_t nowMS = now.getMilliseconds();

        if (nowMS - m_lastTimeSent < 100)
            return;
        m_lastTimeSent = nowMS;
    }


    int count = 0;
    int frameSent = 0;

    vector<SearchInstance::shared_pointer> toSend;
    {
        Lock guard(m_channelMutex);
        toSend.reserve(m_channels.size());

        for(m_channels_t::iterator channelsIter = m_channels.begin();
            channelsIter != m_channels.end(); channelsIter++)
        {
            SearchInstance::shared_pointer inst(channelsIter->second.lock());
            if(!inst) continue;
            toSend.push_back(inst);
        }
    }

    vector<SearchInstance::shared_pointer>::iterator siter = toSend.begin();
    for (; siter != toSend.end(); siter++)
    {
        bool skip;
        {
            epicsGuard<epicsMutex> G(m_userValueMutex);
            int32_t& countValue = (*siter)->getUserValue();
            skip = !isPowerOfTwo(countValue);

            if (countValue >= MAX_COUNT_VALUE)
                countValue = MAX_FALLBACK_COUNT_VALUE;
            else
                countValue++;
        }

        // back-off
        if (skip)
            continue;

        count++;

        if (generateSearchRequestMessage(*siter, true, false))
            frameSent++;
        if (frameSent == MAX_FRAMES_AT_ONCE)
        {
            epicsThreadSleep(DELAY_BETWEEN_FRAMES_MS/(double)1000.0);
            frameSent = 0;
        }
    }

    if (count > 0)
        flushSendBuffer();
}

void epics::pvAccess::ChannelSearchManager::cancel

(

)

Cancel.

Definition at line 115 of file channelSearchManager.cpp.

{
    Lock guard(m_mutex);

    if (m_canceled.get())
        return;
    m_canceled.set();

    Context::shared_pointer context(m_context.lock());
    if (context)
        context->getTimer()->cancel(shared_from_this());
}

void epics::pvAccess::ChannelSearchManager::newServerDetected

(

)

New server detected. Boost searching of all channels.

Definition at line 194 of file channelSearchManager.cpp.

{
    boost();
    callback();
}

epics::pvAccess::ChannelSearchManager::POINTER_DEFINITIONS

(

ChannelSearchManager

)

int32_t epics::pvAccess::ChannelSearchManager::registeredCount

(

)

Get number of registered channels.

Returns

number of registered channels.

Definition at line 128 of file channelSearchManager.cpp.

{
    Lock guard(m_channelMutex);
    return static_cast<int32_t>(m_channels.size());
}

void epics::pvAccess::ChannelSearchManager::registerSearchInstance	(	SearchInstance::shared_pointer const &	channel,
		bool	penalize = false
	)

Register channel.

Parameters

channel

to register.

Definition at line 134 of file channelSearchManager.cpp.

{
    if (m_canceled.get())
        return;

    bool immediateTrigger;
    {
        Lock guard(m_channelMutex);

        // overrides if already registered
        m_channels[channel->getSearchInstanceID()] = channel;
        immediateTrigger = (m_channels.size() == 1);

        Lock guard2(m_userValueMutex);
        int32_t& userValue = channel->getUserValue();
        userValue = (penalize ? MAX_FALLBACK_COUNT_VALUE : DEFAULT_USER_VALUE);
    }

    if (immediateTrigger)
        callback();
}

void epics::pvAccess::ChannelSearchManager::searchResponse	(	const ServerGUID &	guid,
		pvAccessID	cid,
		int32_t	seqNo,
		int8_t	minorRevision,
		osiSockAddr *	serverAddress
	)

Search response from server (channel found).

Parameters

guid	server GUID.
cid	client channel ID.
seqNo	search sequence number.
minorRevision	server minor PVA revision.
serverAddress	server address.

Definition at line 163 of file channelSearchManager.cpp.

{
    Lock guard(m_channelMutex);
    m_channels_t::iterator channelsIter = m_channels.find(cid);
    if(channelsIter == m_channels.end())
    {
        guard.unlock();
        Context::shared_pointer ctxt(m_context.lock());
        // TODO: proper action if !ctxt???
        if(!ctxt) return;

        // enable duplicate reports
        SearchInstance::shared_pointer si = std::tr1::dynamic_pointer_cast<SearchInstance>(ctxt->getChannel(cid));
        if (si)
            si->searchResponse(guid, minorRevision, serverAddress);
    }
    else
    {
        SearchInstance::shared_pointer si(channelsIter->second.lock());

        // remove from search list
        m_channels.erase(cid);

        guard.unlock();

        // then notify SearchInstance
        if(si)
            si->searchResponse(guid, minorRevision, serverAddress);
    }
}

void epics::pvAccess::ChannelSearchManager::timerStopped ( )

virtual

Timer stooped callback.

Implements epics::pvData::TimerCallback.

Definition at line 389 of file channelSearchManager.cpp.

{
}

void epics::pvAccess::ChannelSearchManager::unregisterSearchInstance

(

SearchInstance::shared_pointer const &

channel

)

Unregister channel.

Parameters

channel

to unregister.

Definition at line 156 of file channelSearchManager.cpp.

{
    Lock guard(m_channelMutex);
    pvAccessID id = channel->getSearchInstanceID();
    m_channels.erase(id);
}

---

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

• modules/pvAccess/src/remote/pv/channelSearchManager.h
• modules/pvAccess/src/remote/channelSearchManager.cpp