OTX-Runtime for DotNet  
OpenTestSystem.Otx.DiagManager.SystemApi.Util Class Reference

Class for general utils More...

Static Public Member Functions

static uint GetNumberOfConnectedClients (IClient client)
 Returns the number of currently connected clients. More...
 
static uint GetNumberOfConnectedClients (string pipeName)
 Returns the number of currently connected clients. More...
 
static uint GetNumberOfConnectedClients (ushort port)
 Returns the number of currently connected clients. More...
 
static uint GetNumberOfExecutedDiagServices (IClient 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 uint GetNumberOfExecutedDiagServices (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 uint GetNumberOfExecutedDiagServices (ushort 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 uint GetNumberOfOpenComChannels (IClient client)
 Returns the number of currently opened ComChannels. More...
 
static uint GetNumberOfOpenComChannels (string pipeName)
 Returns the number of currently opened ComChannels. More...
 
static uint GetNumberOfOpenComChannels (ushort port)
 Returns the number of currently opened ComChannels. More...
 
static bool IsAlive (string pipeName)
 Checks, if the server is alive. More...
 
static bool IsAlive (ushort port)
 Checks, if the server is alive. More...
 
static void SetClientName (IClient client, string clientName)
 Sets a name for a client More...
 
static void SetLicenseKey (IClient client, string licenseKey)
 Sets a valid license key to active DiagManagerServer More...
 
static void SetLicenseKey (string pipeName, string licenseKey)
 Sets a valid license key to active DiagManagerServer More...
 
static void SetLicenseKey (ushort port, string licenseKey)
 Sets a valid license key to active DiagManagerServer More...
 
static void StopServer (string pipeName)
 Stops the DiagManager server More...
 
static void StopServer (ushort port)
 Stops the DiagManager server More...
 

Detailed Description

Class for general utils

Member Function Documentation

◆ GetNumberOfConnectedClients() [1/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfConnectedClients ( IClient  client)
inlinestatic

Returns the number of currently connected clients.

Parameters
clientClient that connected to the DiagManager server, used to get the information.

◆ GetNumberOfConnectedClients() [2/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfConnectedClients ( string  pipeName)
inlinestatic

Returns the number of currently connected clients.

Parameters
pipeNameThe pipe name the server.

◆ GetNumberOfConnectedClients() [3/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfConnectedClients ( ushort  port)
inlinestatic

Returns the number of currently connected clients.

Parameters
portThe port of the server.

◆ GetNumberOfExecutedDiagServices() [1/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfExecutedDiagServices ( IClient  client)
inlinestatic

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

Parameters
clientClient that connected to the DiagManager server, used to get the information.

◆ GetNumberOfExecutedDiagServices() [2/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfExecutedDiagServices ( string  pipeName)
inlinestatic

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

Parameters
pipeNameThe pipe name the server.

◆ GetNumberOfExecutedDiagServices() [3/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfExecutedDiagServices ( ushort  port)
inlinestatic

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

Parameters
portThe port of the server.

◆ GetNumberOfOpenComChannels() [1/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfOpenComChannels ( IClient  client)
inlinestatic

Returns the number of currently opened ComChannels.

Parameters
clientClient that connected to the DiagManager server, used to get the information.

◆ GetNumberOfOpenComChannels() [2/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfOpenComChannels ( string  pipeName)
inlinestatic

Returns the number of currently opened ComChannels.

Parameters
pipeNameThe pipe name the server.

◆ GetNumberOfOpenComChannels() [3/3]

static uint OpenTestSystem.Otx.DiagManager.SystemApi.Util.GetNumberOfOpenComChannels ( ushort  port)
inlinestatic

Returns the number of currently opened ComChannels.

Parameters
portThe port of the server.

◆ IsAlive() [1/2]

static bool OpenTestSystem.Otx.DiagManager.SystemApi.Util.IsAlive ( string  pipeName)
inlinestatic

Checks, if the server is alive.

Parameters
pipeNamePipe 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 ( ushort  port)
inlinestatic

Checks, if the server is alive.

Parameters
portPort 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 ( IClient  client,
string  clientName 
)
inlinestatic

Sets a name for a client

Parameters
clientClient, which name is set
clientNameName of the client. The name should not be longer than 15 characters.

◆ SetLicenseKey() [1/3]

static void OpenTestSystem.Otx.DiagManager.SystemApi.Util.SetLicenseKey ( IClient  client,
string  licenseKey 
)
inlinestatic

Sets a valid license key to active DiagManagerServer

The license key has the format "XXXX-XXXX-XXXX-XXXX-XXXX". A valid license key must be available. Please ask the software supplier.

Parameters
clientClient, which sends the request to active DiagManagerServerServer
licenseKeyLicense key has the format "XXXX-XXXX-XXXX-XXXX-XXXX".

◆ SetLicenseKey() [2/3]

static void OpenTestSystem.Otx.DiagManager.SystemApi.Util.SetLicenseKey ( string  pipeName,
string  licenseKey 
)
inlinestatic

Sets a valid license key to active DiagManagerServer

The license key has the format "XXXX-XXXX-XXXX-XXXX-XXXX". A valid license key must be available. Please ask the software supplier.

Parameters
pipeNamePipe name which the DiagManager listens on
licenseKeyLicense key has the format "XXXX-XXXX-XXXX-XXXX-XXXX".

◆ SetLicenseKey() [3/3]

static void OpenTestSystem.Otx.DiagManager.SystemApi.Util.SetLicenseKey ( ushort  port,
string  licenseKey 
)
inlinestatic

Sets a valid license key to active DiagManagerServer

The license key has the format "XXXX-XXXX-XXXX-XXXX-XXXX". A valid license key must be available. Please ask the software supplier.

Parameters
portPort number of the DiagManager server e.g. "8888"
licenseKeyLicense key has the format "XXXX-XXXX-XXXX-XXXX-XXXX".

◆ StopServer() [1/2]

static void OpenTestSystem.Otx.DiagManager.SystemApi.Util.StopServer ( string  pipeName)
inlinestatic

Stops the DiagManager server

Parameters
pipeNamePipe name which the DiagManager listens on

◆ StopServer() [2/2]

static void OpenTestSystem.Otx.DiagManager.SystemApi.Util.StopServer ( ushort  port)
inlinestatic

Stops the DiagManager server

Parameters
portPort number of the DiagManager server e.g. "8888"

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