Commit fa318400 authored by Pieter Hintjens's avatar Pieter Hintjens

Fixed man page for zmq_proxy_hook

- spaces instead of tabs for indentation
- fixed levels under EXAMPLE USAGE
- added to Makefile.am
parent e436073b
...@@ -88,6 +88,7 @@ tests/test_many_sockets ...@@ -88,6 +88,7 @@ tests/test_many_sockets
tests/test_diffserv tests/test_diffserv
tests/test_srcfd tests/test_srcfd
tests/test_stream_disconnect tests/test_stream_disconnect
tests/test_proxy_chain
tests/test*.log tests/test*.log
tests/test*.trs tests/test*.trs
src/platform.hpp* src/platform.hpp*
......
...@@ -7,8 +7,9 @@ MAN3 = zmq_bind.3 zmq_unbind.3 zmq_connect.3 zmq_disconnect.3 zmq_close.3 \ ...@@ -7,8 +7,9 @@ MAN3 = zmq_bind.3 zmq_unbind.3 zmq_connect.3 zmq_disconnect.3 zmq_close.3 \
zmq_msg_get.3 zmq_msg_set.3 zmq_msg_more.3 \ zmq_msg_get.3 zmq_msg_set.3 zmq_msg_more.3 \
zmq_getsockopt.3 zmq_setsockopt.3 \ zmq_getsockopt.3 zmq_setsockopt.3 \
zmq_socket.3 zmq_socket_monitor.3 zmq_poll.3 \ zmq_socket.3 zmq_socket_monitor.3 zmq_poll.3 \
zmq_errno.3 zmq_strerror.3 zmq_version.3 zmq_proxy.3 zmq_proxy_steerable.3 \ zmq_errno.3 zmq_strerror.3 zmq_version.3 \
zmq_sendmsg.3 zmq_recvmsg.3 zmq_init.3 zmq_term.3 \ zmq_sendmsg.3 zmq_recvmsg.3 zmq_init.3 zmq_term.3 \
zmq_proxy.3 zmq_proxy_steerable.3 zmq_proxy_chain.3 zmq_proxy_hook.3 \
zmq_z85_encode.3 zmq_z85_decode.3 zmq_curve_keypair.3 zmq_z85_encode.3 zmq_z85_decode.3 zmq_curve_keypair.3
MAN7 = zmq.7 zmq_tcp.7 zmq_pgm.7 zmq_epgm.7 zmq_inproc.7 zmq_ipc.7 \ MAN7 = zmq.7 zmq_tcp.7 zmq_pgm.7 zmq_epgm.7 zmq_inproc.7 zmq_ipc.7 \
......
...@@ -29,7 +29,7 @@ it is sent to the backend. The second one, 'back2front_hook' is for the way back ...@@ -29,7 +29,7 @@ it is sent to the backend. The second one, 'back2front_hook' is for the way back
Both functions receive as an argument in addition to a pointer to the message, the Both functions receive as an argument in addition to a pointer to the message, the
pointer to the data passed in the 'zmq_proxy_hook_t' structure. This data makes it pointer to the data passed in the 'zmq_proxy_hook_t' structure. This data makes it
possible to manage statefull behaviours in the proxy. They receive also the frame possible to manage stateful behaviours in the proxy. They receive also the frame
number n_ which is 1 for the first frame, n for the nth one, 0 for the last one. This number n_ which is 1 for the first frame, n for the nth one, 0 for the last one. This
enable to manage specifically the identity frame when ROUTER | STREAM sockets are enable to manage specifically the identity frame when ROUTER | STREAM sockets are
concerned. Moreover, to give the hook full capabilities, the three sockets passed concerned. Moreover, to give the hook full capabilities, the three sockets passed
...@@ -57,36 +57,35 @@ EXAMPLE USAGE ...@@ -57,36 +57,35 @@ EXAMPLE USAGE
------------- -------------
Filter Filter
------ ~~~~~~
The most simple use is to simply filter the messages for example against vulgarity. The most simple use is to simply filter the messages for example against vulgarity.
Messages are simply scanned against a dictionnary and target words are replaced. Messages are simply scanned against a dictionnary and target words are replaced.
ROUTER | STREAM / ROUTER | STREAM proxy ROUTER | STREAM / ROUTER | STREAM proxy
--------------------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The data field enables to multiplex as desired identities in a ROUTER/ROUTER or in a The data field enables to multiplex as desired identities in a ROUTER/ROUTER or in a
STREAM/STREAM proxy or what ever. Such architecture enables also custom load balancers. STREAM/STREAM proxy or what ever. Such architecture enables also custom load balancers.
Sticky ROUTER / ROUTER proxy Sticky ROUTER / ROUTER proxy
---------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The data field enables to manage sticky identity pairing in a ROUTER/ROUTER proxy. The data field enables to manage sticky identity pairing in a ROUTER/ROUTER proxy.
Security mechanism proxying Security mechanism proxying
--------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
We expect to be able to proxy CURVE with the use of this feature. We expect to be able to proxy CURVE with the use of this feature.
Tests Tests
----- ~~~~~
In an existing application, just change zmq_proxy or zmq_proxy_steerable for In an existing application, just change zmq_proxy or zmq_proxy_steerable for
zmq_proxy_hook to test anythink, even "Man in the middle" attacks ws security zmq_proxy_hook to test anythink, even "Man in the middle" attacks ws security
mechanisms with a STREAM/STREAM proxy. mechanisms with a STREAM/STREAM proxy.
RETURN VALUE RETURN VALUE
------------ ------------
The _zmq_proxy_hook()_ function returns the same values than zmq_proxy The _zmq_proxy_hook()_ function returns the same values than zmq_proxy
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment