diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-21 10:21:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-21 10:21:01 +0200 |
| commit | 1e833cadbcf1403eec85fa85b290328bc1bf5179 (patch) | |
| tree | 8c98449750f26d7b411ef2b46164826435bdbe91 /doc | |
| parent | 5c66771e3ebccdfec55bb94ea521d2f24cb6200a (diff) | |
| parent | e5e3f866484709f47c97151e99a302206df1d894 (diff) | |
Merge pull request #29935 from Faless/net/get_if_multicast_pr
Multicast, more network interfaces info
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/IP.xml | 16 | ||||
| -rw-r--r-- | doc/classes/PacketPeerUDP.xml | 23 |
2 files changed, 39 insertions, 0 deletions
diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 3616a9ec50..65b1700333 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -34,6 +34,22 @@ Returns all of the user's current IPv4 and IPv6 addresses as an array. </description> </method> + <method name="get_local_interfaces" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns all network adapters as an array. + Each adapter is a dictionary of the form: + [codeblock] + { + "index": "1", # Interface index. + "name": "eth0", # Interface name. + "friendly": "Ethernet One", # A friendly name (might be empty). + "addresses": ["192.168.1.101"], # An array of IP addresses associated to this interface. + } + [/codeblock] + </description> + </method> <method name="get_resolve_item_address" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 9843c16108..376818fb86 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -37,6 +37,29 @@ Returns whether this [PacketPeerUDP] is listening. </description> </method> + <method name="join_multicast_group"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="multicast_address" type="String"> + </argument> + <argument index="1" name="interface_name" type="String"> + </argument> + <description> + Join the multicast group specified by [code]multicast_address[/code] using the interface identified by [code]interface_name[/code]. + You can join the same multicast group with multiple interfaces. Use [method IP.get_local_interfaces] to know which are available. + </description> + </method> + <method name="leave_multicast_group"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="multicast_address" type="String"> + </argument> + <argument index="1" name="interface_name" type="String"> + </argument> + <description> + Remove the interface identified by [code]interface_name[/code] from the multicast group specified by [code]multicast_address[/code]. + </description> + </method> <method name="listen"> <return type="int" enum="Error"> </return> |