diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-20 22:33:02 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-20 22:33:02 -0700 |
| commit | d05ff4934e57c55841a12a41eea41934267150ae (patch) | |
| tree | 3bbbf5cf16f8a2ec51d9db7e97f2e183858cc15a /docs | |
| parent | e4e85293cfa0e359b50cd2b57ca0c476632e0c22 (diff) | |
| download | nng-d05ff4934e57c55841a12a41eea41934267150ae.tar.gz nng-d05ff4934e57c55841a12a41eea41934267150ae.tar.bz2 nng-d05ff4934e57c55841a12a41eea41934267150ae.zip | |
docs: fix clock cross references
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/SUMMARY.md | 3 | ||||
| -rw-r--r-- | docs/ref/api/stats.md | 4 | ||||
| -rw-r--r-- | docs/ref/api/synch.md | 22 |
3 files changed, 13 insertions, 16 deletions
diff --git a/docs/ref/SUMMARY.md b/docs/ref/SUMMARY.md index 34319fa8..9aee312b 100644 --- a/docs/ref/SUMMARY.md +++ b/docs/ref/SUMMARY.md @@ -31,10 +31,7 @@ - [Utility Functions](./api/util/index.md) - [nng_alloc](./api/util/nng_alloc.md) - - [nng_clock](./api/util/nng_clock.md) - - [nng_duration](./api/util/nng_duration.md) - [nng_id_map](./api/util/nng_id_map.md) - - [nng_msleep](./api/util/nng_msleep.md) - [nng_opts_parse](./api/util/nng_opts_parse.md) - [nng_random](./api/util/nng_random.md) - [nng_socket_pair](./api/util/nng_socket_pair.md) diff --git a/docs/ref/api/stats.md b/docs/ref/api/stats.md index 47d65491..520e0ab6 100644 --- a/docs/ref/api/stats.md +++ b/docs/ref/api/stats.md @@ -199,7 +199,7 @@ here is the same reference time used for [`nng_clock`][nng_clock]. ## See Also -[nng_clock][nng_clock] +[`nng_clock`][nng_clock] [nng_stat_type]: #statistic-type [nng_stats_free]: #freeing-a-snapshot @@ -213,7 +213,7 @@ here is the same reference time used for [`nng_clock`][nng_clock]. [NNG_STAT_SCOPE]: #NNG_STAT_SCOPE [NNG_STAT_STRING]: #NNG_STAT_STRING [NNG_STAT_BOOLEAN]: #NNG_STAT_BOOLEAN -[nng_clock]: ../util/nng_clock.md +[nng_clock]: ./time.md#getting-the-current-time [nng_socket]: TODO.md [nng_dialer]: TODO.md [nng_listener]: TODO.md diff --git a/docs/ref/api/synch.md b/docs/ref/api/synch.md index f32344b0..965b34da 100644 --- a/docs/ref/api/synch.md +++ b/docs/ref/api/synch.md @@ -132,20 +132,10 @@ The difference between these functions is that one thread (which may be chosen randomly). > [!TIP] -> Use of `nng_cv_wake1` may be used to reduce the "thundering herd" syndrom of waking +> Use of `nng_cv_wake1` may be used to reduce the "{{i:thundering herd}}" syndrom of waking > all threads concurrently, but should only be used in circumstances where the application > does not depend on _which_ thread will be woken. When in doubt, `nng_cv_wake` is safer. -[aio]: aio.md -[thread]: thread.md -[nng_mtx]: #mutual-exclusion-lock -[nng_mtx_lock]: #acquiring-a-mutex -[nng_mtx_unlock]: #releasing-a-mutex -[nng_cv]: #condition-variable -[nng_cv_wait]: #waiting-for-the-condition -[nng_cv_wake]: #signaling-the-condition -[nng_clock]: ../util/nng_clock.md - ## Examples ### Example 1: Allocating the condition variable @@ -180,3 +170,13 @@ one thread (which may be chosen randomly). nng_cv_wake(cv); nng_mtx_unlock(m); ``` + +[aio]: aio.md +[thread]: thread.md +[nng_mtx]: #mutual-exclusion-lock +[nng_mtx_lock]: #acquiring-a-mutex +[nng_mtx_unlock]: #releasing-a-mutex +[nng_cv]: #condition-variable +[nng_cv_wait]: #waiting-for-the-condition +[nng_cv_wake]: #signaling-the-condition +[nng_clock]: ./time.md#getting-the-current-time |