You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-11-04 12:00:25 +00:00
7227fdd805
> [!NOTE] > > Later versions of Windows has support for `AF_UNIX`, so it could be > added.
36 lines
1.6 KiB
XML
36 lines
1.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="StreamPeerUDS" inherits="StreamPeerSocket" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
A stream peer that handles UNIX Domain Socket (UDS) connections.
|
|
</brief_description>
|
|
<description>
|
|
A stream peer that handles UNIX Domain Socket (UDS) connections. This object can be used to connect to UDS servers, or also is returned by a UDS server. Unix Domain Sockets provide inter-process communication on the same machine using the filesystem namespace.
|
|
[b]Note:[/b] UNIX Domain Sockets are only available on UNIX-like systems (Linux, macOS, etc.) and are not supported on Windows.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="bind">
|
|
<return type="int" enum="Error" />
|
|
<param index="0" name="path" type="String" />
|
|
<description>
|
|
Opens the UDS socket, and binds it to the specified socket path.
|
|
This method is generally not needed, and only used to force the subsequent call to [method connect_to_host] to use the specified [param path] as the source address.
|
|
</description>
|
|
</method>
|
|
<method name="connect_to_host">
|
|
<return type="int" enum="Error" />
|
|
<param index="0" name="path" type="String" />
|
|
<description>
|
|
Connects to the specified UNIX Domain Socket path. Returns [constant OK] on success.
|
|
</description>
|
|
</method>
|
|
<method name="get_connected_path" qualifiers="const">
|
|
<return type="String" />
|
|
<description>
|
|
Returns the socket path of this peer.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|