epics::pvAccess::ServerContextImpl Class Reference

#include "serverContextImpl.h"

Inheritance diagram for epics::pvAccess::ServerContextImpl:

Collaboration diagram for epics::pvAccess::ServerContextImpl:

Public Types
typedef std::tr1::shared_ptr< ServerContextImpl >	shared_pointer
typedef std::tr1::shared_ptr< const ServerContextImpl >	const_shared_pointer
typedef std::map< std::string, std::tr1::weak_ptr< ChannelProvider > >	s_channelNameToProvider_t

Public Member Functions
	ServerContextImpl ()
virtual	~ServerContextImpl ()
const ServerGUID &	getGUID () OVERRIDE FINAL
const Version &	getVersion () OVERRIDE FINAL
void	initialize ()
void	run (epics::pvData::uint32 seconds) OVERRIDE FINAL
void	shutdown () OVERRIDE FINAL
void	printInfo (std::ostream &str, int lvl) OVERRIDE FINAL
void	setBeaconServerStatusProvider (BeaconServerStatusProvider::shared_pointer const &beaconServerStatusProvider) OVERRIDE FINAL
epics::pvData::Timer::shared_pointer	getTimer () OVERRIDE FINAL
Channel::shared_pointer	getChannel (pvAccessID id) OVERRIDE FINAL
Transport::shared_pointer	getSearchTransport () OVERRIDE FINAL
Configuration::const_shared_pointer	getConfiguration () OVERRIDE FINAL
TransportRegistry *	getTransportRegistry () OVERRIDE FINAL
virtual void	newServerDetected () OVERRIDE FINAL
epicsTimeStamp &	getStartTime () OVERRIDE FINAL
virtual Configuration::shared_pointer	getCurrentConfig () OVERRIDE FINAL
float	getBeaconPeriod ()
epics::pvData::int32	getReceiveBufferSize ()
epics::pvData::int32	getServerPort () OVERRIDE FINAL
epics::pvData::int32	getBroadcastPort () OVERRIDE FINAL
BeaconServerStatusProvider::shared_pointer	getBeaconServerStatusProvider ()
const osiSockAddr *	getServerInetAddress ()
const BlockingUDPTransport::shared_pointer &	getBroadcastTransport ()
virtual const std::vector< ChannelProvider::shared_pointer > &	getChannelProviders () OVERRIDE FINAL
bool	isChannelProviderNamePreconfigured ()
Public Member Functions inherited from epics::pvAccess::ServerContext
	POINTER_DEFINITIONS (ServerContext)
virtual	~ServerContext ()
void	printInfo (int lvl=0)
Public Member Functions inherited from epics::pvAccess::Context
	POINTER_DEFINITIONS (Context)
virtual	~Context ()

Public Attributes
s_channelNameToProvider_t	s_channelNameToProvider
epics::pvData::Mutex	_mutex

Static Public Attributes
static size_t	num_instances
static const Version	VERSION

Friends
class	ServerContext

Additional Inherited Members
Static Public Member Functions inherited from epics::pvAccess::ServerContext
static ServerContext::shared_pointer	create (const Config &conf=Config())

Detailed Description

Definition at line 25 of file serverContextImpl.h.

Member Typedef Documentation

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

Definition at line 33 of file serverContextImpl.h.

typedef std::map<std::string, std::tr1::weak_ptr<ChannelProvider> > epics::pvAccess::ServerContextImpl::s_channelNameToProvider_t

Definition at line 122 of file serverContextImpl.h.

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

Definition at line 32 of file serverContextImpl.h.

Constructor & Destructor Documentation

epics::pvAccess::ServerContextImpl::ServerContextImpl

(

)

Definition at line 34 of file serverContext.cpp.

                                    :
    _beaconAddressList(),
    _ignoreAddressList(),
    _autoBeaconAddressList(true),
    _beaconPeriod(15.0),
    _broadcastPort(PVA_BROADCAST_PORT),
    _serverPort(PVA_SERVER_PORT),
    _receiveBufferSize(MAX_TCP_RECV),
    _timer(new Timer("PVAS timers", lowerPriority)),
    _beaconEmitter(),
    _acceptor(),
    _transportRegistry(),
    _channelProviders(),
    _beaconServerStatusProvider(),
    _startTime()
{
    REFTRACE_INCREMENT(num_instances);

    epicsTimeGetCurrent(&_startTime);

    // TODO maybe there is a better place for this (when there will be some factory)
    epicsSignalInstallSigAlarmIgnore ();
    epicsSignalInstallSigPipeIgnore ();

    generateGUID();
}

