4.18.7 instance_ping()

This function has no effect on the instance. It is intended to be a no-op.

It has the following use cases:

  • A dummy operation to simulate keep-alive. To keep the TCP connection open without disturbing the other side of the connection, this function can be called at regular intervals, for example every 7200s. However, it is preferable to use the TCP keep-alive socket options, if available, instead. The ping should be addressed at an instance on the other side, for example the IrisTcpServer instance from a client or the client instance from the IrisTcpServer.
  • Benchmarking. Ping can optionally return a dummy payload, which could, for example, be any or all of the following:

    • Sequence count.
    • Timestamp.
    • Dummy data that is used by a benchmark to measure the transport performance.

Instances that do not support instance_ping() must return E_function_not_supported_by_instance, although instances are encouraged to implement this trivial function.

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