diff options
Diffstat (limited to 'doc/classes/StreamPeerSSL.xml')
| -rw-r--r-- | doc/classes/StreamPeerSSL.xml | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index f28e6e5544..9b5f4e7580 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.2"> <brief_description> - SSL Stream peer. + 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 SSL servers. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/networking/ssl_certificates.html</link> @@ -28,33 +28,33 @@ <argument index="2" name="for_hostname" type="String" default=""""> </argument> <description> - Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". + Connects to a peer using an underlying [StreamPeer] [code]stream[/code]. If [code]validate_certs[/code] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [code]for_hostname[/code]. </description> </method> <method name="disconnect_from_stream"> <return type="void"> </return> <description> - Disconnect from host. + Disconnects from host. </description> </method> <method name="get_status" qualifiers="const"> <return type="int" enum="StreamPeerSSL.Status"> </return> <description> - Returns the status of the connection, one of STATUS_* enum. + Returns the status of the connection. See [enum Status] for values. </description> </method> <method name="poll"> <return type="void"> </return> <description> - Poll the connection to check for incoming bytes. Call this right before "get_available_bytes()" for it to work properly. + Poll the connection to check for incoming bytes. Call this right before [method StreamPeer.get_available_bytes] for it to work properly. </description> </method> </methods> <members> - <member name="blocking_handshake" type="bool" setter="set_blocking_handshake_enabled" getter="is_blocking_handshake_enabled"> + <member name="blocking_handshake" type="bool" setter="set_blocking_handshake_enabled" getter="is_blocking_handshake_enabled" default="true"> </member> </members> <constants> |