summaryrefslogtreecommitdiffstats
path: root/doc/classes/StreamPeerSSL.xml
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2019-09-23 18:16:41 +0200
committerFabio Alessandrelli <fabio.alessandrelli@gmail.com>2019-09-24 14:50:09 +0200
commita20cbf2cca4e471ebcee86aab52336721cef57bd (patch)
treef213a4735210861bfa85acea0dbd96d97fccbe71 /doc/classes/StreamPeerSSL.xml
parent46f909f8af092cf1aa9f708a174af6c57b32430d (diff)
downloadredot-engine-a20cbf2cca4e471ebcee86aab52336721cef57bd.tar.gz
Add documentation for crypto-related classes.
Add documentation for Crypto, CryptoKey, HashingContext, and X509Certificate. Add documentation for `StreamPeerSSL.accept_peer`. Ref #29871.
Diffstat (limited to 'doc/classes/StreamPeerSSL.xml')
-rw-r--r--doc/classes/StreamPeerSSL.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml
index c960a794e2..b34d8d1b25 100644
--- a/doc/classes/StreamPeerSSL.xml
+++ b/doc/classes/StreamPeerSSL.xml
@@ -4,7 +4,7 @@
SSL stream peer.
</brief_description>
<description>
- SSL stream peer. This object can be used to connect to SSL servers.
+ SSL stream peer. This object can be used to connect to an SSL server or accept a single SSL client connection.
</description>
<tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/networking/ssl_certificates.html</link>
@@ -22,6 +22,7 @@
<argument index="3" name="chain" type="X509Certificate" default="null">
</argument>
<description>
+ Accepts a peer connection as a server using the given [code]private_key[/code] and providing the given [code]certificate[/code] to the client. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate.
</description>
</method>
<method name="connect_to_stream">