Skip to content

Commit

Permalink
Merge branch 'master' into master-drbitboy-async-demo-client
Browse files Browse the repository at this point in the history
  • Loading branch information
drbitboy committed Mar 4, 2024
2 parents 4e86c19 + 85fbe7f commit 8c5cd59
Show file tree
Hide file tree
Showing 30 changed files with 1,438 additions and 556 deletions.
3 changes: 3 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ endif ()

nng_defines_if(NNG_ENABLE_STATS NNG_ENABLE_STATS)

# IPv6 enable
nng_defines_if(NNG_ENABLE_IPV6 NNG_ENABLE_IPV6)

set(NNG_RESOLV_CONCURRENCY 4 CACHE STRING "Resolver (DNS) concurrency.")
mark_as_advanced(NNG_RESOLV_CONCURRENCY)
if (NNG_RESOLV_CONCURRENCY)
Expand Down
7 changes: 5 additions & 2 deletions cmake/FindMbedTLS.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,13 @@
#
# Hints:
#
# Set ``MBEDTLS_ROOT_DIR`` to the root directory of Mbed TLS installation.
# Set ``MBEDTLS_ROOT`` to the root directory of Mbed TLS installation.
#

set(_MBEDTLS_ROOT_HINTS ${MBEDTLS_ROOT_DIR} ENV MBEDTLS_ROOT_DIR)
set(_MBEDTLS_ROOT_HINTS ${MBEDTLS_ROOT} ENV MBEDTLS_ROOT)
if (NOT _MBEDTLS_ROOT_HINTS)
set(_MBEDTLS_ROOT_HINTS ${MBEDTLS_ROOT_DIR} ENV MBEDTLS_ROOT_DIR)
endif()

set(_MBED_REQUIRED_VARS MbedTLS_TARGET MbedX509_TARGET MbedCrypto_TARGET MbedTLS_VERSION)

Expand Down
5 changes: 5 additions & 0 deletions cmake/NNGOptions.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,11 @@ if (NNG_ENABLE_HTTP)
endif()
mark_as_advanced(NNG_ENABLE_HTTP)

# Some sites or kernels lack IPv6 support. This override allows us
# to prevent the use of IPv6 in environments where it isn't supported.
option (NNG_ENABLE_IPV6 "Enable IPv6." ON)
mark_as_advanced(NNG_ENABLE_IPV6)

#
# Transport Options.
#
Expand Down
16 changes: 8 additions & 8 deletions docs/man/nng_socket.7.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= nng_socket(7)
//
// Copyright 2023 Staysail Systems, Inc. <[email protected]>
// Copyright 2024 Staysail Systems, Inc. <[email protected]>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
Expand All @@ -15,19 +15,18 @@ nng_socket - BSD Socket transport (experimental)
== DESCRIPTION

(((BSD Socket)))(((transport, _socket_)))
The ((_socket_ transport)) provides communication support between
peers across a arbitrary BSD sockets, such as those that are
The ((_socket_ transport)) supports communication between
peers across arbitrary BSD sockets, such as those that are
created with xref:nng_socket_pair.3supp.adoc[`nng_socket_pair()`].

This transport only supports xref:nng_listener.5.adoc[listeners], using xref:nng_listener_create.3.adoc[`nng_listener_create()`].

NOTE: Attempts to create a xref:nng_dialer.5.adoc[dialer] using this transport will result in `NNG_ENOTSUP`.
NOTE: Attempts to create xref:nng_dialer.5.adoc[dialers] using this transport will result in `NNG_ENOTSUP`.

The socket file descriptor is passed to the listener using the `NNG_OPT_SOCKET_FD` option (as an integer).
Setting this option (which is read-only and can be set multiple times) will cause the listener
to create a xref:nng_pipe.5.adoc[pipe] associated backed by the file descriptor.
Setting this option will cause the listener to create a xref:nng_pipe.5.adoc[pipe] associated backed by the file descriptor.

The protocol between peers using this pipe is at present compatible with the protocol used for the
The protocol between peers using this transport is compatible with the protocol used for the
xref:nng_tcp.7.adoc[TCP] transport, but this is an implementation detail and subject to change without notice.

NOTE: This transport is *experimental*, and at present is only supported on POSIX platforms.
Expand All @@ -53,7 +52,8 @@ The following transport option is available:
((`NNG_OPT_SOCKET_FD`))::

(int) This is a write-only option, that may be set multiple times on a listener.
The listener will create a pipe backed by the given file descriptor passed as an argument.
Each time this is set, the listener will create a xref:nng_pipe.5.adoc[pipe] backed by the given file
descriptor passed as an argument.

Additionally, the following options may be supported on pipes when the platform supports them:

Expand Down
Loading

0 comments on commit 8c5cd59

Please sign in to comment.