Interface net.connman.Service
Object path [variable prefix]/{service0,service1,...}
-Methods dict GetProperties()
+Methods dict GetProperties() [deprecated]
Returns properties for the service object. See
the properties section for available properties.
+ Usage of this method is highly discouraged. Use
+ the Manager.GetServices() method instead.
+
Possible Errors: [service].Error.InvalidArguments
void SetProperty(string name, variant value)
changeable. On success a PropertyChanged signal
will be emitted.
+ Properties cannot be set for hidden WiFi service
+ entries or provisioned services.
+
Possible Errors: [service].Error.InvalidArguments
[service].Error.InvalidProperty
Clears the value of the specified property.
+ Properties cannot be cleared for hidden WiFi service
+ entries or provisioned services.
+
Possible Errors: [service].Error.InvalidArguments
[service].Error.InvalidProperty
void Connect()
Connect this service. It will attempt to connect
- WiFi, WiMAX or Bluetooth services.
+ WiFi or Bluetooth services.
For Ethernet devices this method can only be used
if it has previously been disconnected. Otherwise
setting a longer D-Bus timeout might be a really
good idea.
+ Calling Connect() on a hidden WiFi service entry will
+ query the missing SSID via the Agent API causing a
+ WiFi service with the given SSID to be scanned,
+ created and connected.
+
Possible Errors: [service].Error.InvalidArguments
void Disconnect()
method will fail.
This method can also be used to abort a previous
- connectiong attempt via the Connect method.
+ connection attempt via the Connect method.
+
+ Hidden WiFi service entries cannot be disconnected
+ as they always stay in idle state.
Possible Errors: [service].Error.InvalidArguments
service is in the State=failure, this method can
also be used to reset the service.
- Calling this method on Ethernet devices will cause
- an error message. It is not possible to remove these
- kind of devices.
+ Calling this method on Ethernet devices, hidden WiFi
+ services or provisioned services will cause an error
+ message. It is not possible to remove these kind of
+ services.
Possible Errors: [service].Error.InvalidArguments
If a service has been used before, this allows a
reorder of the favorite services.
- The target service object must be part of this
- profile. Moving between profiles is not supported.
-
Possible Errors: [service].Error.InvalidArguments
void MoveAfter(object service)
If a service has been used before, this allows a
reorder of the favorite services.
- The target service object must be part of this
- profile. Moving between profiles is not supported.
-
Possible Errors: [service].Error.InvalidArguments
- void ResetCounters()
+ void ResetCounters() [experimental]
Reset the counter statistics.
The service state information.
Valid states are "idle", "failure", "association",
- "configuration", "ready" and "online".
+ "configuration", "ready", "disconnect" and "online".
The "ready" state signals a successfully
connected device. "online" signals that an
Internet connection is available and has been
verified.
+ See doc/overview-api.txt for more information about
+ state transitions.
+
string Error [readonly]
The service error status details.
The service name (for example "Wireless" etc.)
This name can be used for directly displaying it in
- the application. It has pure informational purpose.
+ the application. It has pure informational purpose
+ and no attempt should be made to translate it.
- For Ethernet devices and hidden WiFi networks it is
- not guaranteed that this property is present.
+ For Ethernet devices and hidden WiFi networks this
+ property is not present.
string Type [readonly]
advanced properties or showing the correct icon
to the user.
- string Mode [readonly]
-
- If the service type is WiFi or Cellular, then this
- property is present and contains the mode of the
- network.
-
- For WiFi services the possible values are "managed"
- and "adhoc". For Cellular services it describes the
- network technology. Possible values are "gprs", "edge"
- and "umts".
-
- This property might be only present for WiFi and
- Cellular services.
+ Together with a missing Name property, this can
+ be used to identify hidden WiFi networks.
array{string} Security [readonly]
or key management settings.
Possible values are "none", "wep", "psk", "ieee8021x"
- and also "wps". Alternate values for "psk" can also
- be "wpa" and "rsn".
+ and also "wps".
This property might be only present for WiFi
services.
- boolean LoginRequired [readonly]
-
- This property indicates that an additional login
- step, like web based authentication, is needed
- before the connection establishment can proceed.
-
- string Passphrase [readwrite]
-
- If the service type is WiFi, then this property
- can be used to store a passphrase.
-
- No PropertyChanged signals will be sent for this
- property. The PassphraseRequired property should
- be monitored instead.
-
- This property might also not always be included
- since it is protected by a different security policy.
-
- boolean PassphraseRequired [readonly]
-
- If the service type is WiFi, then this property
- indicates if a passphrase is required.
-
- If a passphrase has been set already or if no
- passphrase is needed, then this property will
- be set to false.
-
uint8 Strength [readonly]
Indicates the signal strength of the service. This
this value to prevent or permit automatic
connection attempts.
- boolean SetupRequired [readonly]
-
- If the service is Cellular, then this property
- indicates that some extra setup steps are required.
-
- In most cases it is required to fill in the APN
- details.
-
boolean Roaming [readonly]
This property indicates if this service is roaming.
array{string} Nameservers.Configuration [readwrite]
The list of manually configured domain name
- servers. Some 3G networks don't provide correct
- name servers and this allows for an override.
+ servers. Some cellular networks don't provide
+ correct name servers and this allows for an
+ override.
This array is sorted by priority and the first
entry in the list represents the nameserver with
the service. However there might be small window
where name resolution might fail.
+ array{string} Timeservers [readonly]
+
+ The list of currently active timeservers for this
+ service. If the server is not in READY or ONLINE
+ state than this list will be empty.
+
+ array{string} Timeservers.Configuration [readwrite]
+
+ The list of manually configured time servers.
+
+ The first entry in the list represents the
+ timeserver with the highest priority.
+
+ When using manual configuration this setting
+ is useful to override all the other timeserver
+ settings. This is service specific, hence only
+ the values for the default service are used.
+
+ Changes to this property will result in restart
+ of NTP query.
+
array{string} Domains [readonly]
- The list of currently used search domains.
+ The list of currently used search domains taken
+ from Domains.Configurations if set, otherwise a
+ domain name if provided by DHCP or VPNs.
array{string} Domains.Configuration [readwrite]
string Method [readonly]
- Possible values are "auto", "manual"
+ Possible values are "auto", "manual", "6to4"
and "off".
The value "fixed" indicates an IP address
that can not be modified. For example
cellular networks return fixed information.
+ The value "6to4" is returned if 6to4 tunnel
+ is created by connman. The tunnel can only be
+ created if method was set to "auto" by the
+ user. User cannot set the method to "6to4".
string Address [readonly]
string Host [readonly]
- VPN host IP.
+ VPN host IP.
string Domain [readonly]
- VPN Domain.
+ VPN Domain.
string Name [readonly]
- VPN provider Name.
+ VPN provider Name.
string Type [readonly]
- VPN provider type.
+ VPN provider type.
dict Ethernet [readonly]
The Ethernet MTU (default is 1500).
- uint16 Speed [readonly]
+ uint16 Speed [readonly] [deprecated]
Selected speed of the line.
- This information might not always be
- available.
+ This information is not available.
- string Duplex [readonly]
+ string Duplex [readonly] [deprecated]
Selected duplex settings of the line.
-
Possible values are "half" and "full".
- This information might not always be
- available.
+ This information is not available.
projects / platform / upstream / connman.git / blobdiff