3.7.3 IrisClient lifecycle functions

IrisSupportLib defines the following functions to manage its lifecycle:

IrisClient_connect()

int64_t IrisClient_connect(void **iris_client_context_out, const char *hostname, uint16_t port);

Initialises an IrisTcpClient and connects it to an Iris server.

Arguments:

iris_client_context_out
Output argument. The value of *iris_client_context_out is set to the IrisClient context pointer that the server was successfully connected to.
hostname
Hostname of the server to connect to.
port
Server port to connect to.

Return value:

An IrisErrorCode value indicating whether the call was successful.

IrisClient_disconnect()

int64_t IrisClient_disconnect(void *iris_client_context)

Disconnects and destroys an IrisTcpClient. If a client disconnects from the server spontaneously it should still call IrisClient_disconnect() to clean up any state allocated by the IrisTcpClient.

Arguments:

iris_client_context
Context pointer returned by IrisClient.

Return value:

An IrisErrorCode value indicating whether the call was successful.

Non-ConfidentialPDF file icon PDF version101196_0100_03_en
Copyright © 2018, 2019 Arm Limited or its affiliates. All rights reserved.