Public Member Functions
FETPAPI_DLL_IMPORT_OR_EXPORT	InitializationParameters (boost::uuids::uuid instanceUuid, const std::string &etpServerUrl, const std::string &proxyUrl="")

FETPAPI_DLL_IMPORT_OR_EXPORT	InitializationParameters (const std::string &instanceUuid, const std::string &etpServerUrl, const std::string &proxyUrl="")

	InitializationParameters (boost::uuids::uuid instanceUuid, const std::string &host, uint16_t port, const std::string &urlPath="")

	InitializationParameters (const std::string &instanceUuid, const std::string &host, uint16_t port, const std::string &urlPath="")

FETPAPI_DLL_IMPORT_OR_EXPORT void	setMaxWebSocketMessagePayloadSize (uint64_t value)

FETPAPI_DLL_IMPORT_OR_EXPORT uint64_t	getMaxWebSocketMessagePayloadSize () const

FETPAPI_DLL_IMPORT_OR_EXPORT void	setPreferredMaxFrameSize (uint64_t value)

FETPAPI_DLL_IMPORT_OR_EXPORT uint64_t	getPreferredMaxFrameSize () const

FETPAPI_DLL_IMPORT_OR_EXPORT void	setAdditionalHandshakeHeaderFields (const std::map< std::string, std::string > &extraHandshakeHeaderFields)

FETPAPI_DLL_IMPORT_OR_EXPORT const std::map< std::string, std::string > &	getAdditionalHandshakeHeaderFields () const

FETPAPI_DLL_IMPORT_OR_EXPORT void	setAdditionalCertificates (const std::string &extraCertificates)

FETPAPI_DLL_IMPORT_OR_EXPORT const std::string &	getAdditionalCertificates () const

FETPAPI_DLL_IMPORT_OR_EXPORT const boost::uuids::uuid &	getInstanceId () const

FETPAPI_DLL_IMPORT_OR_EXPORT const std::string &	getEtpServerHost () const

FETPAPI_DLL_IMPORT_OR_EXPORT uint16_t	getEtpServerPort () const

FETPAPI_DLL_IMPORT_OR_EXPORT const std::string &	getEtpServerUrlPath () const

FETPAPI_DLL_IMPORT_OR_EXPORT const std::string &	getProxyHost () const

FETPAPI_DLL_IMPORT_OR_EXPORT uint16_t	getProxyPort () const

FETPAPI_DLL_IMPORT_OR_EXPORT void	setForceTls (bool force)

FETPAPI_DLL_IMPORT_OR_EXPORT bool	isTlsForced () const

virtual FETPAPI_DLL_IMPORT_OR_EXPORT std::string	getApplicationName () const

virtual FETPAPI_DLL_IMPORT_OR_EXPORT std::string	getApplicationVersion () const

FETPAPI_DLL_IMPORT_OR_EXPORT std::map< std::string, Energistics::Etp::v12::Datatypes::DataValue >	makeEndpointCapabilities () const

virtual FETPAPI_DLL_IMPORT_OR_EXPORT std::vector< Energistics::Etp::v12::Datatypes::SupportedDataObject >	makeSupportedDataObjects () const

virtual FETPAPI_DLL_IMPORT_OR_EXPORT std::vector< Energistics::Etp::v12::Datatypes::SupportedProtocol >	makeSupportedProtocols () const

virtual FETPAPI_DLL_IMPORT_OR_EXPORT void	postSessionCreationOperation (class AbstractSession *session) const

Constructor & Destructor Documentation

◆ InitializationParameters() [1/4]

FETPAPI_DLL_IMPORT_OR_EXPORT ETP_NS::InitializationParameters::InitializationParameters	(	boost::uuids::uuid	instanceUuid,
		const std::string &	etpServerUrl,
		const std::string &	proxyUrl = "" )

inline

Parameters

instanceUuid	The UUID of the client instance.
etpServerUrl	Must follow the syntax ws://<host>:<port>/<path> or wss://<host>:<port>/<path> or simply <host>:<port>/<path> where port is optional and is defaulted to 80 if scheme is "ws" or if no scheme is provided. In "wss" schema cases, port is defaulted to 443.
proxyUrl	The proxy URL. It must follow the syntax http://<host>:<port> or simply <host>:<port>. Leave it empty if your connection to eptServerUrl is direct and does not pass throughr any proxy.

◆ InitializationParameters() [2/4]

FETPAPI_DLL_IMPORT_OR_EXPORT ETP_NS::InitializationParameters::InitializationParameters	(	const std::string &	instanceUuid,
		const std::string &	etpServerUrl,
		const std::string &	proxyUrl = "" )

inline

Mainly for use with SWIG i.e. boost uuid structure is not easily portable whereas strings are.

Parameters

instanceUuid	The UUID of the client instance.
etpServerUrl	Must follow the syntax ws://<host>:<port>/<path> or wss://<host>:<port>/<path> or simply <host>:<port>/<path> where port is optional and is defaulted to 80 if scheme is "ws" or if no scheme is provided. In "wss" schema cases, port is defaulted to 443.
proxyUrl	The proxy URL. It must follow the syntax http://<host>:<port> or simply <host>:<port>. Leave it empty if your connection to eptServerUrl is direct and does not pass throughr any proxy.

◆ InitializationParameters() [3/4]

ETP_NS::InitializationParameters::InitializationParameters	(	boost::uuids::uuid	instanceUuid,
		const std::string &	host,
		uint16_t	port,
		const std::string &	urlPath = "" )

inline

Only to be used for direct connection to the ETP server URL (not whenpassing through a proxy)

Parameters

instanceUuid	The UUID of the client or server instance.
host	The fully qualified domain name of a network host, or its IP address as a set of four decimal digit groups separated by ".".
port	The port number to connect to.
urlPath	The rest of the locator consists of data specific to the scheme, and is known as the "url-path". It supplies the details of how the specified resource can be accessed. Note that the "/" between the host (or port) and the url-path is NOT part of the url-path.

◆ InitializationParameters() [4/4]

ETP_NS::InitializationParameters::InitializationParameters	(	const std::string &	instanceUuid,
		const std::string &	host,
		uint16_t	port,
		const std::string &	urlPath = "" )

inline

Only to be used for direct connection to the ETP server URL (not whenpassing through a proxy) Mainly for use with SWIG i.e. boost uuid structure is not easily portable whereas strings are.

Parameters

instanceUuid	The UUID of the client or server instance.
host	The fully qualified domain name of a network host, or its IP address as a set of four decimal digit groups separated by ".".
port	The port number to connect to.
urlPath	The rest of the locator consists of data specific to the scheme, and is known as the "url-path". It supplies the details of how the specified resource can be accessed. Note that the "/" between the host (or port) and the url-path is NOT part of the url-path.

Member Function Documentation

◆ postSessionCreationOperation()

virtual FETPAPI_DLL_IMPORT_OR_EXPORT void ETP_NS::InitializationParameters::postSessionCreationOperation ( class AbstractSession * session ) const

virtual

Override this method in order to register some dedicated protocol handlers for a session.

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

C:/Users/philippe/dev/fetpapiEnv/fetpapi-dev/src/etp/InitializationParameters.h

Public Member Functions

Constructor & Destructor Documentation

◆ InitializationParameters() [1/4]

◆ InitializationParameters() [2/4]

◆ InitializationParameters() [3/4]

◆ InitializationParameters() [4/4]

Member Function Documentation

◆ postSessionCreationOperation()