summaryrefslogtreecommitdiff
path: root/doc/clock-api.txt
blob: 6818f5a826ea306a6e9c0a9893d816bf322db6ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
Clock hierarchy
===============

Service		net.connman
Interface	net.connman.Clock
Object path	/

Methods		dict GetProperties()  [experimental]

			Returns all system clock properties. See the
			properties section for available properties.

			Possible Errors: [service].Error.InvalidArguments

		void SetProperty(string name, variant value)  [experimental]

			Changes the value of the specified property. Only
			properties that are listed as read-write are
			changeable. On success a PropertyChanged signal
			will be emitted.

			Possible Errors: [service].Error.InvalidArguments
					 [service].Error.InvalidProperty

Signals		PropertyChanged(string name, variant value)  [experimental]

			This signal indicates a changed value of the given
			property.


Properties	uint64 Time [readonly or readwrite]  [experimental]

			Current system time in seconds since epoch.

			This value is present for changing the system time
			if TimeUpdates is set to manual.

			It is not present for driving an updated display
			of the system time. PropertyChanged signal for this
			value are only send out if it gets changed or jumps
			unexpectedly.

			In general application interested in the current
			time should be using gettimeofday() and related
			system calls.

		string TimeUpdates [readwrite]  [experimental]

			Possible values are "manual" and "auto" to indicate
			time update policy.

			With the "auto" setting the system tries to use as
			many sources as possible to determine the correct
			and updated time.

		string Timezone [readonly or readwrite]  [experimental]

			Current system timezone string. Allowed values
			are from the standard timezone data (tzdata)
			package under /usr/share/zoneinfo. For example
			strings like "America/Vancouver" or "Europe/Berlin".

			This value is present for changing the timezone
			if TimezoneUpdates is set to manual.

			When the timezone gets changed a PropertyChanged
			signal will be send out.

		string TimezoneUpdates [readwrite]  [experimental]

			Possible values are "manual" and "auto" to indicate
			timezone update policy.

			With the "auto" setting the system tries to use as
			many sources as possible to determine the correct
			timezone.

		array{string} Timeservers [readwrite]  [experimental]

			List of global default NTP servers. The list should
			be sorted in order of preference.

			If a service configuration provides NTP servers,
			then they are preferred over the global ones.

			This list of servers is used when TimeUpdates is set
			to auto.