blob: 62e5240c7f4facf10f983e593763131e8bc29188 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.0-stable">
<brief_description>
SSL Stream peer.
</brief_description>
<description>
SSL Stream peer. This object can be used to connect to SSL servers.
</description>
<tutorials>
http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html
</tutorials>
<demos>
</demos>
<methods>
<method name="accept_stream">
<return type="int" enum="Error">
</return>
<argument index="0" name="stream" type="StreamPeer">
</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>
Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [code]StreamPeerSSL[/code] will validate that the certificate presented by the peer matches the "for_hostname".
</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>
<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>
</methods>
<constants>
<constant name="STATUS_DISCONNECTED" value="0" enum="Status">
A status representing a [code]StreamPeerSSL[/code] that is disconnected.
</constant>
<constant name="STATUS_CONNECTED" value="1" enum="Status">
A status representing a [code]StreamPeerSSL[/code] that is connected to a host.
</constant>
<constant name="STATUS_ERROR_NO_CERTIFICATE" value="2" enum="Status">
An errot status that shows the peer did not present a SSL certificate and validation was requested.
</constant>
<constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="3" enum="Status">
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>
|