SOUND4 x1.CLOUD Library [1.5.6]
Loading...
Searching...
No Matches
Functions
Update Management

Manage the process update. More...

Functions

void cloudx1_StartUpdateThread (struct cloudx1_CInstance *instance, unsigned int port)
 
void cloudx1_StopUpdateThread (struct cloudx1_CInstance *instance)
 
int cloudx1_WaitUpdateThreadReady (struct cloudx1_CInstance *instance, int milliseconds)
 

Detailed Description

Manage the process update and communications.

Function Documentation

◆ cloudx1_StartUpdateThread()

void cloudx1_StartUpdateThread ( struct cloudx1_CInstance instance,
unsigned int  port 
)

Update function

This needs to run in a thread, which can have low priority. It will also allow the JSON access via TCP.

Remarks
This function does not return until it is stopped with cloudx1_StopUpdateThread
Parameters
instancethe instance
portthe port to listen for incoming JSON connections. If 0, the JSON server is not accessible

◆ cloudx1_StopUpdateThread()

void cloudx1_StopUpdateThread ( struct cloudx1_CInstance instance)

Stop the update thread

Parameters
instancethe processing instance

◆ cloudx1_WaitUpdateThreadReady()

int cloudx1_WaitUpdateThreadReady ( struct cloudx1_CInstance instance,
int  milliseconds 
)

Wait for the update thread to be ready

Parameters
instancethe processing instance
millisecondsmaximum time to wait in milliseconds
Returns
-1 if timeout waiting for the thread, 0 if OK