Add support to get PMF information
[platform/upstream/connman.git] / doc / clock-api.txt
1 Clock hierarchy
2 ===============
3
4 Service         net.connman
5 Interface       net.connman.Clock
6 Object path     /
7
8 Methods         dict GetProperties()  [experimental]
9
10                         Returns all system clock properties. See the
11                         properties section for available properties.
12
13                         Possible Errors: [service].Error.InvalidArguments
14
15                 void SetProperty(string name, variant value)  [experimental]
16
17                         Changes the value of the specified property. Only
18                         properties that are listed as read-write are
19                         changeable. On success a PropertyChanged signal
20                         will be emitted.
21
22                         Possible Errors: [service].Error.InvalidArguments
23                                          [service].Error.InvalidProperty
24
25 Signals         PropertyChanged(string name, variant value)  [experimental]
26
27                         This signal indicates a changed value of the given
28                         property.
29
30
31 Properties      uint64 Time [readonly or readwrite]  [experimental]
32
33                         Current system time in seconds since epoch.
34
35                         This value is present for changing the system time
36                         if TimeUpdates is set to manual.
37
38                         It is not present for driving an updated display
39                         of the system time. PropertyChanged signal for this
40                         value are only send out if it gets changed or jumps
41                         unexpectedly.
42
43                         In general application interested in the current
44                         time should be using gettimeofday() and related
45                         system calls.
46
47                 string TimeUpdates [readwrite]  [experimental]
48
49                         Possible values are "manual" and "auto" to indicate
50                         time update policy.
51
52                         With the "auto" setting the system tries to use as
53                         many sources as possible to determine the correct
54                         and updated time.
55
56                 string Timezone [readonly or readwrite]  [experimental]
57
58                         Current system timezone string. Allowed values
59                         are from the standard timezone data (tzdata)
60                         package under /usr/share/zoneinfo. For example
61                         strings like "America/Vancouver" or "Europe/Berlin".
62
63                         This value is present for changing the timezone
64                         if TimezoneUpdates is set to manual.
65
66                         When the timezone gets changed a PropertyChanged
67                         signal will be send out.
68
69                 string TimezoneUpdates [readwrite]  [experimental]
70
71                         Possible values are "manual" and "auto" to indicate
72                         timezone update policy.
73
74                         With the "auto" setting the system tries to use as
75                         many sources as possible to determine the correct
76                         timezone.
77
78                 array{string} Timeservers [readwrite]  [experimental]
79
80                         List of global default NTP servers. The list should
81                         be sorted in order of preference.
82
83                         If a service configuration provides NTP servers,
84                         then they are preferred over the global ones.
85
86                         This list of servers is used when TimeUpdates is set
87                         to auto.