Detailed Description
This stores server addresses that the SDK should use to connect to.
The should be passed in as part of the connect method. Once connected this object will be updated with the available servers. This should be retained by the client for the next time it connects.
- Note
- The default port numbers for EdgeVis servers are
- 9300 for non secure connection
- 9301 for a secure connection (Secure connection is only available with the SecureEncoder SDK)
Storing this object
To simplify storing of this object it can be converted to a string for easy storage by the client. This string can then be used to recreate the object.
Availability
Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0
#include <ServerAddresses.h>
Public Member Functions | |
| DB_EDGEVIS_SDK | ServerAddresses (const std::wstring &address, int32_t port, bool secure) |
| Returns a server address object. More... | |
| DB_EDGEVIS_SDK | ServerAddresses (const std::wstring &address, bool secure) |
| Returns a server address object. More... | |
| DB_EDGEVIS_SDK | ServerAddresses (const std::wstring &addresses) |
| Returns a server address object by passing in a serialised string. More... | |
| DB_EDGEVIS_SDK std::wstring | ToString () const |
| Converts the Addresses object to a string token. More... | |
Constructor & Destructor Documentation
| DB_EDGEVIS_SDK EdgeVisSDKCore::ServerAddresses::ServerAddresses | ( | const std::wstring & | address, |
| int32_t | port, | ||
| bool | secure | ||
| ) |
Returns a server address object.
This is used in the Server::Connect method.
- Parameters
-
address The domain name or IP address of the Server to connect to. This should not include the port. port The port on the server to connect to. The default ports are: - 9300 for a non secure
- 9301 for a secure connection (Secure connection is only available with the SecureEncoder SDK)
secure Using a secure connection. Ensure the correct port number is used
| DB_EDGEVIS_SDK EdgeVisSDKCore::ServerAddresses::ServerAddresses | ( | const std::wstring & | address, |
| bool | secure | ||
| ) |
Returns a server address object.
This is used in the Server::Connect method.
- Parameters
-
address The domain name or IP address of the Server to connect to This. should not include the port. secure using a secure connection, where the default ports will be used.
| DB_EDGEVIS_SDK EdgeVisSDKCore::ServerAddresses::ServerAddresses | ( | const std::wstring & | addresses | ) |
Returns a server address object by passing in a serialised string.
To get a serialised string use the ToString method.
- Parameters
-
addresses A serialised string representation of a server addresses object
Member Function Documentation
| DB_EDGEVIS_SDK std::wstring EdgeVisSDKCore::ServerAddresses::ToString | ( | ) | const |
Converts the Addresses object to a string token.
This can be used to store locally on the client. Use the ServerAddresses(string stringToken) method to convert back to an object.
- Returns
- A string representation of the object
The documentation for this class was generated from the following file:
- SDKs/EdgeVisSDKCore/ServerAddresses.h