SOUND4 IMPACT FM.CL Library [2.0.0]
Loading...
Searching...
No Matches
Functions
Update Management

Manage the process update. More...

Functions

void impactfm_StartUpdateThread (struct impactfm_CInstance *instance, unsigned int port)
 
void impactfm_StopUpdateThread (struct impactfm_CInstance *instance)
 
int impactfm_WaitUpdateThreadReady (struct impactfm_CInstance *instance, int milliseconds)
 

Detailed Description

Manage the process update and communications.

Function Documentation

◆ impactfm_StartUpdateThread()

void impactfm_StartUpdateThread ( struct impactfm_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 impactfm_StopUpdateThread
Parameters
instancethe instance
portthe port to listen for incoming JSON connections. If 0, the JSON server is not accessible

◆ impactfm_StopUpdateThread()

void impactfm_StopUpdateThread ( struct impactfm_CInstance *  instance)

Stop the update thread

Parameters
instancethe processing instance

◆ impactfm_WaitUpdateThreadReady()

int impactfm_WaitUpdateThreadReady ( struct impactfm_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