From 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 23 Aug 2011 19:16:47 +0200 Subject: Imported Upstream version 0.9.0 --- docs/libnm-util/html/NMSettingIP4Config.html | 885 ++++++++++++++++++++++++++- 1 file changed, 859 insertions(+), 26 deletions(-) (limited to 'docs/libnm-util/html/NMSettingIP4Config.html') diff --git a/docs/libnm-util/html/NMSettingIP4Config.html b/docs/libnm-util/html/NMSettingIP4Config.html index 6a701adf..488f842a 100644 --- a/docs/libnm-util/html/NMSettingIP4Config.html +++ b/docs/libnm-util/html/NMSettingIP4Config.html @@ -35,13 +35,16 @@

NMSettingIP4Config

-

NMSettingIP4Config

+

NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties

Synopsis

-
#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
+
+#include <nm-setting-ip4-config.h>
+
+#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
 enum                NMSettingIP4ConfigError;
 #define             NM_TYPE_SETTING_IP4_CONFIG_ERROR
 #define             NM_SETTING_IP4_CONFIG_ERROR
@@ -83,7 +86,7 @@ typedef             
 typedef             NMIP4Route;
 GType               nm_ip4_route_get_type               (void);
 NMIP4Route *        nm_ip4_route_new                    (void);
-NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *route);
+NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);
 void                nm_ip4_route_ref                    (NMIP4Route *route);
 void                nm_ip4_route_unref                  (NMIP4Route *route);
 gboolean            nm_ip4_route_compare                (NMIP4Route *route,
@@ -201,6 +204,8 @@ const char *        
 
Description

 

+The NMSettingIP4Config object is a NMSetting subclass that describes
+properties related to IPv4 addressing, routing, and Domain Name Service
@@ -215,16 +220,40 @@ const char *

enum NMSettingIP4ConfigError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN = 0,
 	NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY,
 	NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY,
 	NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD
 } NMSettingIP4ConfigError;
 

-

-

+

++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+


NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN
unknown or unclassified error
+
NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY
the property was invalid
+
NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY
the property was missing and is
+required
+
NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD
the property's value is
+not valid with the given IP4 method
+
@@ -247,7 +276,15 @@ const char *

nm_setting_ip4_config_error_quark ()

GQuark              nm_setting_ip4_config_error_quark   (void);

+Registers an error quark for NMSettingIP4Config if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingIP4Config errors.
@@ -351,6 +388,9 @@ const char * #define NM_SETTING_IP4_CONFIG_METHOD_AUTO "auto"

+IPv4 configuration should be automatically determined via a method appropriate +for the hardware interface, ie DHCP or PPP or some other device-specific +manner.

@@ -359,6 +399,8 @@ const char * #define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"

+IPv4 configuration should be automatically configured for link-local-only +operation.

@@ -367,6 +409,8 @@ const char * #define NM_SETTING_IP4_CONFIG_METHOD_MANUAL "manual"

+All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties.

@@ -375,6 +419,12 @@ const char * #define NM_SETTING_IP4_CONFIG_METHOD_SHARED "shared"

+This connection specifies configuration that allows other computers to +connect through it to the default network (usually the Internet). The +connection's interface will be assigned a private address, and a DHCP server, +caching DNS server, and Network Address Translation (NAT) functionality will +be started on this connection's interface to allow other devices to connect +through that interface to the default network.

@@ -383,6 +433,7 @@ const char * #define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled"

+This connection does not use or require IPv4 address and it should be disabled.

@@ -405,28 +456,71 @@ const char *

nm_ip4_address_new ()

NMIP4Address *      nm_ip4_address_new                  (void);

+Creates and returns a new NMIP4Address object.

+
++ + + + +

Returns :

the new empty NMIP4Address object. [transfer full] +

nm_ip4_address_dup ()

NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);

+Copies a given NMIP4Address object and returns the copy.

+
++ + + + + + + + + + +

source :

the NMIP4Address object to copy

Returns :

the copy of the given NMIP4Address copy. [transfer full] +

nm_ip4_address_ref ()

