Skip to content

Commit 34be2c2

Browse files
committed
Remove the legacy transport registration functions.
This also allows to remove most of the transport headers. Only zerotier.h sticks around, and only for now. (We expect to eject it into a separate module.)
1 parent 74adece commit 34be2c2

39 files changed

+93
-746
lines changed

docs/man/CMakeLists.txt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,6 @@ if (NNG_ENABLE_DOC)
104104
nng_dialer_start
105105
nng_free
106106
nng_getopt
107-
nng_inproc_register
108-
nng_ipc_register
109107
nng_listen
110108
nng_listener_close
111109
nng_listener_create
@@ -188,15 +186,10 @@ if (NNG_ENABLE_DOC)
188186
nng_strfree
189187
nng_sub_open
190188
nng_surveyor_open
191-
nng_tcp_register
192-
nng_tls_register
193189
nng_url_clone
194190
nng_url_free
195191
nng_url_parse
196192
nng_version
197-
nng_ws_register
198-
nng_wss_register
199-
nng_zt_register
200193
)
201194

202195
set(NNG_MAN3HTTP

docs/man/libnng.3.adoc

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -204,20 +204,6 @@ The following functions are used to construct a socket with a specific protocol:
204204
|xref:nng_surveyor_open.3.adoc[nng_surveyor_open()]|open a surveyor socket
205205
|===
206206

207-
=== Transports
208-
209-
The following functions are used to register a transport for use.
210-
211-
|===
212-
| xref:nng_inproc_register.3.adoc[nng_inproc_register()]|register inproc transport
213-
| xref:nng_ipc_register.3.adoc[nng_ipc_register()]|register IPC transport
214-
| xref:nng_tcp_register.3.adoc[nng_tcp_register()]|register TCP transport
215-
| xref:nng_tls_register.3.adoc[nng_tls_register()]|register TLS transport
216-
| xref:nng_ws_register.3.adoc[nng_ws_register()]|register WebSocket transport
217-
| xref:nng_wss_register.3.adoc[nng_wss_register()]|register WebSocket Secure transport
218-
| xref:nng_zt_register.3.adoc[nng_zt_register()]|register ZeroTier transport
219-
|===
220-
221207
=== Protocol Contexts
222208

223209
The following functions are useful to separate the protocol processing
@@ -481,5 +467,4 @@ with TLS support.
481467
== SEE ALSO
482468

483469
[.text-left]
484-
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
485470
xref:nng.7.adoc[nng(7)]

docs/man/nng_inproc.7.adoc

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= nng_inproc(7)
22
//
3-
// Copyright 2019 Staysail Systems, Inc. <[email protected]>
3+
// Copyright 2024 Staysail Systems, Inc. <[email protected]>
44
// Copyright 2018 Capitar IT Group BV <[email protected]>
55
//
66
// This document is supplied under the terms of the MIT License, a
@@ -13,15 +13,6 @@
1313

1414
nng_inproc - intra-process transport
1515

16-
== SYNOPSIS
17-
18-
[source,c]
19-
----
20-
#include <nng/transport/inproc/inproc.h>
21-
22-
int nng_inproc_register(void);
23-
----
24-
2516
== DESCRIPTION
2617

2718
(((transport, _inproc_)))
@@ -34,12 +25,8 @@ to slower transports when data must be moved within the same process.
3425
This transport tries hard to avoid copying data, and thus is very
3526
light-weight.
3627

37-
=== Registration
38-
39-
This transport is generally built-in to the core, so
40-
no extra steps to use it should be necessary.
41-
4228
=== URI Format
29+
4330
(((URI, `inproc://`)))
4431
This transport uses URIs using the scheme `inproc://`, followed by
4532
an arbitrary string of text, terminated by a `NUL` byte.

docs/man/nng_inproc_register.3.adoc

Lines changed: 0 additions & 47 deletions
This file was deleted.

docs/man/nng_ipc.7.adoc

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= nng_ipc(7)
22
//
3-
// Copyright 2023 Staysail Systems, Inc. <[email protected]>
3+
// Copyright 2024 Staysail Systems, Inc. <[email protected]>
44
// Copyright 2018 Capitar IT Group BV <[email protected]>
55
//
66
// This document is supplied under the terms of the MIT License, a
@@ -13,15 +13,6 @@
1313

1414
nng_ipc - IPC transport
1515

16-
== SYNOPSIS
17-
18-
[source,c]
19-
----
20-
#include <nng/transport/ipc/ipc.h>
21-
22-
int nng_ipc_register(void);
23-
----
24-
2516
== DESCRIPTION
2617

2718
(((IPC)))(((transport, _ipc_)))
@@ -33,11 +24,6 @@ Other platforms may have different implementation strategies.
3324

3425
// We need to insert a reference to the nanomsg RFC.
3526

36-
=== Registration
37-
38-
This transport is generally built-in to the core, so
39-
no extra steps to use it should be necessary.
40-
4127
=== URI Formats
4228

4329
==== Traditional Names

docs/man/nng_ipc_register.3.adoc

Lines changed: 0 additions & 47 deletions
This file was deleted.

docs/man/nng_tcp.7.adoc

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= nng_tcp(7)
22
//
3-
// Copyright 2019 Staysail Systems, Inc. <[email protected]>
3+
// Copyright 2024 Staysail Systems, Inc. <[email protected]>
44
// Copyright 2018 Capitar IT Group BV <[email protected]>
55
//
66
// This document is supplied under the terms of the MIT License, a
@@ -13,15 +13,6 @@
1313

1414
nng_tcp - TCP/IP transport
1515

16-
== SYNOPSIS
17-
18-
[source,c]
19-
----
20-
#include <nng/transport/tcp/tcp.h>
21-
22-
int nng_tcp_register(void);
23-
----
24-
2516
== DESCRIPTION
2617

2718
(((transport, _tcp_)))
@@ -31,11 +22,6 @@ Both IPv4 and IPv6 are supported when the underlying platform also supports it.
3122

3223
// We need to insert a reference to the nanomsg RFC.
3324

34-
=== Registration
35-
36-
This transport is generally built-in to the core of _NNG_, so
37-
no extra steps to use it should be necessary.
38-
3925
=== URI Format
4026

4127
(((URI, `tcp://`)))

docs/man/nng_tcp_register.3.adoc

Lines changed: 0 additions & 47 deletions
This file was deleted.

docs/man/nng_tls.7.adoc

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= nng_tls(7)
22
//
3-
// Copyright 2019 Staysail Systems, Inc. <[email protected]>
3+
// Copyright 2024 Staysail Systems, Inc. <[email protected]>
44
// Copyright 2018 Capitar IT Group BV <[email protected]>
55
//
66
// This document is supplied under the terms of the MIT License, a
@@ -13,15 +13,6 @@
1313

1414
nng_tls - TLS transport
1515

16-
== SYNOPSIS
17-
18-
[source,c]
19-
----
20-
#include <nng/transport/tls/tls.h>
21-
22-
int nng_tls_register(void);
23-
----
24-
2516
== DESCRIPTION
2617

2718
(((TLS)))(((Transport Layer Security)))(((transport, _tls_)))
@@ -34,12 +25,6 @@ Both IPv4 and IPv6 are supported when the underlying platform also supports it.
3425
The protocol details are documented in
3526
http://nanomsg.org/rfcs/sp-tls-v1.html[TLS Mapping for Scalability Protocols].
3627

37-
=== Registration
38-
39-
Depending upon how the library was built, it may be necessary to
40-
register the transport by calling
41-
xref:nng_tls_register.3.adoc[`nng_tls_register()`].
42-
4328
=== Availability
4429

4530
The _tls_ transport depends on the use of an external library.

docs/man/nng_tls_register.3.adoc

Lines changed: 0 additions & 44 deletions
This file was deleted.

0 commit comments

Comments
 (0)