Detailed Description

A SecureServer interface is used to make an encrypted connection to an EdgeVis server.

The SecureServer object is the starting point for management of the EdgeVis server and using Encoder features.

Once you connect your SecureServer it provides the following features:

The ability to query the Server to discover which Encoders are available (assuming appropriate permissions have been granted for the login credentials used). From this list you can select the required Encoder
Connection Events that relay to the client application the status of the connection to the Server (e.g. the link to the Server has been broken).

Interface

Server and Encoder state changes are available via the IServerListener interface. The following events are available

Server state (Connected, disconnected, etc.)
Encoder state change (When an Encoder goes offline and online)
Server errors

Server Disconnects

The Encoder objects are only valid when the server is connected. If the Server disconnects for whatever reason, a server state change will be sent via the IServerListener::ServerStateChanged(). All Encoder and Stream objects will disconnect and are invalidated.

The Server object will continually try to reconnect. To stop the Server object trying to reconnect, call Disconnect();

On the Server reconnecting after a disconnect/connect cycle. You must requery the Encoders via the QueryEncoders() method. Any Streams that where opened must be reopened by your application.

Examples

Availability

Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0

#include <SecureServer.h>

Public Member Functions
DB_EDGEVIS_SDK	SecureServer (const std::wstring &appName, const std::wstring &appMetadata)
	Constructor for the SecureServer object. More...

virtual DB_EDGEVIS_SDK ServerInfo	QueryServerInfoSecure (const ServerAddresses &hostAddresses)
	Queries the server on a secure connection to obtain its current information. More...

Public Member Functions inherited from EdgeVisDecoderSDK::Server
DB_EDGEVIS_SDK	Server (const std::wstring &appName, const std::wstring &appMetadata)
	Constructor for the Server object. More...

DB_EDGEVIS_SDK void	SetClusterInfoCachingEnabled (bool enabled)
	Enables or disables automatic caching of the server cluster token in a file managed by the SDK. More...

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)
	Connects to an EdgeVis server. More...

DB_EDGEVIS_SDK OpResult	Connect (const ServerAddresses &hostAddresses, const Credentials credentials, ServerAddresses &availableAddresses, ConnectionStrategy connect_strategy, ServerConnectInfo flags=SCI_ASPECT_CORRECT)
	Connects to an EdgeVis server. More...

DB_EDGEVIS_SDK OpResult	Connect (const ServerAddresses &hostAddresses, const Credentials credentials, ServerAddresses &availableAddresses)
	Connects to an EdgeVis server. More...

DB_EDGEVIS_SDK PasswordResetInfo	GetPasswordResetInfo () const
	If a users password must be reset then the limitation for the password can be retrieved and used to ensure the user enters a correct password. More...

DB_EDGEVIS_SDK MFALoginResponse	GetMFALoginResponse () const
	Retrieve the multiple factor login response. More...

DB_EDGEVIS_SDK std::wstring	GetDevicePassword () const
	Retrieve a device password to use when logging in. More...

DB_EDGEVIS_SDK bool	HasCams () const
	Check if this server supports CAMS notifications. More...

DB_EDGEVIS_SDK bool	SupportsClientCamsRuleBuilder () const
	Check if this server supports CAMS rule builder in client applications. More...

DB_EDGEVIS_SDK ServerInfo	QueryServerInfo (const ServerAddresses &hostAddresses)
	Queries the server to obtain its current information. More...

DB_EDGEVIS_SDK OpResult	ValidateCredentials (const ServerAddresses &hostAddresses, const Credentials &credentials, ServerAddresses &availableAddresses)
	Test that the supplied credentials are valid for the given server. More...

DB_EDGEVIS_SDK OpResult	ValidateCredentials (const ServerAddresses &hostAddresses, const std::wstring &username, const std::wstring &password, const std::wstring &new_password, ServerAddresses &availableAddresses)
	Test that the supplied username and password are valid for the given server. More...

DB_EDGEVIS_SDK void	CancelQueryServerInfo ()
	Cancels the query for the ServerInfo. More...

DB_EDGEVIS_SDK void	CancelValidateCredentials ()
	Cancels the query for the Validate Credentials. More...

DB_EDGEVIS_SDK CamsNotificationManager	GetCamsNotificationManager ()
	Retrieve the CAMS notification manager for this server. More...

DB_EDGEVIS_SDK int32_t	GetAvailableLicenses () const
	Returns the number of available licenses on the system. More...

DB_EDGEVIS_SDK void	Disconnect ()
	Disconnects the session from the Server. More...

DB_EDGEVIS_SDK bool	IsConnected () const
	Determines of the Server session is currently connected. More...

DB_EDGEVIS_SDK ServerInfo	GetServerInfo () const
	Returns the current ServerInfo for the connected server. More...

DB_EDGEVIS_SDK OpResult	QueryEncoders (std::vector< Encoder > &result)
	Sends a query to the server to find all the Encoders that the currently connected user has permission to use. More...

DB_EDGEVIS_SDK OpResult	GetEncoders (std::vector< Encoder > &result)
	Returns a list of all available Encoders. More...

DB_EDGEVIS_SDK OpResult	QueryEncoder (Encoder &result, const std::wstring &name)
	Sends a query to the server to obtain information about an encoder that the user has access to. More...

DB_EDGEVIS_SDK OpResult	GetDevices (std::vector< Device > &result) const
	Returns a list of all available Devices. More...

DB_EDGEVIS_SDK OpResult	GetEncodersForDeviceUUID (const std::wstring &deviceUUID, std::vector< Encoder > &result) const
	Returns a list of Encoders available for a particular Device using its UUID. More...

DB_EDGEVIS_SDK OpResult	GetDeviceForEncoderUUID (const std::wstring &encoderUUID, Device &result)
	Returns the parent Device for an Encoder UUID. More...

