Detailed Description

Creates a secure connect service to the remote encoder.

Availability

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

#include <SecureConnectProxyService.h>

Public Member Functions
void	UpdateMaxTransmitRate ()
	Update the maximum bandwidth that SecureConnect may use for sending data to the encoder. More...

DB_EDGEVIS_SDK OpResult	AddProxyEntry (const std::wstring &remoteHost, int32_t remotePort, ESecureConnectSessionDirection direction, const std::wstring &localHost, int32_t localPort, int32_t &serviceId)
	Add a SecureConnect service. More...

DB_EDGEVIS_SDK OpResult	RemoveProxyEntry (int32_t serviceId)
	Remove a SecureConnect service. More...

DB_EDGEVIS_SDK OpResult	RemoveAllProxyEntries ()
	Remove all existing SecureConnect services. More...

DB_EDGEVIS_SDK bool	IsConnected ()
	Determine if the SecureConnect channel is connected. More...

DB_EDGEVIS_SDK bool	RegisterListener (ISecureConnectProxyServiceListener *listener)
	Register a listener with the SecureConnectProxyService. More...

DB_EDGEVIS_SDK bool	UnregisterListener (ISecureConnectProxyServiceListener *listener)
	Unregistered a listener with the SecureConnectProxyService. More...

DB_EDGEVIS_SDK SecureConnectProxyStatus	GetProxyStatus (int32_t serviceId)
	Get the status of a SecureConnect proxy entry. More...

virtual DB_EDGEVIS_SDK OpResult	Start ()
	Start the SecureConnect service. More...

virtual DB_EDGEVIS_SDK OpResult	Stop ()
	Stop the SecureConnect service.

Public Member Functions inherited from EdgeVisDecoderSDK::Stream
DB_EDGEVIS_SDK StreamType	Type () const
	Gets the stream type. More...

DB_EDGEVIS_SDK std::wstring	Name () const
	Gets the stream's name. More...

virtual DB_EDGEVIS_SDK OpResult	SetTransport (TransportType trans)
	This is underlying transport type. More...

virtual DB_EDGEVIS_SDK TransportType	GetTransport ()
	Gets the stream's transport. More...

DB_EDGEVIS_SDK Encoder	GetEncoder () const
	Gets the Encoder object that the Stream is on. More...

DB_EDGEVIS_SDK OpResult	Open ()
	Opens the stream. More...

DB_EDGEVIS_SDK void	Close ()
	Closes this stream. More...

virtual DB_EDGEVIS_SDK bool	IsConnected () const
	Determines if the stream is currently connected (in use). More...

DB_EDGEVIS_SDK void	RegisterListener (IStreamListener *listener)
	Registers the specified listener to be notified when stream data is received. More...

DB_EDGEVIS_SDK void	UnregisterListener (IStreamListener *listener)
	Removes the specified listener from the set of listeners to be notified about incoming stream data. More...

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

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

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

DB_EDGEVIS_SDK int64_t	GetStreamUseDuration () const
	Get the duration in milliseconds that the stream has been open. More...

DB_EDGEVIS_SDK int64_t	GetLastStreamUseDuration () const
	Get the duration in milliseconds that the stream was open on last use. More...

DB_EDGEVIS_SDK void	SetEnableAnalyticsSync (bool enable)
	Enables or disables synchronization of analytics metadata with audio and video Enabled by default, to disable set to false. More...

DB_EDGEVIS_SDK bool	GetEnableAnalyticsSync () const
	Returns true if Analytics Sync is enabled. More...

Public Member Functions inherited from EdgeVisDecoderSDK::Service
DB_EDGEVIS_SDK std::wstring	ServiceName () const
	Gets the name of the Service. More...

void	UpdateState (ServiceState state, std::wstring user)
	Updates the service's state. More...

DB_EDGEVIS_SDK bool	Started () const
	Determines whether the service has been started or not. More...

DB_EDGEVIS_SDK int32_t	KeepAliveInterval () const
	Retrieves the keep alive interval for the service. More...

DB_EDGEVIS_SDK int32_t	IdleTimeoutInterval () const
	Retrieves the idle timeout interval for the service. More...

DB_EDGEVIS_SDK void	SetIdleTimeoutInterval (int32_t idleTimeout)
	Sets the idle timeout interval for the service. More...

