Collaboration diagram for Structs, Types, ...:

Macros
#define	MLPI_CONNECT_IDENT_LENGTH (1024)

#define	MLPI_DEFAULTPORT (5300)

#define	MLPI_DEFAULTSECUREPORT (5335)

#define	MLPI_INFINITE (0xFFFFFFFF)

#define	MLPI_TIMEOUT_OS (0)

#define	MLPI_MAX_PAYLOAD (500000)

#define	MLPI_API_CONNECTION_NAME_LEN (128)

#define	MLPI_API_CONNECTION_URI_LEN (128)

#define	MLPI_API_CONNECTION_LABEL_LEN (254)

#define	MLPI_API_CONNECTION_USER_LEN (128)

#define	MLPI_API_CONNECTION_PWD_LEN (128)

#define	MLPI_API_LIBRARY_NAME_LEN (64)

#define	MLPI_API_MAX_NUMBER_OF_CONNECTIONS (50)

Typedefs
typedef struct MlpiConnectionInfo	MlpiConnectionInfo

typedef struct MlpiConnectionDescription	MlpiConnectionDescription

typedef struct MlpiLibrary	MlpiLibrary

Enumerations

Variables
static const WCHAR16	MLPI_LOCALHOST [] = {'L','O','C','A','L','H','O','S','T', '\0'}

static const WCHAR16	MLPI_ACCOUNT_EMPTY_NAME [] = {'_','A','C','C','O','U','N','T','_','E','M','P','T','Y','_','N','A','M','E','_','\0'}

Detailed Description

List of used types, enumerations, structures and more...

Macro Definition Documentation

#define MLPI_CONNECT_IDENT_LENGTH (1024)

Length of connect ident string mlpiApiConnect.

Definition at line 253 of file mlpiApiLib.h.

#define MLPI_DEFAULTPORT (5300)

Default IP port when connecting over tcp back end.

Definition at line 254 of file mlpiApiLib.h.

#define MLPI_DEFAULTSECUREPORT (5335)

Default IP port when connecting over tls back end.

Definition at line 255 of file mlpiApiLib.h.

#define MLPI_INFINITE (0xFFFFFFFF)

Infinite timeout value.

Definition at line 256 of file mlpiApiLib.h.

#define MLPI_TIMEOUT_OS (0)

Use timeout values as chosen by the operating system (default).

Definition at line 257 of file mlpiApiLib.h.

#define MLPI_MAX_PAYLOAD (500000)

Maximum total payload in bytes of MLPI function with all of its arguments.

Definition at line 258 of file mlpiApiLib.h.

#define MLPI_API_CONNECTION_NAME_LEN (128)

Length of user-defined name of connection.

Definition at line 260 of file mlpiApiLib.h.

#define MLPI_API_CONNECTION_URI_LEN (128)

Length of URI of connection.

Definition at line 261 of file mlpiApiLib.h.

#define MLPI_API_CONNECTION_LABEL_LEN (254)

Length of user-defined label of connection.

Definition at line 262 of file mlpiApiLib.h.

#define MLPI_API_CONNECTION_USER_LEN (128)

Length of login user name of connection.

Definition at line 263 of file mlpiApiLib.h.

#define MLPI_API_CONNECTION_PWD_LEN (128)

Length of login user password of connection.

Definition at line 264 of file mlpiApiLib.h.

#define MLPI_API_LIBRARY_NAME_LEN (64)

Length of library name.

Definition at line 266 of file mlpiApiLib.h.

#define MLPI_API_MAX_NUMBER_OF_CONNECTIONS (50)

Maximum number of concurrent connections.

Definition at line 268 of file mlpiApiLib.h.

Typedef Documentation

MlpiConnectionInfo

This structure is used by the function mlpiApiTestConnection to return the results of the timing measurements.

Elements of struct MlpiConnectionInfo

Type	Element	Description
DOUBLE	minimum	Minimum time duration of all measurements in microseconds.
DOUBLE	maximum	Maximum time duration of all measurements in microseconds.
DOUBLE	average	Average time duration of all measurements in microseconds.
DOUBLE	variance	Variance of all measurements in square microseconds.
DOUBLE	standardDeviation	Standard deviation of all measurements in microseconds.

MlpiConnectionDescription

This structure is used by the functions mlpiApiGetOwnConnectionDescription and mlpiApiGetAllConnectionDescription to return information about the connections.

Elements of struct MlpiConnectionDescription

Type	Element	Description
ULLONG	uid	Unique identifier of connection.
WCHAR16	user	Login user name of connection.
WCHAR16	uri	URI of client of connection (e.g. "mlpi.tcp://'IP-address':'port'").
WCHAR16	name	User-defined name of connection.
WCHAR16	label	User-defined label of connection.
MlpiDateAndTime	dateTime	Buildup system date and time (broken down time, UTC) of connection.
ULONG	requestCounter	Absolute number of requests.
ULONG	lastRequest	Elapsed time since last access in milliseconds.
MlpiApiProtection	protection	Protection status of connection.
ULONG	watchdog	Watchdog status of connection (==1 if watchdog is active (enabled and not fired)).

MlpiLibrary

This structure is used by the function mlpiApiGetLibrarySupport to return information about available libraries.

Elements of struct MlpiLibrary

Type	Element	Description
WCHAR16	name	Name of MLPI library.
ULONG	id	ID of MLPI library.

Enumeration Type Documentation

enum MlpiApiProtection

This enumeration defines the protection levels of a connection.

Enumerator
MLPI_API_PROTECTION_NON	The connection is not protected and can be closed by an other connection.
MLPI_API_PROTECTION_WATCHDOG	The connection is protected against closing by an other connection if the connection watchdog is active (enabled and not fired).
MLPI_API_PROTECTION_COMPLETE	The connection is protected against closing by an other connection completely.

Definition at line 279 of file mlpiApiLib.h.

Variable Documentation

const WCHAR16 MLPI_LOCALHOST[] = {'L','O','C','A','L','H','O','S','T', '\0'}

static

String for local host connection when client application and target are on the same device.

Definition at line 270 of file mlpiApiLib.h.

const WCHAR16 MLPI_ACCOUNT_EMPTY_NAME[] = {'_','A','C','C','O','U','N','T','_','E','M','P','T','Y','_','N','A','M','E','_','\0'}

static

Surrogate string of account with empty name defined in account manifest 'accounts.xml'.

Definition at line 271 of file mlpiApiLib.h.

Macros