DB_EDGEVIS_SDK void	RegisterListener (IServerListener *listener)
	Registers the specified listener to be notified when an event associated with the Server happens. More...

DB_EDGEVIS_SDK void	UnregisterListener (IServerListener *listener)
	Removes the specified listener from the set of listeners to be notified about Server. More...

DB_EDGEVIS_SDK void	RegisterEventListener (IServerEventListener *listener)
	Registers the specified listener to be notified when a CAMS notification associated with the Server happens. More...

DB_EDGEVIS_SDK void	UnregisterEventListener (IServerEventListener *listener)
	Removes the specified listener from the set of listeners to be notified about Server CAMS notifications. More...

DB_EDGEVIS_SDK Device	GetDevice (const std::wstring &name) const
	Returns the Device object with the specified name. More...

DB_EDGEVIS_SDK Device	GetDeviceByUUID (const std::wstring &uuid) const
	Returns the Device object with the specified UUID. More...

DB_EDGEVIS_SDK Encoder	GetEncoder (const std::wstring &name) const
	Returns the Encoder object with the specified name. More...

DB_EDGEVIS_SDK Encoder	GetEncoderByUUID (const std::wstring &uuid) const
	Returns the Encoder object with the specified UUID. More...

DB_EDGEVIS_SDK std::wstring	Name () const
	Returns the name of friendly name of the server currently connected to If not connected this will return an empty string. More...

DB_EDGEVIS_SDK std::wstring	Version () const
	Returns the name of version number of the server currently connected to If not connected this will return an empty string. More...

DB_EDGEVIS_SDK std::wstring	UniqueID () const
	Returns the name of Unique ID of the server currently connected to. More...

DB_EDGEVIS_SDK bool	IsAtLeastVersion (int32_t major, int32_t minor, int32_t build) const
	Will check that the server is at least a certain version number. More...

DB_EDGEVIS_SDK bool	SupportsUserConfig ()
	Returns if the server supports user config using the GetUserConfig and SetUserConfig methods. More...

DB_EDGEVIS_SDK OpResult	GetUserConfig (UserNotificationPreferences &user_config)
	Retrieve the current user's notification preferences from the server. More...

DB_EDGEVIS_SDK OpResult	SetUserConfig (UserNotificationPreferences &user_config)
	Update the current user's notification preferences on the server. More...

DB_EDGEVIS_SDK bool	SupportsEncoderManagerURLs () const
	Returns if the server supports encoder manager URLs obtained using the Encoder::GetManagerURL method. More...

DB_EDGEVIS_SDK bool	SupportsCamsTemplates () const
	Returns if the server supports template fields in CAMS rules. More...

DB_EDGEVIS_SDK std::wstring	GetWebAPIToken () const
	Retrieve a new web API token from the Server for the currently logged in user. More...

DB_EDGEVIS_SDK std::wstring	UserName () const
	Returns the name of the current user. More...

DB_EDGEVIS_SDK std::wstring	UserAccountName () const
	Returns the name of the account name for the current user. More...

DB_EDGEVIS_SDK int64_t	GetServerClockOffset () const
	Returns difference in the clock timestamps between the server clock and the clock on the client machine. More...

DB_EDGEVIS_SDK int64_t	GetTotalBytesSent ()
	Returns the current total number of bytes sent on this server. More...

DB_EDGEVIS_SDK int64_t	GetTotalBytesReceived ()
	Returns the current total number of bytes received on this server. More...

DB_EDGEVIS_SDK void	ResetDataUsageStats ()
	Resets the count of the total number of bytes sent and received for this server.

DB_EDGEVIS_SDK bool	SupportsClientSecurityPolicy () const
	Returns if the server supports client security policies. More...

DB_EDGEVIS_SDK OpResult	QueryClientSecurityPolicy (ClientSecurityPolicy &policy)
	Queries the server to obtain the client security policy for the current user. More...

DB_EDGEVIS_SDK OpResult	GetClientSecurityPolicy (ClientSecurityPolicy &policy)
	Gets the cached Client Security Policy object. More...

DB_EDGEVIS_SDK void	SetLoggingLevel (EdgeVisSDKCore::LoggingLevel level, const std::wstring &log_location)
	Set the logging level and log file location. More...

DB_EDGEVIS_SDK bool	SupportsStreamProfiles () const
	Returns if the server supports the new stream profile configuration API for encoders. More...

Additional Inherited Members
Static Public Member Functions inherited from EdgeVisDecoderSDK::Server
static DB_EDGEVIS_SDK std::wstring	ClientVersion ()
	Returns the version of the SDK. More...

Constructor & Destructor Documentation

DB_EDGEVIS_SDK EdgeVisDecoderSDK::SecureServer::SecureServer	(	const std::wstring &	appName,
		const std::wstring &	appMetadata
	)

Constructor for the SecureServer object.

Parameters

appName	A String representing the name of the application. This is used to identify the application to the server session
appMetadata	A String representing MetaData of the application. Can be empty.

Returns: The SecureServer object.

Member Function Documentation

virtual DB_EDGEVIS_SDK ServerInfo EdgeVisDecoderSDK::SecureServer::QueryServerInfoSecure ( const ServerAddresses & hostAddresses )

virtual

Queries the server on a secure connection to obtain its current information.

This will instantiate a connection to the server to retrieve the information such as its name, version, and unique ID.

If a Server connection is already in place then the existing server information will be returned

Parameters

hostAddresses The server to connect to. This is a ServerAddresses object.

Returns: The ServerInfo of the requested server.

Call GetResult() on this to check if the key info was successfully populated. It will contain OR_Success on success.

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

SDKs/EdgeVisDecoderSDK/SecureServer.h