2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 09:32:53 +00:00
<class name= "StreamPeerSSL" inherits= "StreamPeer" category= "Core" version= "3.1.2" >
2017-09-12 20:42:36 +00:00
<brief_description >
SSL Stream peer.
</brief_description>
<description >
SSL Stream peer. This object can be used to connect to SSL servers.
</description>
<tutorials >
2019-06-01 09:39:12 +00:00
<link > https://docs.godotengine.org/en/3.1/tutorials/networking/ssl_certificates.html</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
<method name= "accept_stream" >
<return type= "int" enum= "Error" >
</return>
2018-07-26 09:56:21 +00:00
<argument index= "0" name= "base" type= "StreamPeer" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
</description>
</method>
<method name= "connect_to_stream" >
<return type= "int" enum= "Error" >
</return>
<argument index= "0" name= "stream" type= "StreamPeer" >
</argument>
<argument index= "1" name= "validate_certs" type= "bool" default= "false" >
</argument>
<argument index= "2" name= "for_hostname" type= "String" default= """" >
</argument>
<description >
2019-04-17 11:42:56 +00:00
Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is [code]true[/code], [code]StreamPeerSSL[/code] will validate that the certificate presented by the peer matches the "for_hostname".
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "disconnect_from_stream" >
<return type= "void" >
</return>
<description >
Disconnect from host.
</description>
</method>
<method name= "get_status" qualifiers= "const" >
<return type= "int" enum= "StreamPeerSSL.Status" >
</return>
<description >
Return the status of the connection, one of STATUS_* enum.
</description>
</method>
2018-02-09 14:03:34 +00:00
<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.
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
2018-07-26 09:56:21 +00:00
<members >
<member name= "blocking_handshake" type= "bool" setter= "set_blocking_handshake_enabled" getter= "is_blocking_handshake_enabled" >
</member>
</members>
2017-09-12 20:42:36 +00:00
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "STATUS_DISCONNECTED" value= "0" enum= "Status" >
2017-10-22 10:56:11 +00:00
A status representing a [code]StreamPeerSSL[/code] that is disconnected.
2017-09-12 20:42:36 +00:00
</constant>
2018-10-07 13:52:07 +00:00
<constant name= "STATUS_HANDSHAKING" value= "1" enum= "Status" >
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "STATUS_CONNECTED" value= "2" enum= "Status" >
2017-10-22 10:56:11 +00:00
A status representing a [code]StreamPeerSSL[/code] that is connected to a host.
2017-09-12 20:42:36 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "STATUS_ERROR" value= "3" enum= "Status" >
2017-09-12 20:42:36 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "STATUS_ERROR_HOSTNAME_MISMATCH" value= "4" enum= "Status" >
2017-09-12 20:42:36 +00:00
An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation.
</constant>
</constants>
</class>