Detailed Description

The interface for the Server.

This is used to receive notifications about changes in state of the Server connection and of the Encoders connected to the Server.

Threads

Care should be taken with threading within the EdgeVis SDK.

Callbacks from the SDK must not be blocked. Any processing resulting in a callback must be passed to a separate thread in your application and the callback complete as soon as possible
Callbacks from the SDK must not call back into the SDK on the same thread. Call back into the SDK on a separate thread.

Availability

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

#include <IServerListener.h>

Public Member Functions
virtual void	ServerStateChanged (ServerLinkState state)=0
	Called when the server's communication link state changes. More...

virtual void	ServerError (ServerLinkError error)=0
	Called when the server has experienced an unrecoverable error. More...

virtual void	EncoderInfoUpdated (EncoderUpdateInfo eventInfo, Encoder encoder)=0
	Called when a Encoder has been updated on the server. More...

virtual void	EncoderConnected (Encoder encoder)=0
	Called when an Encoder has been connected to the server. More...

virtual void	EncoderDisconnected (Encoder encoder)=0
	Called when an Encoder has been disconnected from the server. More...

virtual void	EncoderOverslept (Encoder encoder)=0
	Called when an Encoder has overslept. More...

virtual void	ServerClusterChanged (ServerAddresses serverAddresses)=0
	Called when the server cluster has changed. More...

virtual void	EncoderAdded (Encoder encoder)=0
	Called when the logged in user gains permission to access an encoder. More...

virtual void	EncoderRemoved (std::wstring encoderUUID, std::wstring encoderName)=0
	Called when the logged in user loses permission to access an encoder. More...

virtual void	EncoderNameChanged (std::wstring originalEncoderName, Encoder encoder)=0
	Called when an encoder has been renamed. More...

virtual void	EncoderDetailsChanged (Encoder encoder)=0
	Called when an encoder's details have been changed. More...

virtual void	EncoderPermissionsChanged (Encoder encoder, std::vector< FeatureInfo > features)=0
	Called when the logged in user's permissions to access an encoder have changed. More...

Member Function Documentation

virtual void EdgeVisDecoderSDK::IServerListener::ServerStateChanged ( ServerLinkState state )

pure virtual

Called when the server's communication link state changes.

On an SL_Disconnected all Encoder and Stream objects will be invalidated

Parameters

state A ServerLinkState() object describing the state the server has changed to

virtual void EdgeVisDecoderSDK::IServerListener::ServerError ( ServerLinkError error )

pure virtual

Called when the server has experienced an unrecoverable error.

The client should disconnect from the server on another thread to clear up the session.

Parameters

error A ServerError() object describing the error state the server has changed to

virtual void EdgeVisDecoderSDK::IServerListener::EncoderInfoUpdated	(	EncoderUpdateInfo	eventInfo,
		Encoder	encoder
	)

pure virtual

Called when a Encoder has been updated on the server.

Will return an EncoderUpdateInfo with details of the update

Parameters

eventInfo	A EncoderUpdateInfo detailing the changed
encoder	The Encoder that has been updated

virtual void EdgeVisDecoderSDK::IServerListener::EncoderConnected ( Encoder encoder )

pure virtual

Called when an Encoder has been connected to the server.

Parameters

encoder The Encoder that has connected

virtual void EdgeVisDecoderSDK::IServerListener::EncoderDisconnected ( Encoder encoder )

pure virtual

Called when an Encoder has been disconnected from the server.

When the Encoder is disconnected all of its Stream and Service objects will be invalidated.

Parameters

encoder The Encoder that has disconnected

virtual void EdgeVisDecoderSDK::IServerListener::EncoderOverslept ( Encoder encoder )

pure virtual

Called when an Encoder has overslept.

During the Sleep process of an Encoder it will check-in with the server. If the Encoder misses a check-in it is considered to have over slept.

Parameters

encoder The Encoder that has over slept

virtual void EdgeVisDecoderSDK::IServerListener::ServerClusterChanged ( ServerAddresses serverAddresses )

pure virtual

Called when the server cluster has changed.

The application should store this value

Parameters

serverAddresses The new cluster address string

virtual void EdgeVisDecoderSDK::IServerListener::EncoderAdded ( Encoder encoder )

pure virtual

Called when the logged in user gains permission to access an encoder.

For admin users this is called when an Encoder account has been created on the Server. For non-admin users this is called when permission is granted to access an encoder.

Parameters

encoder The Encoder that the logged in user now has access to

virtual void EdgeVisDecoderSDK::IServerListener::EncoderRemoved	(	std::wstring	encoderUUID,
		std::wstring	encoderName
	)

pure virtual

Called when the logged in user loses permission to access an encoder.

For admin users this is called when an Encoder account has been deleted from the Server. For non-admin users this is called when permission to access an encoder is removed.

Parameters

encoderUUID	The UUID of the encoder that the logged in user no longer has access to
encoderName	The name of the encoder that the logged in user no longer has access to

virtual void EdgeVisDecoderSDK::IServerListener::EncoderNameChanged	(	std::wstring	originalEncoderName,
		Encoder	encoder
	)

pure virtual

Called when an encoder has been renamed.

Parameters

originalEncoderName	The original name of the encoder that has been renamed
encoder	The updated encoder

virtual void EdgeVisDecoderSDK::IServerListener::EncoderDetailsChanged ( Encoder encoder )

pure virtual

Called when an encoder's details have been changed.

This may occur as a result of moving to another domain.

Parameters

encoder The updated encoder

virtual void EdgeVisDecoderSDK::IServerListener::EncoderPermissionsChanged	(	Encoder	encoder,
		std::vector< FeatureInfo >	features
	)

pure virtual

Called when the logged in user's permissions to access an encoder have changed.

Parameters

encoder	The updated encoder
features	The updated features, containing the updated permissions

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

SDKs/EdgeVisDecoderSDK/IServerListener.h

Detailed Description

Threads

Availability

Public Member Functions

Member Function Documentation