From 11485d2723f22dc60e4cefea3ffb3fd8a378d931 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sun, 3 Nov 2024 09:46:54 -0800
Subject: Remove untyped nng_socket_get and nng_socket_set.

---
 docs/man/nng_socket_get.3.adoc | 26 ++------------------------
 1 file changed, 2 insertions(+), 24 deletions(-)

(limited to 'docs/man/nng_socket_get.3.adoc')

diff --git a/docs/man/nng_socket_get.3.adoc b/docs/man/nng_socket_get.3.adoc
index e304964a..cca1dc5a 100644
--- a/docs/man/nng_socket_get.3.adoc
+++ b/docs/man/nng_socket_get.3.adoc
@@ -1,6 +1,6 @@
 = nng_socket_get(3)
 //
-// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech>
 // Copyright 2018 Capitar IT Group BV <info@capitar.com>
 //
 // This document is supplied under the terms of the MIT License, a
@@ -19,8 +19,6 @@ nng_socket_get - get socket option
 ----
 #include <nng/nng.h>
 
-int nng_socket_get(nng_socket s, const char *opt, void *val, size_t *valszp);
-
 int nng_socket_get_bool(nng_socket s, const char *opt, bool *bvalp);
 
 int nng_socket_get_int(nng_socket s, const char *opt, int *ivalp);
@@ -42,7 +40,7 @@ int nng_socket_get_addr(nng_socket s, const char *opt, nng_sockaddr *addrp);
 == DESCRIPTION
 
 (((options, socket)))
-The `nng_socket_get()` functions are used to retrieve option values for
+The `nng_socket_get` functions are used to retrieve option values for
 the xref:nng_socket.5.adoc[socket] _s_.
 The actual options that may be retrieved in this way vary.
 A number of them are documented in xref:nng_options.5.adoc[nng_options(5)].
@@ -62,26 +60,6 @@ The forms vary based on the type of the option they take.
 The details of the type, size, and semantics of the option will depend
 on the actual option, and will be documented with the option itself.
 
-`nng_socket_get()`::
-This function is untyped and can be used to retrieve the value of any option.
-The caller must store a pointer to a buffer to receive the value in _val_,
-and the size of the buffer shall be stored at the location referenced by
-_valszp_.
-+
-When the function returns, the actual size of the data copied (or that
-would have been copied if sufficient space were present) is stored at
-the location referenced by _valszp_.
-If the caller's buffer is not large enough to hold the entire object,
-then the copy is truncated.
-Therefore the caller should check for truncation by verifying that the
-returned size in _valszp_ does not exceed the original buffer size.
-+
-It is acceptable to pass `NULL` for _val_ if the value in _valszp_ is zero.
-This can be used to determine the size of the buffer needed to receive
-the object.
-+
-TIP: It may be easier to use one of the typed forms of this function.
-
 `nng_socket_get_bool()`::
 This function is for options which take a Boolean (`bool`).
 The value will be stored at _bvalp_.
-- 
cgit v1.2.3-70-g09d2

