Class for general utils More...

#include <Util.h>

Static Public Member Functions
static std::uint32_t	GetNumberOfConnectedClients (short port)
	Returns the number of currently connected clients. More...

static std::uint32_t	GetNumberOfConnectedClients (std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client > client)
	Returns the number of currently connected clients. More...

static std::uint32_t	GetNumberOfConnectedClients (std::string pipeName)
	Returns the number of currently connected clients. More...

static std::uint32_t	GetNumberOfExecutedDiagServices (short port)
	Returns the total number of all executed DiagServices (complete request and response) of all clients and all ComChannels since starting the DiagManager. More...

static std::uint32_t	GetNumberOfExecutedDiagServices (std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client > client)
	Returns the total number of all executed DiagServices (complete request and response) of all clients and all ComChannels since starting the DiagManager. More...

static std::uint32_t	GetNumberOfExecutedDiagServices (std::string pipeName)
	Returns the total number of all executed DiagServices (complete request and response) of all clients and all ComChannels since starting the DiagManager. More...

static std::uint32_t	GetNumberOfOpenComChannels (short port)
	Returns the number of currently opened ComChannels. More...

static std::uint32_t	GetNumberOfOpenComChannels (std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client > client)
	Returns the number of currently opened ComChannels. More...

static std::uint32_t	GetNumberOfOpenComChannels (std::string pipeName)
	Returns the number of currently opened ComChannels. More...

static bool	IsAlive (const std::string &pipeName)
	Checks, if the server is alive. More...

static bool	IsAlive (unsigned short port)
	Checks, if the server is alive. More...

static void	SetClientName (std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client > client, const std::string &clientName)
	Sets a name for a client More...

static void	SetLicenseKey (const std::string &pipeName, const std::string &licenseKey)
	Sets a valid license key to active DiagManagerServer More...

static void	SetLicenseKey (std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client > client, const std::string &licenseKey)
	Sets a valid license key to active DiagManagerServer More...

static void	SetLicenseKey (unsigned short port, const std::string &licenseKey)
	Sets a valid license key to active DiagManagerServer More...

static void	StopServer (const std::string &pipeName)
	Stops the DiagManager server More...

static void	StopServer (unsigned short port)
	Stops the DiagManager server More...

Detailed Description

Class for general utils

Member Function Documentation

