5.23.1 TCP server functions

Describes the following functions:

tcpServer_getPort()

Gets the TCP port number that the Iris server is listening on.

Return value

NumberU64

TCP port number that the server is listening on.

Errors

  • E_server_not_running.

tcpServer_start()

Starts the Iris server listening on a port in the range [minPort to maxPort].

Arguments

maxPort

Type: NumberU64

Maximum port number to listen on.

minPort

Type: NumberU64

Minimum port number to listen on.

Return value

NumberU64

TCP port number that the server is listening on.

Errors

  • E_server_already_running.
  • E_data_size_error.

tcpServer_stop()

Stops the running Iris server. Any instances connected using TCP are automatically unregistered in the process.

Return value

Function has no return value.

Errors

  • E_server_not_running.

service_connect()

Connects to a local or remote Iris service server.

Arguments

hostname

Type: String

Hostname of IrisService to connect to.

port

Type: NumberU64

Port of IrisService to connect to.

Return value

Function does not return a value.

Errors

  • E_already_connected.
  • E_unknown_hostname.
  • E_socket_error.
  • E_not_compatible.
  • E_connection_refused.
  • E_timeout.

service_disconnect()

Disconnects from an already connected Iris service server.

Arguments

hostname

Type: String

Hostname of the service to disconnect from.

port

Type: NumberU64

Port of the service to disconnect from.

Return value

Function does not return a value.

Errors

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