aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlloyd <[email protected]>2014-12-13 15:40:14 +0000
committerlloyd <[email protected]>2014-12-13 15:40:14 +0000
commitd09b6a0cf2ef83db71b27ebc79eaae0d876314bd (patch)
treefadef67da751b55d6fb1886080dcd9726f4dcc2e
parent12d7ead8c321a445b7ebb5226fe89dc0822c2796 (diff)
Make the connection between calling TLS::Channel::send and a new
wire record being created more clear.
-rw-r--r--doc/manual/tls.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst
index fab807863..10b3ec111 100644
--- a/doc/manual/tls.rst
+++ b/doc/manual/tls.rst
@@ -95,9 +95,15 @@ available:
.. cpp:function:: void send(const byte buf[], size_t buf_size)
- If the connection has completed the initial handshake process,
- the data provided is sent to the counterparty as TLS
- traffic. Otherwise, an exception is thrown.
+ Create one or more new TLS application records containing the
+ provided data and send them. This will eventually result in at
+ least one call to the ``output_fn`` callback before ``send``
+ returns.
+
+ If the current TLS connection state is unable to transmit new
+ application records (for example because a handshake has not
+ yet completed or the connnection has already ended due to an
+ error) an exception will be thrown.
.. cpp:function:: void close()