◆ GetNumberOfConnectedClients() [1/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfConnectedClients ( short port )

static

Returns the number of currently connected clients.

Parameters

port	Port number of the DiagManager server e.g. "8888"

◆ GetNumberOfConnectedClients() [2/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfConnectedClients ( std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client > client )

static

Returns the number of currently connected clients.

Parameters

client Client that connected to the DiagManager server, used to get the information.

◆ GetNumberOfConnectedClients() [3/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfConnectedClients ( std::string pipeName )

static

Returns the number of currently connected clients.

Parameters

pipeName Pipe name which the DiagManager listens on

◆ GetNumberOfExecutedDiagServices() [1/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfExecutedDiagServices ( short port )

static

Returns the total number of all executed DiagServices (complete request and response) of all clients and all ComChannels since starting the DiagManager.

Parameters

port	Port number of the DiagManager server e.g. "8888"

◆ GetNumberOfExecutedDiagServices() [2/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfExecutedDiagServices ( std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client > client )

static

Returns the total number of all executed DiagServices (complete request and response) of all clients and all ComChannels since starting the DiagManager.

Parameters

client Client that connected to the DiagManager server, used to get the information.

◆ GetNumberOfExecutedDiagServices() [3/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfExecutedDiagServices ( std::string pipeName )

static

Returns the total number of all executed DiagServices (complete request and response) of all clients and all ComChannels since starting the DiagManager.

Parameters

pipeName Pipe name which the DiagManager listens on

◆ GetNumberOfOpenComChannels() [1/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfOpenComChannels ( short port )

static

Returns the number of currently opened ComChannels.

Parameters

port	Port number of the DiagManager server e.g. "8888"

◆ GetNumberOfOpenComChannels() [2/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfOpenComChannels ( std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client > client )

static

Returns the number of currently opened ComChannels.

Parameters

client Client that connected to the DiagManager server, used to get the information.

◆ GetNumberOfOpenComChannels() [3/3]

static std::uint32_t OpenTestSystem::Otx::DiagManager::SystemApi::Util::GetNumberOfOpenComChannels ( std::string pipeName )

static

Returns the number of currently opened ComChannels.

Parameters

pipeName Pipe name which the DiagManager listens on

◆ IsAlive() [1/2]

static bool OpenTestSystem::Otx::DiagManager::SystemApi::Util::IsAlive ( const std::string & pipeName )

static

Checks, if the server is alive.

Parameters

pipeName Pipe name which the DiagManager listens on

Returns: Returns TRUE if the server is alive, otherwise FALSE. A server is alive, if it has been started and has not yet died.

◆ IsAlive() [2/2]

static bool OpenTestSystem::Otx::DiagManager::SystemApi::Util::IsAlive ( unsigned short port )

static

Checks, if the server is alive.

Parameters

port	Port number of the DiagManager server e.g. "8888"

Returns: Returns TRUE if the server is alive, otherwise FALSE. A server is alive, if it has been started and has not yet died.

◆ SetClientName()

static void OpenTestSystem::Otx::DiagManager::SystemApi::Util::SetClientName	(	std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client >	client,
		const std::string &	clientName
	)

static

Sets a name for a client

Parameters

client	Client, which name is set
clientName	Name of the client. The name should not be longer than 15 characters.

◆ SetLicenseKey() [1/3]

static void OpenTestSystem::Otx::DiagManager::SystemApi::Util::SetLicenseKey	(	const std::string &	pipeName,
		const std::string &	licenseKey
	)

static

Sets a valid license key to active DiagManagerServer

Parameters

pipeName	Pipe name which the DiagManager listens on
licenseKey	License key has the format "XXXX-XXXX-XXXX-XXXX-XXXX".

◆ SetLicenseKey() [2/3]

static void OpenTestSystem::Otx::DiagManager::SystemApi::Util::SetLicenseKey	(	std::shared_ptr< OpenTestSystem::Otx::DiagManager::Client::Client >	client,
		const std::string &	licenseKey
	)

static

Sets a valid license key to active DiagManagerServer

Parameters

client	Client, which sends the request to active DiagManagerServerServer
licenseKey	License key has the format "XXXX-XXXX-XXXX-XXXX-XXXX".

◆ SetLicenseKey() [3/3]

static void OpenTestSystem::Otx::DiagManager::SystemApi::Util::SetLicenseKey	(	unsigned short	port,
		const std::string &	licenseKey
	)

static

Sets a valid license key to active DiagManagerServer

Parameters

port	Port number of the DiagManager server e.g. "8888"
licenseKey	License key has the format "XXXX-XXXX-XXXX-XXXX-XXXX".

◆ StopServer() [1/2]

static void OpenTestSystem::Otx::DiagManager::SystemApi::Util::StopServer ( const std::string & pipeName )

static

Stops the DiagManager server

Parameters

pipeName Pipe name which the DiagManager listens on

◆ StopServer() [2/2]

static void OpenTestSystem::Otx::DiagManager::SystemApi::Util::StopServer ( unsigned short port )

static

Stops the DiagManager server

Parameters

port	Port number of the DiagManager server e.g. "8888"

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

Util.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetNumberOfConnectedClients() [1/3]

◆ GetNumberOfConnectedClients() [2/3]

◆ GetNumberOfConnectedClients() [3/3]

◆ GetNumberOfExecutedDiagServices() [1/3]

◆ GetNumberOfExecutedDiagServices() [2/3]

◆ GetNumberOfExecutedDiagServices() [3/3]

◆ GetNumberOfOpenComChannels() [1/3]

◆ GetNumberOfOpenComChannels() [2/3]

◆ GetNumberOfOpenComChannels() [3/3]

◆ IsAlive() [1/2]

◆ IsAlive() [2/2]

◆ SetClientName()

◆ SetLicenseKey() [1/3]

◆ SetLicenseKey() [2/3]

◆ SetLicenseKey() [3/3]

◆ StopServer() [1/2]

◆ StopServer() [2/2]