libimobiledevice  1.3.0
API Documentation - Return to Homepage

◆ heartbeat_receive_with_timeout()

heartbeat_error_t heartbeat_receive_with_timeout ( heartbeat_client_t  client,
plist_t *  plist,
uint32_t  timeout_ms 
)

Receives a plist using the given heartbeat client.

Parameters
clientThe heartbeat client to use for receiving
plistpointer to a plist_t that will point to the received plist upon successful return
timeoutMaximum time in milliseconds to wait for data.
Returns
HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when client or *plist is NULL, HEARTBEAT_E_NOT_ENOUGH_DATA when not enough data received, HEARTBEAT_E_TIMEOUT when the connection times out, HEARTBEAT_E_PLIST_ERROR when the received data cannot be converted to a plist, HEARTBEAT_E_MUX_ERROR when a communication error occurs, or HEARTBEAT_E_UNKNOWN_ERROR when an unspecified error occurs.