diff options
| author | lloyd <[email protected]> | 2012-10-31 00:29:34 +0000 |
|---|---|---|
| committer | lloyd <[email protected]> | 2012-10-31 00:29:34 +0000 |
| commit | ae4685b6d65870530148dcb0d50d8bcc89692230 (patch) | |
| tree | 24fb6073828bc8af2fd185c8d79e762b7417b63b /doc/tls.rst | |
| parent | 672801c4182cc549131d171561086b13993c14b2 (diff) | |
Clarify meaning of Alert::is_fatal
Diffstat (limited to 'doc/tls.rst')
| -rw-r--r-- | doc/tls.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/tls.rst b/doc/tls.rst index f148e632d..ac862d25a 100644 --- a/doc/tls.rst +++ b/doc/tls.rst @@ -644,7 +644,9 @@ be of type ``NULL_ALERT``. .. cpp:function:: is_fatal() const - Return if this alert is fatal or a warning alert + Return true if this alert is fatal. A fatal alert causes the + connection to be immediately disconnected. Otherwise, the alert + is a warning and the connection remains valid. .. cpp:function:: Type type() const |