This documentation is for version v1.3.0 of NNG, but the latest released version is v1.8.0. see the documentation for v1.8.0 for the most up-to-date information.


#include <nng/nng.h>
#include <nng/supplemental/util/platform.h>

typedef struct nng_thread nng_thread;

int nng_thread_create(nng_thread **thrp, void (*func)(void *), void *arg);


The nng_thread_create() function creates a single thread of execution, running func with the argument arg. The thread is started immediately. A pointer to the thread object is returned in thrp.

The intention of this program is to facilitate writing parallel programs. Threads created by this program will be based upon the underlying threading mechanism of the system that NNG is running on. This may include use of so-called “green threads” or coroutines.

Using threads created by this function can make it easy to write programs that use simple sequential execution, using functions in the NNG suite that would otherwise normally “block”.

When the thread is no longer needed, the nng_thread_destroy() function should be used to reap it. (This function will block waiting for func to return.)

Thread objects created by this function may not be “real” threads capable of performing blocking I/O operations using normal blocking system calls. If use of blocking system calls is required (not including APIs provided by the NNG library itself of course), then real OS-specific threads should be created instead (such as with pthread_create() or similar functions.)
Thread objects created by this function cannot be passed to any system threading functions.
The system may impose limits on the number of threads that can be created. Typically applications should not create more than a dozen of these. If greater concurrency or scalability is needed, consider instead using an asynchronous model using nng_aio structures.
Threads can be synchronized using mutexes and condition variables.


This function returns 0 on success, and non-zero otherwise.



Insufficient free memory exists.