Home | History | Annotate | Download | only in doc
      1 IP Configuration Handling
      2 *************************
      3 
      4 
      5 IP basics
      6 =========
      7 
      8 Layer 3 configuration state is managed on a per-device basis.  When
      9 a device is connected, it will have an IPConifg record associated with
     10 it.  In addition, connected services will have an "IPConfig" property
     11 which will contain the path to this record.  These properties of the
     12 IPConfig record represent the current state of connectivity of the
     13 device.
     14 
     15 IPConfig hierarchy
     16 ==================
     17 
     18 Service		org.chromium.flimflam
     19 Interface	org.chromium.flimflam.IPConfig
     20 Object path	[variable prefix]/{ipconfig0,ipconfig1,...}
     21 
     22 Methods		dict GetProperties()
     23 
     24 			Return properties for the IPConfig object. See
     25 			the properties section for available properties.
     26 
     27 		void Refresh()
     28 
     29 			Cause the IP configuration to be refreshed.  In
     30 			the case of DHCP configurations, the lease is
     31 			renewed, and any Static IP configuration from
     32 			the service is re-applied.
     33 
     34 Signals		PropertyChanged(string name, variant value)
     35 
     36 			This signal indicates a changed value of the given
     37 			property.
     38 
     39 Properties	string Address [readonly]
     40 
     41 			The Layer 3 address expressed in the dotted-quad format
     42 			for IPv4 and any allowed format for IPv6 (as specified
     43 			for inet_pton(3)).
     44 
     45 		string Broadcast [readonly]
     46 
     47 			The Layer 3 broadcast address specified as per Address.
     48 
     49 		string DomainName [readonly]
     50 
     51 			The DNS domain name to use in building FQDN queries.
     52 
     53 		string Gateway [readonly]
     54 
     55 			The Layer 3 address gateway address specified as
     56 			per Address.
     57 
     58 		string Method [readonly]
     59 
     60 			The method by which Layer 3 state is managed.
     61 
     62 			Possible methods are:
     63 			   "ipv4"       (fixed IPv4 network state)
     64 			   "ipv6"       (fixed IPv6 network state)
     65 			   "dhcp"       (IPv4 state setup using DHCP)
     66 			   "bootp"      (IPv4 state setup using BOOTP)
     67 			   "zeroconf"   (IPV4 state setup using ZeroConf)
     68 			   "dhcp6"      (IPv6 state setup using DHCP6)
     69 			   "ppp"        (IPv4 state setup using PPP)
     70 			   "vpn"        (IPv4 state setup using VPN)
     71 
     72 		int32 Mtu [readonly]
     73 
     74 			The maximum transmit unit (MTU) in bytes.
     75 
     76 		array{string} NameServers [readonly]
     77 
     78 			The Layer 3 addresses of DNS domain name servers to
     79 			use for DNS requests.
     80 
     81 		string PeerAddress [readonly]
     82 
     83 			The Layer 3 address associated with the destination
     84 			endpoint of a point-to-point link.  This value is
     85 			specified as per Address.
     86 
     87 		int32 Prefixlen [readonly]
     88 
     89 			The number of bits in a Layer 3 address that are
     90 			part of the network address.  For IPv4 networks this
     91 			corresponds to the length of the network mask; e.g.
     92 			a netmask of 255.255.255.0 has a prefixlen of 24
     93 			(note arbitrary CIDR masks are not supported.)
     94 
     95 		array{uint8} VendorEncapsulatedOptions [readonly]
     96 
     97 			Server-provided value for the DHCP option 43
     98 			value.  Its interpretation varies based on
     99 			the DHCP server.
    100 
    101 		string WebProxyAutoDiscoveryUrl [readonly]
    102 
    103 			The Web Proxy Auto-Discovery URL for this network
    104 			as reported over DHCP.
    105