aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/ctx.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-01 23:38:22 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-01 23:38:22 -0800
commit61c886e86de03f89e0c6c1769171576482bf4245 (patch)
treecb5e8604458351a1b247443d2cdb0d0f2715293c /docs/ref/api/ctx.md
parent0df5725fbd53cf67711f0f73a138fc6858ab6740 (diff)
downloadnng-61c886e86de03f89e0c6c1769171576482bf4245.tar.gz
nng-61c886e86de03f89e0c6c1769171576482bf4245.tar.bz2
nng-61c886e86de03f89e0c6c1769171576482bf4245.zip
docs: convert socket options to mdbook
Diffstat (limited to 'docs/ref/api/ctx.md')
-rw-r--r--docs/ref/api/ctx.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/ref/api/ctx.md b/docs/ref/api/ctx.md
index 75d1198c..43d79621 100644
--- a/docs/ref/api/ctx.md
+++ b/docs/ref/api/ctx.md
@@ -180,12 +180,16 @@ int nng_ctx_set_size(nng_ctx ctx, const char *opt, size_t val);
int nng_ctx_set_uint64(nng_ctx ctx, const char *opt, uint64_t val);
```
+Some protocols support certain options that affect the behavior of a specific context.
+For example, most protocols will let you set the defaults timeouts associated with
+send or receive separately for different contexts.
+
These functions are used to retrieve or change the value of an option named _opt_ from the context _ctx_.
-The `nng_ctx_get_` functions retrieve the value, and store it in the location _valp_ references.
+The `nng_ctx_get_` functions retrieve the value from _ctx_, and store it in the location _valp_ references.
The `nng_ctx_set_` functions change the value for the _ctx_, taking it from _val_.
-These functions access an option as a specific type. The protocol will have details about which options
-are available for contexts, and which type they may be accessed using.
+These functions access an option as a specific type. The protocol documentation will have details about which options
+are available for contexts, whether they can be read or written, and which type they may be accessed using.
## Examples