IMR_AddClient

This function adds a client to the library internal client list.

Function Header

IMRResult IMR_AddClient(

ClientType type,

char *ip,

GUIDType guid,

ClientID *id

);

Function Parameters

Field

Input/Output

Value or Description

type

Input

The type of client to be added. Can be one of: CLI_TCP (for a non-secure client) or CLI_TLS (for a secure client).

ip

Input

A pointer to a NULL-terminated string holding either the client’s IP address in numbers and dots notation or a valid hostname. The IP address must not be used by another client that was already added to the library. This parameter must not be NULL.

guid

Input

The client’s Global Unique ID. This parameter may be NULL, in which case the default GUID value (all bytes set to 0) will be stored for the client.

id

Output

A pointer to a ClientID variable that will be filled by the library with a handle for the newly added client. This handle should be used in all future interactions with the client via the library. This parameter must not be NULL.

Function Return Status

For a complete list of possible error codes, see Error Codes.

Status

Value or Description

IMR_RES_OK

The command finished successfully.

IMR_RES_DUPLICATE_CLIENT

A client with the specified properties (e.g. IP address) already exists in the library’s list.

Copyright © 2006-2022, Intel Corporation. All rights reserved.