diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-11-09 08:32:33 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-11-11 10:31:44 -0800 |
| commit | db5467e6c3b502f6e93a6f6c5d1f2a8f86a8eaa5 (patch) | |
| tree | 71fb23ed0f0e2eb980245fcdf72cf2fce5d152be /docs/man/nng_options.5.adoc | |
| parent | 768eaa4d50a6a436b714188ec9c6b98fd729b306 (diff) | |
| download | nng-db5467e6c3b502f6e93a6f6c5d1f2a8f86a8eaa5.tar.gz nng-db5467e6c3b502f6e93a6f6c5d1f2a8f86a8eaa5.tar.bz2 nng-db5467e6c3b502f6e93a6f6c5d1f2a8f86a8eaa5.zip | |
Add new functions for socket identity.
These functions were added in the main branch for NNG 2.0, and
we add them here to facilitate converting any code that happened
to use the options (`NNG_OPT_PROTO`, `NNG_OPT_PROTONAME`,
`NNG_OPT_PEER`, `NNG_OPT_PEERNAME`, and `NNG_OPT_RAW`.
Its unlikely that many applications need this, but providing these
as a transition aid may help applications start adopting new APIs now.
Diffstat (limited to 'docs/man/nng_options.5.adoc')
| -rw-r--r-- | docs/man/nng_options.5.adoc | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/man/nng_options.5.adoc b/docs/man/nng_options.5.adoc index 94da37a0..7bf2a03b 100644 --- a/docs/man/nng_options.5.adoc +++ b/docs/man/nng_options.5.adoc @@ -113,6 +113,8 @@ automatically copy message headers from a received message to the corresponding reply, whereas in raw mode this is not done.) See xref:nng.7.adoc#raw_mode[Raw Mode] for more details. +NOTE: This option is deprecated. Use the xref:nng_socket_raw.3.adoc[`nng_socket_raw`] function instead. + [[NNG_OPT_RECONNMINT]] ((`NNG_OPT_RECONNMINT`)):: (((reconnect time, minimum))) @@ -326,12 +328,16 @@ application. (`int`) This read-only option is used to obtain the 16-bit number for the socket's protocol. +NOTE: This option is deprecated. Use the xref:nng_socket_proto_id.3.adoc[`nng_socket_proto_id`] function instead. + [[NNG_OPT_PEER]] ((`NNG_OPT_PEER`)):: (`int`) This read-only option is used to obtain the 16-bit number of the peer protocol for the socket. +NOTE: This option is deprecated. Use the xref:nng_socket_proto_id.3.adoc[`nng_socket_peer_id`] function instead. + [[NNG_OPT_PEER_GID]] ((`NNG_OPT_PEER_GID`)):: (`uint64_t`) @@ -370,11 +376,15 @@ Zones (and this option) are only supported on Solaris and illumos systems, on se (string) This read-only option is used to obtain the name of the peer protocol for the socket. +NOTE: This option is deprecated. Use the xref:nng_socket_proto_name.3.adoc[`nng_socket_peer_name`] function instead. + [[NNG_OPT_PROTONAME]] ((`NNG_OPT_PROTONAME`)):: (string) This read-only option is used to obtain the name of the socket's protocol. +NOTE: This option is deprecated. Use the xref:nng_socket_proto_name.3.adoc[`nng_socket_proto_name`] function instead. + == SEE ALSO [.text-left] |