diff options
author | Garrett D'Amore <garrett@damore.org> | 2016-04-16 08:28:59 -0700 |
---|---|---|
committer | Garrett D'Amore <garrett@damore.org> | 2016-04-18 11:04:13 -0700 |
commit | 5bb109305b5bd738576f9010f7264e4136bd1456 (patch) | |
tree | d1b236cb9791fcb8d9c364f646aaf8a21b7ba295 /doc | |
parent | 058b74abfe9cdcdf56c987108c3ea2190e338af9 (diff) | |
download | nanomsg-5bb109305b5bd738576f9010f7264e4136bd1456.tar.gz |
fixes #621 Remove experimental tcpmux transport
Diffstat (limited to 'doc')
-rw-r--r-- | doc/nanomsg.txt | 9 | ||||
-rw-r--r-- | doc/nn_tcpmux.txt | 72 | ||||
-rw-r--r-- | doc/tcpmuxd.txt | 41 |
3 files changed, 2 insertions, 120 deletions
diff --git a/doc/nanomsg.txt b/doc/nanomsg.txt index 7eacf1c..4a8fea4 100644 --- a/doc/nanomsg.txt +++ b/doc/nanomsg.txt @@ -116,21 +116,16 @@ Inter-process transport:: TCP transport:: <<nn_tcp.7.txt#,nn_tcp(7)>> -TCPMUX transport:: - <<nn_tcpmux.7.txt#,nn_tcpmux(7)>> - WebSocket transport:: <<nn_ws.7.txt#,nn_ws(7)>> -Following tools are installed with the library: +The following tool is installed with the library: nanocat:: <<nanocat.1.txt#,nanocat(1)>> -tcpmuxd:: - <<tcpmuxd.1.txt#,tcpmuxd(1)>> - AUTHORS ------- +link:mailto:garrett@damore.org[Garrett D'Amore] link:mailto:sustrik@250bpm.com[Martin Sustrik] diff --git a/doc/nn_tcpmux.txt b/doc/nn_tcpmux.txt deleted file mode 100644 index 66fb40e..0000000 --- a/doc/nn_tcpmux.txt +++ /dev/null @@ -1,72 +0,0 @@ -nn_tcpmux(7) -============ - -NAME ----- -nn_tcpmux - TCPMUX transport mechanism - - -SYNOPSIS --------- -*#include <nanomsg/nn.h>* - -*#include <nanomsg/tcpmux.h>* - - -DESCRIPTION ------------ - -THIS IS AN EXPERIMENTAL FEATURE. DO NOT USE. -THE FUNCTIONALITY IS SUBJECT TO CHANGE WITHOUT PRIOR NOTICE. - -TCPMUX transport is basically the same as TCP transport -(see <<nn_tcp.7.txt#,nn_tcp(7)>>) except that it allows to specify service names -along with IP addresses and TCP ports. What it means in practice is that many -applications on the same box can share the same TCP port. - -When connecting and binding use the same connection string syntax as with -TCP transport, except that the initial protocol specification should be -'tcpmux://' instead of 'tcp://' and that the connection string should end -with a slash and a service name: - ----- -nn_connect (s, "tcpmux://192.168.0.1:5555/foo"); ----- - -When binding to a TCPMUX endpoint, <<nn_tcpmuxd.1.txt#,nn_tcpmuxd(1)>> daemon must be -running on the box and specified port. There is no such requirement when -connecting to a TCPMUX endpoint. - - -Socket Options -~~~~~~~~~~~~~~ - -NN_TCPMUX_NODELAY:: - This option, when set to 1, disables Nagle's algorithm. It also disables - delaying of TCP acknowledgments. Using this option improves latency at - the expense of throughput. Type of this option is int. Default value is 0. - - -EXAMPLE -------- - ----- -nn_bind (s1, "tcpmux://*:5555/foo"); -nn_connect (s2, "tcpmux://server1.example.org:5555/foo"); ----- - -SEE ALSO --------- -<<nn_tcpmuxd.1.txt#,nn_tcpmuxd(1)>> -<<nn_tcp.7.txt#,nn_tcp(7)>> -<<nn_inproc.7.txt#,nn_inproc(7)>> -<<nn_ipc.7.txt#,nn_ipc(7)>> -<<nn_bind.3.txt#,nn_bind(3)>> -<<nn_connect.3.txt#,nn_connect(3)>> -<<nanomsg.7.txt#,nanomsg(7)>> - - -AUTHORS -------- -link:mailto:sustrik@250bpm.com[Martin Sustrik] - diff --git a/doc/tcpmuxd.txt b/doc/tcpmuxd.txt deleted file mode 100644 index ce95144..0000000 --- a/doc/tcpmuxd.txt +++ /dev/null @@ -1,41 +0,0 @@ -tcpmuxd(1) -========== - -NAME ----- -tcpmuxd - TCP muliplexer daemon - - -SYNOPSIS --------- - - tcpmuxd PORT - -DESCRIPTION ------------ - -THIS IS AN EXPERIMENTAL FEATURE. DO NOT USE. -THE FUNCTIONALITY IS SUBJECT TO CHANGE WITHOUT PRIOR NOTICE. - -TCP multiplexer daemon listens on all network interfaces on TCP port specified -by argument PORT. On each incoming connection it performs TCPMUX handshake as -defined in RFC 1078. Then it hands the connection to the application bound to -the service name specified by the client (see <<tcpmux.7.txt#,tcpmux(7)>> for more -details). - - -OPTIONS -------- - -There are no options defined. - -SEE ALSO --------- -<<tcpmux.7.txt#,tcpmux(7)>> -<<nanomsg.7.txt#,nanomsg(7)>> - -AUTHORS -------- - -link:mailto:sustrik@250bpm.com[Martin Sustrik] - |