void                nm_ip4_address_ref                  (NMIP4Address *address);

+Increases the reference count of the object.

+
++ + + + +

address :

the NMIP4Address +

nm_ip4_address_unref ()

void                nm_ip4_address_unref                (NMIP4Address *address);

+Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

+
++ + + + +

address :

the NMIP4Address +
@@ -434,14 +528,49 @@ const char * gboolean nm_ip4_address_compare (NMIP4Address *address, NMIP4Address *other);

+Determines if two NMIP4Address objects contain the same values.

+
++ + + + + + + + + + + + + + +

address :

the NMIP4Address +

other :

the NMIP4Address to compare address to.

Returns :

 +TRUE if the objects contain the same values, FALSE if they do not.

nm_ip4_address_get_address ()

guint32             nm_ip4_address_get_address          (NMIP4Address *address);

+Gets the IPv4 address property of this address object.

+
++ + + + + + + + + + +

address :

the NMIP4Address +

Returns :

the IPv4 address in network byte order
@@ -449,14 +578,45 @@ const char * void nm_ip4_address_set_address (NMIP4Address *address, guint32 addr);

+Sets the IPv4 address property of this object.

+
++ + + + + + + + + + +

address :

the NMIP4Address +

addr :

the IPv4 address in network byte order

nm_ip4_address_get_prefix ()

guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);

+Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address +object.

+
++ + + + + + + + + + +

address :

the NMIP4Address +

Returns :

the IPv4 address prefix
@@ -464,14 +624,44 @@ const char * void nm_ip4_address_set_prefix (NMIP4Address *address, guint32 prefix);

+Sets the IPv4 address prefix.

+
++ + + + + + + + + + +

address :

the NMIP4Address +

prefix :

the address prefix, a number between 1 and 32 inclusive

nm_ip4_address_get_gateway ()

guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);

+Gets the IPv4 default gateway property of this address object.

+
++ + + + + + + + + + +

address :

the NMIP4Address +

Returns :

the IPv4 gateway address in network byte order
@@ -479,7 +669,22 @@ const char * void nm_ip4_address_set_gateway (NMIP4Address *address, guint32 gateway);

+Sets the IPv4 default gateway property of this address object.

+
++ + + + + + + + + + +

address :

the NMIP4Address +

gateway :

the IPv4 default gateway in network byte order
@@ -501,28 +706,71 @@ const char *

nm_ip4_route_new ()

NMIP4Route *        nm_ip4_route_new                    (void);

+Creates and returns a new NMIP4Route object.

+
++ + + + +

Returns :

the new empty NMIP4Route object. [transfer full] +

nm_ip4_route_dup ()

-
NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *route);
+
NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);

+Copies a given NMIP4Route object and returns the copy.

+
++ + + + + + + + + + +

source :

the NMIP4Route object to copy

Returns :

the copy of the given NMIP4Route copy. [transfer full] +

nm_ip4_route_ref ()

void                nm_ip4_route_ref                    (NMIP4Route *route);

+Increases the reference count of the object.

+
++ + + + +

route :

the NMIP4Route +

nm_ip4_route_unref ()

void                nm_ip4_route_unref                  (NMIP4Route *route);

+Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

+
++ + + + +

route :

the NMIP4Route +
@@ -530,14 +778,49 @@ const char * gboolean nm_ip4_route_compare (NMIP4Route *route, NMIP4Route *other);

+Determines if two NMIP4Route objects contain the same values.

+
++ + + + + + + + + + + + + + +

route :

the NMIP4Route +

other :

the NMIP4Route to compare route to.

Returns :

 +TRUE if the objects contain the same values, FALSE if they do not.

nm_ip4_route_get_dest ()

guint32             nm_ip4_route_get_dest               (NMIP4Route *route);

+Gets the IPv4 destination address property of this route object.

+
++ + + + + + + + + + +

route :

the NMIP4Route +

Returns :

the IPv4 address in network byte order
@@ -545,14 +828,44 @@ const char * void nm_ip4_route_set_dest (NMIP4Route *route, guint32 dest);

+Sets the IPv4 destination address property of this route object.

