serverContext.h

Go to the documentation of this file.

#ifndef SERVERCONTEXT_H_
#define SERVERCONTEXT_H_

#include <epicsTime.h>

#include <pv/pvaDefs.h>
#include <pv/beaconServerStatusProvider.h>
#include <pv/pvaConstants.h>
#include <pv/pvaVersion.h>
#include <pv/pvAccess.h>
#include <pv/configuration.h>

#include <shareLib.h>

namespace epics {
namespace pvAccess {

class epicsShareClass ServerContext
{
public:
    POINTER_DEFINITIONS(ServerContext);

    virtual ~ServerContext() {};

    virtual const ServerGUID& getGUID() = 0;

    virtual const Version& getVersion() = 0;

    virtual void run(epics::pvData::uint32 seconds) = 0;

    virtual void shutdown() = 0;

    void printInfo(int lvl =0);

    virtual void printInfo(std::ostream& str, int lvl=0) = 0;

    virtual epicsTimeStamp& getStartTime() = 0;

    virtual epics::pvData::int32 getServerPort() = 0;

    virtual epics::pvData::int32 getBroadcastPort() = 0;

    virtual Configuration::shared_pointer getCurrentConfig() = 0;

    virtual const std::vector<ChannelProvider::shared_pointer>& getChannelProviders() =0;

    // ************************************************************************** //
    // **************************** [ Plugins ] ********************************* //
    // ************************************************************************** //

    virtual void setBeaconServerStatusProvider(BeaconServerStatusProvider::shared_pointer const & beaconServerStatusProvider) = 0;

    class Config {
        friend class ServerContext;
        Configuration::const_shared_pointer _conf;
        std::vector<ChannelProvider::shared_pointer> _providers;
    public:
        Config() {}
        Config& config(const Configuration::const_shared_pointer& c) { _conf = c; return *this; }
        Config& providers(const std::vector<ChannelProvider::shared_pointer>& p) { _providers = p; return *this; }
        Config& provider(const ChannelProvider::shared_pointer& p) { _providers.push_back(p); return *this; }
    };

    static ServerContext::shared_pointer create(const Config& conf = Config());
};

// Caller must store the returned pointer to keep the server alive.
epicsShareFunc ServerContext::shared_pointer startPVAServer(
    std::string const & providerNames = PVACCESS_ALL_PROVIDERS,
    int timeToRun = 0,
    bool runInSeparateThread = false,
    bool printInfo = false);

}
}


#endif /* SERVERCONTEXT_H_ */