colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libnm: document that some return values are immutable

Browse Source 
Document that the GPtrArray returned by

  - nm_device_get_lldp_neighbors()
  - nm_ip_config_get_addresses()
  - nm_ip_config_get_routes()

is immutable and can be used by callers without the need of a copy.
This commit is contained in:
Beniamino Galvani
2015-10-09 14:51:09 +02:00
parent 0d31b95343
commit 83ac84cd7a
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
libnm/nm-device.c
View File

@@ -2075,7 +2075,8 @@ NM_BACKPORT_SYMBOL (libnm_1_0_6, NMMetered, nm_device_get_metered, (NMDevice *de
* *
* Returns: (element-type NMLldpNeighbor) (transfer none): the #GPtrArray * Returns: (element-type NMLldpNeighbor) (transfer none): the #GPtrArray
* containing #NMLldpNeighbor<!-- -->s. This is the internal copy used by the * containing #NMLldpNeighbor<!-- -->s. This is the internal copy used by the
* device and must not be modified. * device and must not be modified. The library never modifies the returned
* array and thus it is safe for callers to reference and keep using it.
* *
* Since: 1.2 * Since: 1.2
**/ **/

7
libnm/nm-ip-config.c
View File

@@ -406,7 +406,8 @@ nm_ip_config_get_gateway (NMIPConfig *config)
* *
* Returns: (element-type NMIPAddress) (transfer none): the #GPtrArray * Returns: (element-type NMIPAddress) (transfer none): the #GPtrArray
* containing #NMIPAddress<!-- -->es. This is the internal copy used by the * containing #NMIPAddress<!-- -->es. This is the internal copy used by the
* configuration and must not be modified. * configuration and must not be modified. The library never modifies the
* returned array and thus it is safe for callers to reference and keep using it.
**/ **/
GPtrArray * GPtrArray *
nm_ip_config_get_addresses (NMIPConfig *config) nm_ip_config_get_addresses (NMIPConfig *config)
@@ -491,7 +492,9 @@ nm_ip_config_get_wins_servers (NMIPConfig *config)
* *
* Returns: (element-type NMIPRoute) (transfer none): the #GPtrArray containing * Returns: (element-type NMIPRoute) (transfer none): the #GPtrArray containing
* #NMIPRoutes. This is the internal copy used by the configuration, and must * #NMIPRoutes. This is the internal copy used by the configuration, and must
* not be modified. * not be modified. The library never modifies the returned array and thus it is
* safe for callers to reference and keep using it.
*
**/ **/
GPtrArray * GPtrArray *
nm_ip_config_get_routes (NMIPConfig *config) nm_ip_config_get_routes (NMIPConfig *config)