epics::pvAccess::ServerContextImpl::~ServerContextImpl ( )

virtual

Definition at line 61 of file serverContext.cpp.

{
    try
    {
        shutdown();
    }
    catch(std::exception& e)
    {
        std::cerr<<"Error in: ServerContextImpl::~ServerContextImpl: "<<e.what()<<"\n";
    }
    REFTRACE_DECREMENT(num_instances);
}

Member Function Documentation

float epics::pvAccess::ServerContextImpl::getBeaconPeriod

(

)

Get beacon period (in seconds).

Returns

beacon period (in seconds).

Definition at line 468 of file serverContext.cpp.

{
    return _beaconPeriod;
}

BeaconServerStatusProvider::shared_pointer epics::pvAccess::ServerContextImpl::getBeaconServerStatusProvider

(

)

Get registered beacon server status provider.

Returns

registered beacon server status provider.

Definition at line 488 of file serverContext.cpp.

{
    return _beaconServerStatusProvider;
}

int32 epics::pvAccess::ServerContextImpl::getBroadcastPort ( )

virtual

Get broadcast port.

Returns

broadcast port.

Implements epics::pvAccess::ServerContext.

Definition at line 483 of file serverContext.cpp.

{
    return _broadcastPort;
}

const BlockingUDPTransport::shared_pointer & epics::pvAccess::ServerContextImpl::getBroadcastTransport

(

)

Broadcast (UDP send) transport.

Returns

broadcast transport.

Definition at line 502 of file serverContext.cpp.

{
    return _broadcastTransport;
}

Channel::shared_pointer epics::pvAccess::ServerContextImpl::getChannel ( pvAccessID  id )

virtual

Implements epics::pvAccess::Context.

Definition at line 522 of file serverContext.cpp.

{
    // not used
    return Channel::shared_pointer();
}

const std::vector< ChannelProvider::shared_pointer > & epics::pvAccess::ServerContextImpl::getChannelProviders ( )

virtual

Get channel providers.

Returns

channel providers.

Implements epics::pvAccess::ServerContext.

Definition at line 507 of file serverContext.cpp.

{
    return _channelProviders;
}

Configuration::const_shared_pointer epics::pvAccess::ServerContextImpl::getConfiguration ( )

virtual

Implements epics::pvAccess::Context.

Definition at line 95 of file serverContext.cpp.

{
    Lock guard(_mutex);
    if (configuration.get() == 0)
    {
        ConfigurationProvider::shared_pointer configurationProvider = ConfigurationFactory::getProvider();
        configuration = configurationProvider->getConfiguration("pvAccess-server");
        if (configuration.get() == 0)
        {
            configuration = configurationProvider->getConfiguration("system");
        }
    }
    return configuration;
}

Configuration::shared_pointer epics::pvAccess::ServerContextImpl::getCurrentConfig ( )

virtual

Return a Configuration with the actual values being used, including defaults used, and bounds limits applied.

Implements epics::pvAccess::ServerContext.

Definition at line 212 of file serverContext.cpp.

