From 7f3a5b4f040a65b39e580d24ffda3dda06e678e1 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Wed, 30 May 2018 22:59:58 -0600 Subject: [PATCH] explain control messages --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d268d61..818ae09 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ Browser <---- M-PROXY Service ----> Device Browser <--/ \--> Device ``` +Many clients may connect to a single device. A single client may connect to many devices. + It's the kind of thing you'd use to build a poor man's VPN, or port-forward router. The M-PROXY Protocol @@ -48,7 +50,11 @@ data length (string) the number of bytes in the wrapped packet, in These optional values can be very useful at the start of a new connection service name (string) Either a standard service name (port + protocol), such as 'https' as listed in /etc/services, otherwise 'tls', 'tcp', or 'udp' for generics - Also 'control' and 'error' are used for messages with the proxy (i.e. authentication) + Also used for messages with the proxy (i.e. authentication) + * 'control' for authentication, etc + * 'error' for a specific client + * 'pause' to pause upload to a specific client (not the whole tunnel) + * 'resume' to resume upload to a specific client (not the whole tunnel) service port (string) The listening port, such as 443. Useful for non-standard or dynamic services. host or server name (string) Useful for services that can be routed by name, such as http, https, smtp, and dns. ```