Server.h

Go to the documentation of this file.

// Copyright (c) 2016 Digital Barriers

#pragma once

#include "OpResult.h"
#include "EdgeVisSDK.h"
#include "ServerConnectInfo.h"
#include "Device.h"
#include "Encoder.h"
#include "Pimpl.h"
#include "ConnectionStrategy.h"
#include "ServerAddresses.h"
#include "Credentials.h"
#include "ClientSecurityPolicy.h"
#include "LoggingLevel.h"

namespace EdgeVisDecoderSDK
{
  typedef EdgeVisSDKCore::ServerAddresses ServerAddresses;

  class ServerImpl;
  class PasswordResetInfo;
  class ServerInfo;
  class Stream;
  class IServerListener;
  class IServerEventListener;
  class CamsRuleManager;
  class CamsNotificationManager;
  class UserNotificationPreferences;
  class MFALoginResponse;
  class SSOOpenIdLoginResponse;

  class Server : public EdgeVisSDKPimpl<ServerImpl>
  {
  public:
    
    DB_EDGEVIS_SDK Server();
    
    DB_EDGEVIS_SDK Server( const std::wstring& appName, const std::wstring& appMetadata );
    
    EdgeVisSDKPimplWeakConstructor(Server);
    
    DB_EDGEVIS_SDK virtual ~Server();

    DB_EDGEVIS_SDK static std::wstring ClientVersion();

    DB_EDGEVIS_SDK void SetClusterInfoCachingEnabled(bool enabled);

    DB_EDGEVIS_SDK OpResult Connect(
      const ServerAddresses& hostAddresses,
      const std::wstring& username,
      const std::wstring& password,
      const std::wstring& new_password,
      ServerAddresses& availableAddresses,
      ConnectionStrategy connect_strategy,
      ServerConnectInfo flags = SCI_ASPECT_CORRECT
      );

    DB_EDGEVIS_SDK OpResult Connect(
      const ServerAddresses& hostAddresses,
      const Credentials credentials,
      ServerAddresses& availableAddresses,
      ConnectionStrategy connect_strategy,
      ServerConnectInfo flags = SCI_ASPECT_CORRECT
    );

    DB_EDGEVIS_SDK OpResult Connect(
      const ServerAddresses& hostAddresses,
      const Credentials credentials,
      ServerAddresses& availableAddresses
    );

    DB_EDGEVIS_SDK PasswordResetInfo GetPasswordResetInfo() const;

    DB_EDGEVIS_SDK MFALoginResponse GetMFALoginResponse() const;

    DB_EDGEVIS_SDK SSOOpenIdLoginResponse GetSSOOpenIdLoginResponse() const;

    DB_EDGEVIS_SDK std::wstring GetDevicePassword() const;
  
    DB_EDGEVIS_SDK bool HasCams() const;

    DB_EDGEVIS_SDK bool SupportsClientCamsRuleBuilder() const;

    DB_EDGEVIS_SDK ServerInfo QueryServerInfo( const ServerAddresses& hostAddresses );

    DB_EDGEVIS_SDK OpResult ValidateCredentials(
      const ServerAddresses& hostAddresses,
      const Credentials& credentials,
      ServerAddresses& availableAddresses);

    DB_EDGEVIS_SDK OpResult ValidateCredentials( const ServerAddresses& hostAddresses,
      const std::wstring& username,
      const std::wstring& password,
      const std::wstring& new_password,
      ServerAddresses& availableAddresses);
    
    DB_EDGEVIS_SDK void CancelQueryServerInfo();

    DB_EDGEVIS_SDK void CancelValidateCredentials();
    
    DB_EDGEVIS_SDK CamsNotificationManager GetCamsNotificationManager();
    
    DB_EDGEVIS_SDK int32_t GetAvailableLicenses() const;

    DB_EDGEVIS_SDK void Disconnect();

    DB_EDGEVIS_SDK bool IsConnected() const;
    
    DB_EDGEVIS_SDK ServerInfo GetServerInfo() const;
    
    DB_EDGEVIS_SDK OpResult QueryEncoders(std::vector<Encoder> &result);

    DB_EDGEVIS_SDK OpResult GetEncoders(std::vector<Encoder> &result);

    DB_EDGEVIS_SDK OpResult QueryEncoder( Encoder &result, const std::wstring& name );

    DB_EDGEVIS_SDK OpResult GetDevices(std::vector<Device>& result) const;

    DB_EDGEVIS_SDK OpResult GetEncodersForDeviceUUID(const std::wstring& deviceUUID, std::vector<Encoder>& result) const;

    DB_EDGEVIS_SDK OpResult GetDeviceForEncoderUUID(const std::wstring& encoderUUID, Device& result);

    DB_EDGEVIS_SDK void RegisterListener( IServerListener* listener );
    
    DB_EDGEVIS_SDK void UnregisterListener( IServerListener* listener );

    DB_EDGEVIS_SDK void RegisterEventListener(IServerEventListener* listener);
    
    DB_EDGEVIS_SDK void UnregisterEventListener(IServerEventListener* listener);

    DB_EDGEVIS_SDK Device GetDevice(const std::wstring& name) const;

    DB_EDGEVIS_SDK Device GetDeviceByUUID(const std::wstring& uuid) const;

    DB_EDGEVIS_SDK Encoder GetEncoder( const std::wstring& name ) const;

    DB_EDGEVIS_SDK Encoder GetEncoderByUUID(const std::wstring& uuid) const;

    DB_EDGEVIS_SDK std::wstring Name() const;
    
    DB_EDGEVIS_SDK std::wstring Version() const;
    
    DB_EDGEVIS_SDK std::wstring UniqueID() const;

    DB_EDGEVIS_SDK bool IsAtLeastVersion(int32_t major, int32_t minor, int32_t build) const;

    DB_EDGEVIS_SDK bool SupportsUserConfig();

    DB_EDGEVIS_SDK OpResult GetUserConfig(UserNotificationPreferences& user_config);

    DB_EDGEVIS_SDK OpResult SetUserConfig(UserNotificationPreferences& user_config);
    
    DB_EDGEVIS_SDK bool SupportsEncoderManagerURLs() const;

    DB_EDGEVIS_SDK bool SupportsCamsTemplates() const;

    DB_EDGEVIS_SDK std::wstring GetWebAPIToken() const;

    DB_EDGEVIS_SDK std::wstring UserName() const;

    DB_EDGEVIS_SDK std::wstring UserAccountName() const;

    DB_EDGEVIS_SDK int64_t GetServerClockOffset() const;

    DB_EDGEVIS_SDK int64_t GetTotalBytesSent();

    DB_EDGEVIS_SDK int64_t GetTotalBytesReceived();

    DB_EDGEVIS_SDK void ResetDataUsageStats();

    DB_EDGEVIS_SDK bool SupportsClientSecurityPolicy() const;
    
    DB_EDGEVIS_SDK OpResult QueryClientSecurityPolicy(ClientSecurityPolicy & policy);

    DB_EDGEVIS_SDK OpResult GetClientSecurityPolicy(ClientSecurityPolicy& policy);

    DB_EDGEVIS_SDK void SetLoggingLevel(EdgeVisSDKCore::LoggingLevel level, const std::wstring& log_location);

    DB_EDGEVIS_SDK bool SupportsStreamProfiles() const;
  };
}