summaryrefslogtreecommitdiff
path: root/docs/reference/src/api/index.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-24 21:46:35 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-24 21:46:35 -0700
commitb4fa69e7a6ef540e7d6a918c88f2816fff6c0cf0 (patch)
tree5a95331eca8355d12672052cb54aa654b034de87 /docs/reference/src/api/index.md
parent12cc58cb5f9f205ed69c18fb65e386c1f004e2df (diff)
downloadnng-b4fa69e7a6ef540e7d6a918c88f2816fff6c0cf0.tar.gz
nng-b4fa69e7a6ef540e7d6a918c88f2816fff6c0cf0.tar.bz2
nng-b4fa69e7a6ef540e7d6a918c88f2816fff6c0cf0.zip
Organization and content
Diffstat (limited to 'docs/reference/src/api/index.md')
-rw-r--r--docs/reference/src/api/index.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/reference/src/api/index.md b/docs/reference/src/api/index.md
index 0d1089e3..1541b541 100644
--- a/docs/reference/src/api/index.md
+++ b/docs/reference/src/api/index.md
@@ -1,8 +1,23 @@
# API Reference
-This section documents the functions and data structures that make up
+This chapter documents the functions and data structures that make up
the _NNG_ programming interface.
> [!NOTE]
> Interfaces not documented here are not considered public or stable,
> and they may be removed or altered in incompatible ways at any time.
+
+We have organized the reference material along general functional areas.
+They are:
+
+- [Asynchronous I/O](aio/index.md)
+- [Asynchronous I/O for Providers](aio_provider/index.md)
+- General Utility Functions
+- Scalability Protocol Sockets
+- Scalability Protocol Contexts
+- Concurrency / Multi-threading
+- HTTP Server
+- HTTP Client
+- Streaming API
+- Statistics API
+- Legacy Compatibility