DB_EDGEVIS_SDK bool	KeepAliveTaskRunning () const
	Determines if the Keep alive task is currently running. More...

DB_EDGEVIS_SDK bool	IdleTimeoutRunning () const
	Determines if the idle timeout is currently running. More...

DB_EDGEVIS_SDK void	RegisterListener (IServiceListener *listener)
	Registers the specified listener to be notified when the service state changes. More...

DB_EDGEVIS_SDK void	UnregisterListener (IServiceListener *listener)
	Removes the specified listener from the set of listeners to be notified about service state changes. More...

DB_EDGEVIS_SDK int64_t	GetServiceUptime () const
	Retrieve the number of milliseconds since the service was started. More...

Member Function Documentation

void EdgeVisDecoderSDK::SecureConnectProxyService::UpdateMaxTransmitRate ( )

Update the maximum bandwidth that SecureConnect may use for sending data to the encoder.

This will be between 2% and 100% of available bandwidth.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::SecureConnectProxyService::AddProxyEntry	(	const std::wstring &	remoteHost,
		int32_t	remotePort,
		ESecureConnectSessionDirection	direction,
		const std::wstring &	localHost,
		int32_t	localPort,
		int32_t &	serviceId
	)

Add a SecureConnect service.

Typically the values for the remoteHost, remotePort and direction will be available from the list of SecureConnectEndpointConfig objects from the encoder config. When successfully added, the local port shall be mapped to the remote IP address and port. This allows, for example, remote IP camera configuration from a DecoderSDK consumer using connect endpoints, or alarm monitoring using listen endpoints.

Parameters

remoteHost	The IP address of the remote endpoint to connect to.
remotePort	The port of the remote endpoint to connect to.
direction	Specify if this should be a connect or listen session.
localHost	The IP address of the local endpoint, typically 127.0.0.1
localPort	The local port that SecureConnect shall bind to for this session. If the local port is already in use the bind will fail.
serviceId	[out] The service ID assigned if successful.

Returns: OpResult

Potential OpResults Returned

OR_Success
OR_Failed (Failed to establish secure connect session. If problem persists, please contact your System Administrator)
OR_InvalidParams (Failed to establish secure connect session. If problem persists, please contact your System Administrator)
OR_InvalidStream (m_pimpl is nil. Programmer error.)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::SecureConnectProxyService::RemoveProxyEntry ( int32_t serviceId )

Remove a SecureConnect service.

Parameters

serviceId The service ID to be removed.

Returns: OpResult

Potential OpResults Returned

OR_Success
OR_Failed
OR_InvalidStream (m_pimpl is nil. Programmer error.)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::SecureConnectProxyService::RemoveAllProxyEntries ( )

Remove all existing SecureConnect services.

Returns: OpResult

Potential OpResults Returned

OR_Success
OR_Failed
- OR_InvalidStream (m_pimpl is nil. Programmer error.)

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::SecureConnectProxyService::IsConnected ( )

Determine if the SecureConnect channel is connected.

Returns: True if the SecureConnect channel is connected, false otherwise.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::SecureConnectProxyService::RegisterListener ( ISecureConnectProxyServiceListener * listener )

Register a listener with the SecureConnectProxyService.

Returns: True if the listener was registered successfully, false otherwise.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::SecureConnectProxyService::UnregisterListener ( ISecureConnectProxyServiceListener * listener )

Unregistered a listener with the SecureConnectProxyService.

Returns: True if the listener was unregistered successfully, false otherwise.

DB_EDGEVIS_SDK SecureConnectProxyStatus EdgeVisDecoderSDK::SecureConnectProxyService::GetProxyStatus ( int32_t serviceId )

Get the status of a SecureConnect proxy entry.

Parameters

serviceId The service ID we are interested in

Returns: true if service exists, false otherwise

virtual DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::SecureConnectProxyService::Start ( )

virtual

Start the SecureConnect service.

Returns: An OpResult

Potential OpResults Returned

OR_Success
OR_Failed (Unable to establish connection to secure connect proxy service. If problem persists, please contact your System Administrator)
OR_InvalidService (m_pimpl is nil. Programmer error.)

Implements EdgeVisDecoderSDK::Service.

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

SDKs/EdgeVisDecoderSDK/SecureConnectProxyService.h

Detailed Description

Availability

Public Member Functions

Member Function Documentation