{
    ConfigurationBuilder B;

    std::ostringstream providerName;
    for(size_t i=0; i<_channelProviders.size(); i++) {
        if(i>0)
            providerName<<" ";
        providerName<<_channelProviders[i]->getProviderName();
    }

#define SET(K, V) B.add(K, V);

    {
        char buf[24];
        ipAddrToDottedIP(&_ifaceAddr.ia, buf, sizeof(buf));
        buf[sizeof(buf)-1] = '\0';
        SET("EPICS_PVAS_INTF_ADDR_LIST", buf);
    }

    SET("EPICS_PVAS_BEACON_ADDR_LIST", _beaconAddressList);
    SET("EPICS_PVA_ADDR_LIST", _beaconAddressList);

    SET("EPICS_PVAS_AUTO_BEACON_ADDR_LIST",
                         _autoBeaconAddressList ? "YES" : "NO");
    SET("EPICS_PVA_AUTO_ADDR_LIST",
                         _autoBeaconAddressList ? "YES" : "NO");

    SET("EPICS_PVAS_BEACON_PERIOD", getBeaconPeriod());
    SET("EPICS_PVA_BEACON_PERIOD", getBeaconPeriod());

    SET("EPICS_PVAS_SERVER_PORT", getServerPort());
    SET("EPICS_PVA_SERVER_PORT", getServerPort());

    SET("EPICS_PVAS_BROADCAST_PORT", getBroadcastPort());
    SET("EPICS_PVA_BROADCAST_PORT", getBroadcastPort());

    SET("EPICS_PVAS_MAX_ARRAY_BYTES", getReceiveBufferSize());
    SET("EPICS_PVA_MAX_ARRAY_BYTES", getReceiveBufferSize());

    SET("EPICS_PVAS_PROVIDER_NAMES", providerName.str());

#undef SET

    return B.push_map().build();
}

const ServerGUID & epics::pvAccess::ServerContextImpl::getGUID ( )

virtual

Returns GUID (12-byte array).

Returns

GUID.

Implements epics::pvAccess::ServerContext.

Definition at line 74 of file serverContext.cpp.

{
    return _guid;
}

int32 epics::pvAccess::ServerContextImpl::getReceiveBufferSize

(

)

Get receiver buffer (payload) size.

Returns

max payload size.

Definition at line 473 of file serverContext.cpp.

{
    return _receiveBufferSize;
}

Transport::shared_pointer epics::pvAccess::ServerContextImpl::getSearchTransport ( )

virtual

Implements epics::pvAccess::Context.

Definition at line 528 of file serverContext.cpp.

{
    // not used
    return Transport::shared_pointer();
}

const osiSockAddr * epics::pvAccess::ServerContextImpl::getServerInetAddress

(

)

Get server newtwork (IP) address.

Returns

server network (IP) address, NULL if not bounded.

Definition at line 493 of file serverContext.cpp.

{
    if(_acceptor.get())
    {
        return const_cast<osiSockAddr*>(_acceptor->getBindAddress());
    }
    return NULL;
}

int32 epics::pvAccess::ServerContextImpl::getServerPort ( )

virtual

Get server port.

Returns

server port.

Implements epics::pvAccess::ServerContext.

Definition at line 478 of file serverContext.cpp.

{
    return _serverPort;
}

epicsTimeStamp & epics::pvAccess::ServerContextImpl::getStartTime ( )

virtual

Implements epics::pvAccess::ServerContext.

Definition at line 539 of file serverContext.cpp.

{
    return _startTime;
}

Timer::shared_pointer epics::pvAccess::ServerContextImpl::getTimer ( )

virtual

Implements epics::pvAccess::Context.

Definition at line 512 of file serverContext.cpp.

{
    return _timer;
}

epics::pvAccess::TransportRegistry * epics::pvAccess::ServerContextImpl::getTransportRegistry ( )

virtual

Implements epics::pvAccess::Context.

Definition at line 517 of file serverContext.cpp.

{
    return &_transportRegistry;
}

const Version & epics::pvAccess::ServerContextImpl::getVersion ( )

virtual

Get context implementation version.

Returns

version of the context implementation.

Implements epics::pvAccess::ServerContext.

Definition at line 79 of file serverContext.cpp.

{
    return ServerContextImpl::VERSION;
}

void epics::pvAccess::ServerContextImpl::initialize

(

)

Definition at line 265 of file serverContext.cpp.

{
    Lock guard(_mutex);

    // already called in loadConfiguration
    //osiSockAttach();

    ServerContextImpl::shared_pointer thisServerContext = shared_from_this();
    // we create reference cycles here which are broken by our shutdown() method,
    _responseHandler.reset(new ServerResponseHandler(thisServerContext));

    _acceptor.reset(new BlockingTCPAcceptor(thisServerContext, _responseHandler, _ifaceAddr, _receiveBufferSize));
    _serverPort = ntohs(_acceptor->getBindAddress()->ia.sin_port);

    // setup broadcast UDP transport
    initializeUDPTransports(true, _udpTransports, _ifaceList, _responseHandler, _broadcastTransport,
                            _broadcastPort, _autoBeaconAddressList, _beaconAddressList, _ignoreAddressList);

    _beaconEmitter.reset(new BeaconEmitter("tcp", _broadcastTransport, thisServerContext));

    _beaconEmitter->start();
}

