Detailed Description
The Server is central to the entire SDK and provides the authenticaion and connection to the Server.
An EdgeVisDecoderSDK::Server is used to make a connection to an EdgeVis server. The Server object is the starting point for management of the EdgeVis server and using Encoder features.
Once you connect your Server 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 EdgeVisDecoder::IServerListener interface. The following events are available
- Server state (Connected, disconnected ect)
- 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
- How do I connect to a Server?
- How do I retrieve a list of Encoders from the Server?
- How do I handle the Server Connection Events?
Availability
Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0
Files | |
| file | MFAVersion.h |
| Specifies the supported MFA protocols. | |
Classes | |
| class | EdgeVisDecoderSDK::ClientSecurityPolicy |
| Describes the client security policy set at the server. More... | |
| class | EdgeVisDecoderSDK::Credentials |
| Holds the server credentials for the user logging in. More... | |
| class | EdgeVisDecoderSDK::IAsset |
| An Asset is a tangible asset on the system such as an Encoder or a Server. More... | |
| class | EdgeVisDecoderSDK::IServerListener |
| The interface for the Server. More... | |
| class | EdgeVisDecoderSDK::MFALoginResponse |
| Holds the result of a time based one time passcode (OTP) login attempt. More... | |
| class | EdgeVisDecoderSDK::PasswordResetInfo |
| Describes the details required for resetting a users password. More... | |
| class | EdgeVisDecoderSDK::Server |
| A Server interface is used to make a connection to an EdgeVis server. More... | |
| class | EdgeVisDecoderSDK::ServerInfo |
| Holds the current status of the server. More... | |
| class | EdgeVisSDKCore::ServerAddresses |
| This stores server addresses that the SDK should use to connect to. More... | |