Update Management

Manage the process update. More...

Functions
void	bigvoice_StartUpdateThread (struct bigvoice_CInstance *instance, unsigned int port)
void	bigvoice_StopUpdateThread (struct bigvoice_CInstance *instance)
int	bigvoice_WaitUpdateThreadReady (struct bigvoice_CInstance *instance, int milliseconds)

Detailed Description

Manage the process update and communications.

Function Documentation

bigvoice_StartUpdateThread()

void bigvoice_StartUpdateThread	(	struct bigvoice_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 bigvoice_StopUpdateThread

Parameters

instance	the instance
port	the port to listen for incoming JSON connections. If 0, the JSON server is not accessible

bigvoice_StopUpdateThread()

void bigvoice_StopUpdateThread

(

struct bigvoice_CInstance *

instance

)

Stop the update thread

Parameters

instance

the processing instance

bigvoice_WaitUpdateThreadReady()

int bigvoice_WaitUpdateThreadReady	(	struct bigvoice_CInstance *	instance,
		int	milliseconds
	)

Wait for the update thread to be ready

Parameters

instance	the processing instance
milliseconds	maximum time to wait in milliseconds

Returns

-1 if timeout waiting for the thread, 0 if OK