Struct IAppConnections#

Inheritance Relationships#

Derived Type#

Struct Documentation#

struct IAppConnections#

Application connections.

Remark

The interface is only available in maintenance mode.

Subclassed by CAppSettings

Public Functions

virtual sdv::sequence<sdv::u8string> GetListeners() const = 0#

Get a sequence with listener names.

Returns:

Sequence with listener name strings.

virtual sdv::u8string GetListenerConfig(const sdv::u8string &ssName) const = 0#

Get the listener configuration.

Parameters:

ssName – [in] Name of the listener.

Returns:

String containing the listener configuration.

virtual bool AddListenerConfig(const sdv::u8string &ssName, const sdv::u8string &ssConfig) = 0#

Add or update a listener configuration.

Parameters:

  • ssName – [in] Name of the listener configuration.

  • ssConfig – [in] The configuration string for the listener.

Returns:

Returns whether the listener could be added.

virtual bool RemoveListenerConfig(const sdv::u8string &ssName) = 0#

Remove a listener configuration with the provided name.

Parameters:

ssName – [in] Name of the listener configuration.

Returns:

Returns whether the removal was successful.

virtual sdv::sequence<sdv::u8string> GetConnections() const = 0#

Get a sequence with connection names.

Returns:

Sequence with name strings.

virtual sdv::u8string GetConnectionConfig(const sdv::u8string &ssName) const = 0#

Get the connection configuration.

Parameters:

ssName – [in] Name of the connection.

Returns:

String containing the connection configuration.

virtual bool AddConnectionConfig(const sdv::u8string &ssName, const sdv::u8string &ssConfig, const sdv::u8string &ssInsertBefore) = 0#

Add or update a connection configuration.

Parameters:

  • ssName – [in] Name of the connection configuration.

  • ssConfig – [in] The configuration string for the connection.

  • ssInsertBefore – [in] Reference to the string to connection to insert the the new connection before, or empty when the the new connection should be placed at the end.

Returns:

Returns whether the connection could be added (fails when the connection already exists).

virtual bool RemoveConnectionConfig(const sdv::u8string &ssName) = 0#

Remove a connection configuration with the provided name.

Parameters:

ssName – [in] Name of the connection configuration.

Returns:

Returns whether the removal was successful.

virtual uint32_t GetConnectRetries() const = 0#

Return the number of retries to establish a connection.

Returns:

Number of retries.

sequence<u8string> GetListeners() const

Get a sequence with listener names.

Returns:

Sequence with listener name strings.

u8string GetListenerConfig (in u8string ssName) const

Get the listener configuration.

Parameters:

ssName – [in] Name of the listener.

Returns:

String containing the listener configuration.

boolean AddListenerConfig (in u8string ssName, in u8string ssConfig)

Add or update a listener configuration.

Parameters:

  • ssName – [in] Name of the listener configuration.

  • ssConfig – [in] The configuration string for the listener.

Returns:

Returns whether the listener could be added.

boolean RemoveListenerConfig (in u8string ssName)

Remove a listener configuration with the provided name.

Parameters:

ssName – [in] Name of the listener configuration.

Returns:

Returns whether the removal was successful.

sequence<u8string> GetConnections() const

Get a sequence with connection names.

Returns:

Sequence with name strings.

u8string GetConnectionConfig (in u8string ssName) const

Get the connection configuration.

Parameters:

ssName – [in] Name of the connection.

Returns:

String containing the connection configuration.

boolean AddConnectionConfig (in u8string ssName, in u8string ssConfig, in u8string ssInsertBefore)

Add or update a connection configuration.

Parameters:

  • ssName – [in] Name of the connection configuration.

  • ssConfig – [in] The configuration string for the connection.

  • ssInsertBefore – [in] Reference to the string to connection to insert the the new connection before, or empty when the the new connection should be placed at the end.

Returns:

Returns whether the connection could be added (fails when the connection already exists).

boolean RemoveConnectionConfig (in u8string ssName)

Remove a connection configuration with the provided name.

Parameters:

ssName – [in] Name of the connection configuration.

Returns:

Returns whether the removal was successful.

uint32 GetConnectRetries() const

Return the number of retries to establish a connection.

Returns:

Number of retries.

Public Static Attributes

static constexpr ::sdv::interface_id _id = 0x275EE38B82B70F14#

Interface ID.