fix inaccuracies pointed out in ticket #823

This commit is contained in:
kytv
2012-12-30 22:23:48 +00:00
parent 27af587306
commit 775eb0eb61

View File

@@ -181,18 +181,18 @@ A client asks for a connection by :
-> STREAM CONNECT -> STREAM CONNECT
ID={$nickname} ID={$nickname}
DESTINATION=$peer_public_base64_key DESTINATION=$peer_public_base64_key
[SILENCE={true,false}] [SILENT={true,false}]
This establishes a new virtual connection from the local session This establishes a new virtual connection from the local session
whose ID is {$nickname} to the specified peer. whose ID is {$nickname} to the specified peer.
If SILENCE=true is passed, the SAM bridge won't issue any other message If SILENT=true is passed, the SAM bridge won't issue any other message
on the socket : if the connection fails, the socket will be closed. on the socket : if the connection fails, the socket will be closed.
If the connection succeeds, all remaining data passing through the If the connection succeeds, all remaining data passing through the
current socket is forwarded from and to the connected I2P destination current socket is forwarded from and to the connected I2P destination
peer. peer.
If SILENCE=false, which is the default value, the SAM bridge sends a If SILENT=false, which is the default value, the SAM bridge sends a
last message to its client before forwarding or shutting down the last message to its client before forwarding or shutting down the
socket : socket :
@@ -227,7 +227,7 @@ A client waits for an incoming connection request by :
-> STREAM ACCEPT -> STREAM ACCEPT
ID={$nickname} ID={$nickname}
[SILENCE={true,false}] [SILENT={true,false}]
This makes the session ${nickname} listen for one incoming This makes the session ${nickname} listen for one incoming
connection request from the I2P network. connection request from the I2P network.
@@ -249,11 +249,11 @@ bridge. If the result is OK, the SAM bridge starts waiting for an
incoming connection request from another I2P peer. When a request incoming connection request from another I2P peer. When a request
arrives, the SAM bridge accepts it and : arrives, the SAM bridge accepts it and :
* If SILENCE=true was passed, the SAM bridge won't issue any other message * If SILENT=true was passed, the SAM bridge won't issue any other message
on the client socket : all remaining data passing through the on the client socket : all remaining data passing through the
current socket is forwarded from and to the connected I2P destination current socket is forwarded from and to the connected I2P destination
peer. peer.
* If SILENCE=false was passed, which is the default value, the SAM bridge * If SILENT=false was passed, which is the default value, the SAM bridge
sends the client a ASCII line containing the base64 public destination key sends the client a ASCII line containing the base64 public destination key
of the requesting peer. After this '\n' terminated line, all remaining data of the requesting peer. After this '\n' terminated line, all remaining data
passing through the current socket is forwarded from and to the connected passing through the current socket is forwarded from and to the connected
@@ -273,7 +273,7 @@ coming from I2P. For that, the client has to :
ID={$nickname} ID={$nickname}
PORT={$port} PORT={$port}
[HOST={$host}] [HOST={$host}]
[SILENCE={true,false}] [SILENT={true,false}]
This makes the session ${nickname} listen for incoming This makes the session ${nickname} listen for incoming
connection requests from the I2P network. connection requests from the I2P network.
@@ -301,10 +301,10 @@ When a connection request arrives from I2P, the SAM bridge requests a
socket connection from {$host}:{$port}. If it is accepted after no more socket connection from {$host}:{$port}. If it is accepted after no more
than 3 seconds, SAM will accept the connection from I2P, and then : than 3 seconds, SAM will accept the connection from I2P, and then :
* If SILENCE=true was passed, all data passing through the obtained * If SILENT=true was passed, all data passing through the obtained
current socket is forwarded from and to the connected I2P destination current socket is forwarded from and to the connected I2P destination
peer. peer.
* If SILENCE=false was passed, which is the default value, the SAM bridge * If SILENT=false was passed, which is the default value, the SAM bridge
sends on the obtained socket an ASCII line containing the base64 public sends on the obtained socket an ASCII line containing the base64 public
destination key of the requesting peer. After this '\n' terminated line, destination key of the requesting peer. After this '\n' terminated line,
all remaining data passing through the socket is forwarded from and to all remaining data passing through the socket is forwarded from and to