dvs_server_interface.h | Ansys Developer Portal

Go to the documentation of this file.
/*  *************************************************************
 *   Copyright 2017-2025 ANSYS, Inc.
 *   All Rights Reserved.
 *
 *        Restricted Rights Legend
 *
 *   Use, duplication, or disclosure of this
 *   software and its documentation by the
 *   Government is subject to restrictions as
 *   set forth in subdivision [(b)(3)(ii)] of
 *   the Rights in Technical Data and Computer
 *   Software clause at 52.227-7013.
 *  *************************************************************
 */
 
#ifndef ___DVS_SERVER_INTERFACE___
#define ___DVS_SERVER_INTERFACE___
 
#include <map>
#include <string>
 
#include "dvs_query_interface.h"
#include "transport_interface.h"
#include "dvs_import_export.h"
 
 
 
namespace DVS
{
    class IServer
    {
    public:
 
        IServer() = default; 
        virtual ~IServer() = default; 
        IServer(IServer&&) = default;  
        IServer& operator=(IServer&&) = default; 
        IServer(const IServer&) = default; 
        IServer& operator=(const IServer&) = default; 
 
        virtual void set_options(const std::map<const char*,const char*>& options) = 0;
 
        virtual void set_option(const char* key, const char* value) = 0;
 
        virtual void clear_options() = 0;
 
        virtual bool running() const = 0;
 
        virtual dvs_ret get_timestep_count(uint32_t& num_pending, uint32_t& num_complete) const = 0;
 
        virtual dvs_ret startup(uint32_t server_number, uint32_t local_ranks) = 0;
 
        virtual dvs_ret startup_unthreaded(uint32_t server_number, uint32_t local_ranks) = 0;
 
        virtual dvs_ret update() = 0;
 
        virtual dvs_ret terminating() = 0;
 
        virtual void shutdown() = 0;
 
        virtual ITransport* create_transport(const std::string& shared_secret) = 0;
 
        virtual const char* get_uri() = 0;
 
        virtual DVS::IQuery* create_query(const std::string& filter=std::string(), DVS::IQuery* parent=nullptr) = 0;
 
    };
 
    DVS_DLL_EXPORT IServer* CREATE_SERVER_INSTANCE(const char* uri);
 
    DVS_DLL_EXPORT void DESTROY_SERVER_INSTANCE(DVS::IServer* destroy);
    
}
 
#endif //___DVS_SERVER_INTERFACE___
EnSight 2025 R2

dvs_server_interface

Connect with Ansys