bool epics::pvAccess::ServerContextImpl::isChannelProviderNamePreconfigured

(

)

Return true if channel provider name is provided by configuration (e.g. system env. var.).

Returns

true if channel provider name is provided by configuration (e.g. system env. var.)

Definition at line 259 of file serverContext.cpp.

{
    Configuration::const_shared_pointer config = getConfiguration();
    return config->hasProperty("EPICS_PVAS_PROVIDER_NAMES");
}

void epics::pvAccess::ServerContextImpl::newServerDetected ( )

virtual

due to ClientContextImpl

Implements epics::pvAccess::Context.

Definition at line 534 of file serverContext.cpp.

{
    // not used
}

void epics::pvAccess::ServerContextImpl::printInfo ( std::ostream &  str, int  lvl  )

virtual

Prints detailed information about the context to the specified output stream.

Parameters

lvl	detail level
str	stream to which to print the info

Implements epics::pvAccess::ServerContext.

Definition at line 369 of file serverContext.cpp.

{
    if(lvl==0) {
        Lock guard(_mutex);
        str << getVersion().getVersionString() << "\n"
            << "Active configuration (w/ defaults)\n";

        Configuration::shared_pointer conf(getCurrentConfig());
#define SHOW(ENV) str << #ENV " = "<<conf->getPropertyAsString(#ENV, std::string())<<"\n";
        SHOW(EPICS_PVAS_INTF_ADDR_LIST)
        SHOW(EPICS_PVAS_BEACON_ADDR_LIST)
        SHOW(EPICS_PVAS_AUTO_BEACON_ADDR_LIST)
        SHOW(EPICS_PVAS_BEACON_PERIOD)
        SHOW(EPICS_PVAS_BROADCAST_PORT)
        SHOW(EPICS_PVAS_SERVER_PORT)
        SHOW(EPICS_PVAS_PROVIDER_NAMES)
#undef SHOW

    } else {
        // lvl >= 1

        TransportRegistry::transportVector_t transports;
        _transportRegistry.toArray(transports);

        str<<"Clients:\n";
        for(TransportRegistry::transportVector_t::const_iterator it(transports.begin()), end(transports.end());
            it!=end; ++it)
        {
            const Transport::shared_pointer& transport(*it);

            str<<"  "<<transport->getType()<<"://"<<transport->getRemoteName()
              <<" "<<(transport->isClosed()?"closed!":"");

            const detail::BlockingServerTCPTransportCodec *casTransport = dynamic_cast<const detail::BlockingServerTCPTransportCodec*>(transport.get());

            if(casTransport) {
              str<<" ver="<<unsigned(casTransport->getRevision())
                 <<" "<<(casTransport ? casTransport->getChannelCount() : size_t(-1))<<" channels";

              PeerInfo::const_shared_pointer peer;
              {
                  epicsGuard<epicsMutex> G(casTransport->_mutex);
                  peer = casTransport->_peerInfo;
              }
              if(peer) {
                  str<<" user: "<<peer->authority<<"/"<<peer->account;
                  if(!peer->realm.empty())
                      str<<"@"<<peer->realm;
                  if(lvl>=2 && !peer->roles.empty()) {
                      str<<" groups:";
                      int n=0;
                      for(PeerInfo::roles_t::const_iterator it(peer->roles.begin()), end(peer->roles.end()); it!=end; ++it, ++n) {
                          if(n)
                              str<<',';
                          str<<(*it);
                      }
                  }
                  if(lvl>=3 && peer->aux) {
                      str<<" aux. auth.:\n";
                      format::indent_scope I(str);
                      str<<(*peer->aux);
                  }
              }
            }

            str<<"\n";

            if(!casTransport || lvl<2)
                return;
            // lvl >= 2

            typedef std::vector<ServerChannel::shared_pointer> channels_t;
            channels_t channels;
            casTransport->getChannels(channels);

            for(channels_t::const_iterator it(channels.begin()), end(channels.end()); it!=end; ++it)
            {
                const ServerChannel *channel(static_cast<const ServerChannel*>(it->get()));
                const Channel::shared_pointer& providerChan(channel->getChannel());
                if(!providerChan)
                    continue;

                str<<"  "<<providerChan->getChannelName()
                   <<(providerChan->isConnected()?"":" closed");
                if(lvl>=3) {
                    str<<"\t: ";
                    providerChan->printInfo(str);
                }
                str<<"\n";
            }
        }
    }
}