+
++ + + + + + + + + + +

route :

the NMIP4Route +

dest :

the destination address in network byte order

nm_ip4_route_get_prefix ()

guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);

+Gets the IPv4 prefix (ie "24" or "30" etc) of this route.

+
++ + + + + + + + + + +

route :

the NMIP4Route +

Returns :

the IPv4 prefix
@@ -560,14 +873,44 @@ const char * void nm_ip4_route_set_prefix (NMIP4Route *route, guint32 prefix);

+Sets the IPv4 prefix of this route.

+
++ + + + + + + + + + +

route :

the NMIP4Route +

prefix :

the prefix, a number between 1 and 32 inclusive

nm_ip4_route_get_next_hop ()

guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);

+Gets the IPv4 address of the next hop of this route.

+
++ + + + + + + + + + +

route :

the NMIP4Route +

Returns :

the IPv4 address in network byte order
@@ -575,14 +918,45 @@ const char * void nm_ip4_route_set_next_hop (NMIP4Route *route, guint32 next_hop);

+Sets the IPv4 address of the next hop of this route.

+
++ + + + + + + + + + +

route :

the NMIP4Route +

next_hop :

the IPv4 address of the next hop in network byte order

nm_ip4_route_get_metric ()

guint32             nm_ip4_route_get_metric             (NMIP4Route *route);

+Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

+
++ + + + + + + + + + +

route :

the NMIP4Route +

Returns :

the route metric
@@ -590,7 +964,23 @@ const char * void nm_ip4_route_set_metric (NMIP4Route *route, guint32 metric);

+Sets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

+
++ + + + + + + + + + +

route :

the NMIP4Route +

metric :

the route metric
@@ -627,29 +1017,80 @@ const char *

nm_setting_ip4_config_new ()

NMSetting *         nm_setting_ip4_config_new           (void);

+Creates a new NMSettingIP4Config object with default values.

+
++ + + + +

Returns :

the new empty NMSettingIP4Config object. [transfer full] +

nm_setting_ip4_config_get_method ()

const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

the "method" property of the setting

nm_setting_ip4_config_get_num_dns ()

guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

the number of configured DNS servers

nm_setting_ip4_config_get_dns ()

guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
                                                          guint32 i);
-

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP4Config +

i :

index number of the DNS server to return

Returns :

the IPv4 address (network byte order) of the DNS server at index +i +
@@ -657,7 +1098,28 @@ const char * gboolean nm_setting_ip4_config_add_dns (NMSettingIP4Config *setting, guint32 dns);

+Adds a new DNS server to the setting.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP4Config +

dns :

the IPv4 address (network byte order) of the DNS server to add

Returns :

 +TRUE if the DNS server was added; FALSE if the server was already +known
@@ -665,22 +1127,58 @@ const char * void nm_setting_ip4_config_remove_dns (NMSettingIP4Config *setting, guint32 i);

+Removes the DNS server at index i.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

i :

index number of the DNS server to remove

nm_setting_ip4_config_clear_dns ()

void                nm_setting_ip4_config_clear_dns     (NMSettingIP4Config *setting);

+Removes all configured DNS servers.

+
++ + + + +

setting :

the NMSettingIP4Config +

nm_setting_ip4_config_get_num_dns_searches ()

guint32             nm_setting_ip4_config_get_num_dns_searches
                                                         (NMSettingIP4Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

the number of configured DNS search domains
@@ -688,8 +1186,25 @@ const char * const char * nm_setting_ip4_config_get_dns_search (NMSettingIP4Config *setting, guint32 i); -

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP4Config +

i :

index number of the DNS search domain to return

Returns :

the DNS search domain at index i +
@@ -698,7 +1213,28 @@ const char * NMSettingIP4Config *setting, const char *dns_search);

+Adds a new DNS search domain to the setting.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP4Config +

dns_search :

the search domain to add

Returns :

 +TRUE if the DNS search domain was added; FALSE if the search +domain was already known
@@ -707,7 +1243,22 @@ const char * NMSettingIP4Config *setting, guint32 i);

+Removes the DNS search domain at index i.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

i :

