diff options
Diffstat (limited to 'docs/ref/api')
| -rw-r--r-- | docs/ref/api/index.md | 4 | ||||
| -rw-r--r-- | docs/ref/api/thr/index.md | 6 | ||||
| -rw-r--r-- | docs/ref/api/util/index.md | 19 |
3 files changed, 19 insertions, 10 deletions
diff --git a/docs/ref/api/index.md b/docs/ref/api/index.md new file mode 100644 index 00000000..6ad8257f --- /dev/null +++ b/docs/ref/api/index.md @@ -0,0 +1,4 @@ +# API + +- [Threading and Synchronization](api/thr/) +- [Utility Functions](api/util/) diff --git a/docs/ref/api/thr/index.md b/docs/ref/api/thr/index.md index 6355cfef..bdd8bef4 100644 --- a/docs/ref/api/thr/index.md +++ b/docs/ref/api/thr/index.md @@ -1,4 +1,8 @@ -# Threading Functions +# Threading and Synchronization + +These interfaces are likely to be useful when implementing concurrent designs. +Furthermore, because NNG itself is based on concurrency, the synchronization primitives +are likely to be useful in callback functions and similar situations. - [nng_cv](nng_cv.md) - [nng_mtx](nng_mtx.md) diff --git a/docs/ref/api/util/index.md b/docs/ref/api/util/index.md index 1f202c0f..cc6ee7e2 100644 --- a/docs/ref/api/util/index.md +++ b/docs/ref/api/util/index.md @@ -2,14 +2,15 @@ This section documents various utility functions that may help with application portability. These are not fundamental to NNG -or Scalability Protocols, but we find them useful for a variety +or Scalability Protocols, but they are likely useful for a variety of other uses. -- [nng_alloc](nng_alloc.md) -- [nng_clock](nng_clock.md) -- [nng_id_map](nng_id_map.md) -- [nng_msleep](nng_msleep.md) -- [nng_random](nng_random.md) -- [nng_strdup](nng_strdup.md) -- [nng_strerror](nng_strerror.md) -- [nng_version](nng_version.md) +- [nng_alloc](nng_alloc.md) --- allocate memory +- [nng_clock](nng_clock.md) --- get time +- [nng_id_map](nng_id_map.md) --- identifier based mapping table +- [nng_msleep](nng_msleep.md) --- sleep milliseconds +- [nng_random](nng_random.md) --- get random number +- [nng_socket_pair](nng_socket_pair.md) --- create a connected pair of BSD sockets +- [nng_strdup](nng_strdup.md) --- duplicate string +- [nng_strerror](nng_strerror.md) --- return an error description +- [nng_version](nng_version.md) --- report library version |