void epics::pvAccess::ServerContextImpl::run ( epics::pvData::uint32  seconds )

virtual

Run server (process events).

Parameters

seconds

time in seconds the server will process events (method will block), if 0 the method would block until destroy() is called.

Exceptions

BaseException

if server is already destroyed.

Implements epics::pvAccess::ServerContext.

Definition at line 288 of file serverContext.cpp.

{
    //TODO review this
    if(seconds == 0)
    {
        _runEvent.wait();
    }
    else
    {
        _runEvent.wait(seconds);
    }
}

void epics::pvAccess::ServerContextImpl::setBeaconServerStatusProvider ( BeaconServerStatusProvider::shared_pointer const &  beaconServerStatusProvider )

virtual

Set beacon server status provider.

Parameters

beaconServerStatusProvider

BeaconServerStatusProvider implementation to set.

Implements epics::pvAccess::ServerContext.

Definition at line 463 of file serverContext.cpp.

{
    _beaconServerStatusProvider = beaconServerStatusProvider;
}

void epics::pvAccess::ServerContextImpl::shutdown ( )

virtual

Implements epics::pvAccess::ServerContext.

Definition at line 303 of file serverContext.cpp.

{
    if(!_timer)
        return; // already shutdown

    // abort pending timers and prevent new timers from starting
    _timer->close();

    // stop responding to search requests
    for (BlockingUDPTransportVector::const_iterator iter = _udpTransports.begin();
            iter != _udpTransports.end(); iter++)
    {
        const BlockingUDPTransport::shared_pointer& transport = *iter;
        // joins worker thread
        transport->close();
        // _udpTransports contains _broadcastTransport
        // _broadcastTransport is referred to be _beaconEmitter
        if(transport!=_broadcastTransport)
            LEAK_CHECK(transport, "udp transport")
    }
    _udpTransports.clear();

    // stop emitting beacons
    if (_beaconEmitter)
    {
        _beaconEmitter->destroy();
        LEAK_CHECK(_beaconEmitter, "_beaconEmitter")
        _beaconEmitter.reset();
    }

    // close UDP sent transport
    if (_broadcastTransport)
    {
        _broadcastTransport->close();
        LEAK_CHECK(_broadcastTransport, "_broadcastTransport")
        _broadcastTransport.reset();
    }

    // stop accepting connections
    if (_acceptor)
    {
        _acceptor->destroy();
        LEAK_CHECK(_acceptor, "_acceptor")
        _acceptor.reset();
    }

    // this will also destroy all channels
    _transportRegistry.clear();

    // drop timer queue
    LEAK_CHECK(_timer, "_timer")
    _timer.reset();

    // response handlers hold strong references to us,
    // so must break the cycles
    LEAK_CHECK(_responseHandler, "_responseHandler")
    _responseHandler.reset();

    _runEvent.signal();
}

Friends And Related Function Documentation

friend class ServerContext

friend

Definition at line 30 of file serverContextImpl.h.

Member Data Documentation

epics::pvData::Mutex epics::pvAccess::ServerContextImpl::_mutex

Definition at line 206 of file serverContextImpl.h.

size_t epics::pvAccess::ServerContextImpl::num_instances

static

Definition at line 35 of file serverContextImpl.h.

s_channelNameToProvider_t epics::pvAccess::ServerContextImpl::s_channelNameToProvider

Definition at line 123 of file serverContextImpl.h.

const Version epics::pvAccess::ServerContextImpl::VERSION

static

Version.

Definition at line 65 of file serverContextImpl.h.

---

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

• modules/pvAccess/src/server/pv/serverContextImpl.h
• modules/pvAccess/src/server/serverContext.cpp