epics::pvAccess::BeaconEmitter Class Reference

#include "beaconEmitter.h"

Inheritance diagram for epics::pvAccess::BeaconEmitter:

Collaboration diagram for epics::pvAccess::BeaconEmitter:

Public Types
typedef std::tr1::shared_ptr< BeaconEmitter >	shared_pointer
typedef std::tr1::shared_ptr< const BeaconEmitter >	const_shared_pointer

Public Member Functions
	BeaconEmitter (std::string const &protocol, Transport::shared_pointer const &transport, std::tr1::shared_ptr< ServerContextImpl > &context)
virtual	~BeaconEmitter ()
void	send (epics::pvData::ByteBuffer *buffer, TransportSendControl *control)
void	timerStopped ()
void	start ()
void	reschedule ()
void	callback ()
void	destroy ()
Public Member Functions inherited from epics::pvAccess::TransportSender
	POINTER_DEFINITIONS (TransportSender)
	TransportSender ()
virtual	~TransportSender ()
Public Member Functions inherited from epics::pvAccess::Lockable
	POINTER_DEFINITIONS (Lockable)
virtual	~Lockable ()
virtual void	lock ()
virtual void	unlock ()
Public Member Functions inherited from epics::pvAccess::fair_queue< T >::entry
	entry ()
	~entry ()
Public Member Functions inherited from epics::pvData::TimerCallback
	POINTER_DEFINITIONS (TimerCallback)
	TimerCallback ()
virtual	~TimerCallback ()

Additional Inherited Members
Public Attributes inherited from epics::pvAccess::TransportSender
size_t	bytesTX
size_t	bytesRX

Detailed Description

BeaconEmitter

Author

gjansa

Definition at line 40 of file beaconEmitter.h.

Member Typedef Documentation

typedef std::tr1::shared_ptr<const BeaconEmitter> epics::pvAccess::BeaconEmitter::const_shared_pointer

Definition at line 47 of file beaconEmitter.h.

typedef std::tr1::shared_ptr<BeaconEmitter> epics::pvAccess::BeaconEmitter::shared_pointer

Definition at line 46 of file beaconEmitter.h.

Constructor & Destructor Documentation

epics::pvAccess::BeaconEmitter::BeaconEmitter	(	std::string const &	protocol,
		Transport::shared_pointer const &	transport,
		std::tr1::shared_ptr< ServerContextImpl > &	context
	)

Constructor.

Parameters

protocol	a protocol (transport) name to report.
transport	transport to be used to send beacons.
context	PVA context.

Definition at line 25 of file beaconEmitter.cpp.

                                                                                                                      :
    _protocol(protocol),
    _transport(transport),
    _beaconSequenceID(0),
    _guid(context->getGUID()),
    _fastBeaconPeriod(std::max(context->getBeaconPeriod(), EPICS_PVA_MIN_BEACON_PERIOD)),
    _slowBeaconPeriod(std::max(180.0, _fastBeaconPeriod)), // TODO configurable
    _beaconCountLimit((int16)std::max(10.0f, EPICS_PVA_MIN_BEACON_COUNT_LIMIT)), // TODO configurable
    _serverAddress(*(context->getServerInetAddress())),
    _serverPort(context->getServerPort()),
    _serverStatusProvider(context->getBeaconServerStatusProvider()),
    _timer(context->getTimer())
{
}

epics::pvAccess::BeaconEmitter::~BeaconEmitter ( )

virtual

Definition at line 41 of file beaconEmitter.cpp.

{
    // shared_from_this is not yet allows in destructor
    // be sure to call destroy() first !!!
    // destroy();
}

Member Function Documentation

void epics::pvAccess::BeaconEmitter::callback ( )

virtual

Timer callback.

Implements epics::pvData::TimerCallback.

Definition at line 131 of file beaconEmitter.cpp.

{
    _transport->enqueueSendRequest(shared_from_this());
}

void epics::pvAccess::BeaconEmitter::destroy

(

)

Definition at line 106 of file beaconEmitter.cpp.

{
    Timer::shared_pointer timer(_timer.lock());
    if(timer)
        timer->cancel(shared_from_this());
}

void epics::pvAccess::BeaconEmitter::reschedule

(

)

Reschedule timer.

Definition at line 120 of file beaconEmitter.cpp.

{
    const double period = (_beaconSequenceID >= _beaconCountLimit) ? _slowBeaconPeriod : _fastBeaconPeriod;
    if (period > 0)
    {
        Timer::shared_pointer timer(_timer.lock());
        if(timer)
            timer->scheduleAfterDelay(shared_from_this(), period);
    }
}

void epics::pvAccess::BeaconEmitter::send ( epics::pvData::ByteBuffer *  buffer, TransportSendControl *  control  )

virtual

Called by transport. By this call transport gives callee ownership over the buffer. Calls on TransportSendControl instance must be made from calling thread. Moreover, ownership is valid only for the time of call of this method. NOTE: these limitations allow efficient implementation.

Implements epics::pvAccess::TransportSender.

Definition at line 48 of file beaconEmitter.cpp.

{
    // get server status
    PVField::shared_pointer serverStatus;
    if(_serverStatusProvider.get())
    {
        try
        {
            serverStatus = _serverStatusProvider->getServerStatusData();
        }
        catch (...) {
            // we have to proctect internal code from external implementation...
            LOG(logLevelDebug, "BeaconServerStatusProvider implementation thrown an exception.");
        }
    }

    // send beacon
    control->startMessage((int8)CMD_BEACON, 12+2+2+16+2);

    buffer->put(_guid.value, 0, sizeof(_guid.value));

    // TODO qos/flags (e.g. multicast/unicast)
    buffer->putByte(0);

    buffer->putByte(_beaconSequenceID);

    // TODO for now fixed changeCount
    buffer->putShort(0);

    // NOTE: is it possible (very likely) that address is any local address ::ffff:0.0.0.0
    encodeAsIPv6Address(buffer, &_serverAddress);
    buffer->putShort((int16)_serverPort);

    SerializeHelper::serializeString(_protocol, buffer, control);

    if (serverStatus)
    {
        // introspection interface + data
        serverStatus->getField()->serialize(buffer, control);
        serverStatus->serialize(buffer, control);
    }
    else
    {
        SerializationHelper::serializeNullField(buffer, control);
    }
    control->flush(true);

    // increment beacon sequence ID
    _beaconSequenceID++;

    reschedule();
}

void epics::pvAccess::BeaconEmitter::start

(

)

Start emitting.

Definition at line 113 of file beaconEmitter.cpp.

{
    Timer::shared_pointer timer(_timer.lock());
    if(timer)
        timer->scheduleAfterDelay(shared_from_this(), 0.0);
}

void epics::pvAccess::BeaconEmitter::timerStopped ( )

virtual

The timer has stopped.

Implements epics::pvData::TimerCallback.

Definition at line 101 of file beaconEmitter.cpp.

{
    //noop
}

---

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

• modules/pvAccess/src/server/pv/beaconEmitter.h
• modules/pvAccess/src/server/beaconEmitter.cpp