index number of the DNS search domain
@@ -715,23 +1266,61 @@ const char * void nm_setting_ip4_config_clear_dns_searches (NMSettingIP4Config *setting);

+Removes all configured DNS search domains.

+
++ + + + +

setting :

the NMSettingIP4Config +

nm_setting_ip4_config_get_num_addresses ()

guint32             nm_setting_ip4_config_get_num_addresses
                                                         (NMSettingIP4Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

the number of configured addresses

nm_setting_ip4_config_get_address ()

NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
                                                          guint32 i);
-

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP4Config +

i :

index number of the address to return

Returns :

the address at index i +
@@ -739,7 +1328,29 @@ const char * gboolean nm_setting_ip4_config_add_address (NMSettingIP4Config *setting, NMIP4Address *address);

+Adds a new IPv4 address and associated information to the setting. The +given address is duplicated internally and is not changed by this function.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP4Config +

address :

the new address to add

Returns :

 +TRUE if the address was added; FALSE if the address was already +known.
@@ -748,7 +1359,22 @@ const char * NMSettingIP4Config *setting, guint32 i);

+Removes the address at index i.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

i :

index number of the address to remove
@@ -756,23 +1382,61 @@ const char * void nm_setting_ip4_config_clear_addresses (NMSettingIP4Config *setting);

+Removes all configured addresses.

+
++ + + + +

setting :

the NMSettingIP4Config +

nm_setting_ip4_config_get_num_routes ()

guint32             nm_setting_ip4_config_get_num_routes
                                                         (NMSettingIP4Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

the number of configured routes

nm_setting_ip4_config_get_route ()

NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
                                                          guint32 i);
-

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP4Config +

i :

index number of the route to return

Returns :

the route at index i +
@@ -780,7 +1444,28 @@ const char * gboolean nm_setting_ip4_config_add_route (NMSettingIP4Config *setting, NMIP4Route *route);

+Adds a new IPv4 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP4Config +

route :

the route to add

Returns :

 +TRUE if the route was added; FALSE if the route was already known.
@@ -788,14 +1473,38 @@ const char * void nm_setting_ip4_config_remove_route (NMSettingIP4Config *setting, guint32 i);

+Removes the route at index i.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

i :

index number of the route

nm_setting_ip4_config_clear_routes ()

void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);

+Removes all configured routes.

+
++ + + + +

setting :

the NMSettingIP4Config +
@@ -803,7 +1512,25 @@ const char * gboolean nm_setting_ip4_config_get_ignore_auto_routes (NMSettingIP4Config *setting);

+Returns the value contained in the "ignore-auto-routes" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

 +TRUE if automatically configured (ie via DHCP) routes should be +ignored.
@@ -811,7 +1538,25 @@ const char * gboolean nm_setting_ip4_config_get_ignore_auto_dns (NMSettingIP4Config *setting);

+Returns the value contained in the "ignore-auto-dns" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

 +TRUE if automatically configured (ie via DHCP) DNS information +should be ignored.
@@ -819,7 +1564,24 @@ const char * const char * nm_setting_ip4_config_get_dhcp_client_id (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-client-id" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.
@@ -827,7 +1589,26 @@ const char * gboolean nm_setting_ip4_config_get_dhcp_send_hostname (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-send-hostname" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

 +TRUE if NetworkManager should send the machine hostname to the +DHCP server when requesting addresses to allow the server to automatically +update DNS information for this machine.
@@ -835,7 +1616,23 @@ const char * const char * nm_setting_ip4_config_get_dhcp_hostname (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-hostname" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

the configured hostname to send to the DHCP server
@@ -843,14 +1640,50 @@ const char * gboolean nm_setting_ip4_config_get_never_default (NMSettingIP4Config *setting);

+Returns the value contained in the "never-default" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

 +TRUE if this connection should never be the default connection +for IPv4 addressing

nm_setting_ip4_config_get_may_fail ()

gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);

+Returns the value contained in the "may-fail" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

 +TRUE if this connection doesn't require IPv4 addressing to complete +for the connection to succeed.
-- cgit 1.3.0-6-gf8a5