thread.h File Reference

#include <mupnp/typedef.h>
#include <mupnp/util/list.h>
#include <mupnp/util/cond.h>
#include <mupnp/util/time.h>
#include <pthread.h>
#include <signal.h>

Data Structures
struct	_mUpnpThread
	The generic wrapper struct for mUPnP's threads. More...

Macros
#define	MUPNP_THREAD_MIN_SLEEP   1000
#define	mupnp_thread_next(thread)
#define	mupnp_thread_remove(thread)
#define	mupnp_threadlist_clear(threadList)
#define	mupnp_threadlist_size(threadList)
#define	mupnp_threadlist_gets(threadList)
#define	mupnp_threadlist_add(threadList, thread)
#define	mupnp_threadlist_remove(thread)

Typedefs
typedef struct _mUpnpThread	mUpnpThread
	The generic wrapper struct for mUPnP's threads.
typedef struct _mUpnpThread	mUpnpThreadList
typedef void(*	MUPNP_THREAD_FUNC) (mUpnpThread *)

Functions
mUpnpThread *	mupnp_thread_new (void)
mUpnpThread *	mupnp_thread_self (void)
bool	mupnp_thread_delete (mUpnpThread *thread)
bool	mupnp_thread_start (mUpnpThread *thread)
bool	mupnp_thread_stop (mUpnpThread *thread)
bool	mupnp_thread_stop_with_cond (mUpnpThread *thread, mUpnpCond *cond)
bool	mupnp_thread_restart (mUpnpThread *thread)
bool	mupnp_thread_isrunnable (mUpnpThread *thread)
void	mupnp_thread_setaction (mUpnpThread *thread, MUPNP_THREAD_FUNC actionFunc)
void	mupnp_thread_setuserdata (mUpnpThread *thread, void *data)
void *	mupnp_thread_getuserdata (mUpnpThread *thread)
mUpnpThreadList *	mupnp_threadlist_new (void)
void	mupnp_threadlist_delete (mUpnpThreadList *threadList)
bool	mupnp_threadlist_start (mUpnpThreadList *threadList)
bool	mupnp_threadlist_stop (mUpnpThreadList *threadList)

Macro Definition Documentation

MUPNP_THREAD_MIN_SLEEP

#define MUPNP_THREAD_MIN_SLEEP   1000

mupnp_thread_next

#define mupnp_thread_next

(

thread

)

Value:

(mUpnpThread*) mupnp_list_next((mUpnpList*)thread)

mupnp_thread_remove

#define mupnp_thread_remove

(

thread

)

Value:

mupnp_list_remove((mUpnpList*)thread)

mupnp_threadlist_add

#define mupnp_threadlist_add	(		threadList,
			thread )

Value:

mupnp_list_add((mUpnpList*)threadList, (mUpnpList*)thread)

Add a thread into a thread list

Parameters

threadList	The thread list in question
thread	The thread to add to the list

mupnp_threadlist_clear

#define mupnp_threadlist_clear

(

threadList

)

Value:

mupnp_list_clear((mUpnpList*)threadList, (MUPNP_LIST_DESTRUCTORFUNC)mupnp_thread_delete)

Clear the contents of a thread list

Parameters

threadList

Thread list in question

mupnp_threadlist_gets

#define mupnp_threadlist_gets

(

threadList

)

Value:

(mUpnpThread*) mupnp_list_next((mUpnpList*)threadList)

Get the first actual item from a thread list to use as an iterator

Parameters

threadList

The thread list in question

mupnp_threadlist_remove

#define mupnp_threadlist_remove

(

thread

)

Value:

mupnp_list_remove((mUpnpList*)thread)

Remove a thread from thread list

Parameters

threadList	The thread list in question
thread	The thread to be removed

mupnp_threadlist_size

#define mupnp_threadlist_size

(

threadList

)

Value:

mupnp_list_size((mUpnpList*)threadList)

Get the size of a thread list

Parameters

threadList

The thread list in question

Typedef Documentation

MUPNP_THREAD_FUNC

typedef void(* MUPNP_THREAD_FUNC) (mUpnpThread *)

Prototype for the threads' worker functions

mUpnpThread

typedef struct _mUpnpThread mUpnpThread

The generic wrapper struct for mUPnP's threads.

This wrapper has been created to enable 100% code compatibility between different platforms (Linux, Win32 etc..)

mUpnpThreadList

typedef struct _mUpnpThread mUpnpThreadList

Function Documentation

mupnp_thread_delete()

bool mupnp_thread_delete

(

mUpnpThread *

thread

)

Stop and destroy a thread.

Parameters

thread

Thread to destroy

mupnp_thread_getuserdata()

void * mupnp_thread_getuserdata

(

mUpnpThread *

thread

)

Get the user data pointer

Parameters

thread

Thread from which to get the pointer

mupnp_thread_isrunnable()

bool mupnp_thread_isrunnable

(

mUpnpThread *

thread

)

Check if a thread has been started

Parameters

thread

Thread to check

mupnp_thread_new()

mUpnpThread * mupnp_thread_new

(

void

)

Create a new thread

mupnp_thread_restart()

bool mupnp_thread_restart

(

mUpnpThread *

thread

)

Restart a thread. Essentially calls mupnp_thread_stop() and mupnp_thread_start()

Parameters

thread

Thread to restart

mupnp_thread_self()

mUpnpThread * mupnp_thread_self

(

void

)

Get a self reference to thread.

mupnp_thread_setaction()

void mupnp_thread_setaction	(	mUpnpThread *	thread,
		MUPNP_THREAD_FUNC	actionFunc )

Set the thread's worker function.

Parameters

thread	Thread struct
actionFunc	Function pointer to set as the worker function

mupnp_thread_setuserdata()

void mupnp_thread_setuserdata	(	mUpnpThread *	thread,
		void *	data )

Set the user data pointer

Parameters

thread	Thread struct
data	Pointer to user data

mupnp_thread_start()

bool mupnp_thread_start

(

mUpnpThread *

thread

)

Start a thread (must be created first with ch_thread_new())

Parameters

thread

Thread to start

mupnp_thread_stop()

bool mupnp_thread_stop

(

mUpnpThread *

thread

)

Stop a running thread.

Parameters

thread

Thread to stop

mupnp_thread_stop_with_cond()

bool mupnp_thread_stop_with_cond	(	mUpnpThread *	thread,
		mUpnpCond *	cond )

Stop the running thread and signal the given CGCond.

mupnp_threadlist_delete()

void mupnp_threadlist_delete

(

mUpnpThreadList *

threadList

)

Destroy a thread list

Parameters

threadList

The thread list in question

mupnp_threadlist_new()

mUpnpThreadList * mupnp_threadlist_new

(

void

)

Create a new thread list

Returns

Thread list

mupnp_threadlist_start()

bool mupnp_threadlist_start

(

mUpnpThreadList *

threadList

)

Start all threads in the thread list

Parameters

threadList

The thread list in question

mupnp_threadlist_stop()

bool mupnp_threadlist_stop

(

mUpnpThreadList *

threadList

)

Stop all threads in the thread list

Parameters

threadList

The thread list in question