/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to DBUS-API

  • Committer: Teddy Hogeborn
  • Date: 2015-08-02 16:45:29 UTC
  • Revision ID: teddy@recompile.se-20150802164529-pemtk1agiqluoiua
Deprecate some D-Bus methods in favor of D-Bus properties.

The following D-Bus methods on the interface
"se.recompile.Mandos.Client" are redundant, and are therefore
deprecated:  "Disable", "Enable", "StartChecker", and "StopChecker".
Instead, the D-Bus properties "Enabled" and "CheckerRunning" should be
set, as was always also possible.

* DBUS-API (se.recompile.Mandos.Client.Disable): Remove; deprecated.
  (se.recompile.Mandos.Client.Enable): - '' -
  (se.recompile.Mandos.Client.StartChecker): - '' -
  (se.recompile.Mandos.Client.StopChecker): - '' -
* mandos (ClientDBus.Enable): Annotate as deprecated.
  (ClientDBus.StartChecker): - '' -
  (ClientDBus.Disable): - '' -
  (ClientDBus.StopChecker): - '' -
* mandos-monitor (MandosClientWidget.keypress): Set properties instead
                                                of calling deprecated
                                                methods.

Show diffs side-by-side

added added

removed removed

Lines of Context:
DBUS-API
55
55
    Assert that this client has been checked and found to be alive.
56
56
    This will restart the timeout before disabling this client.  See
57
57
    also the "LastCheckedOK" property.
58
 
    
59
 
*** Disable() → nothing
60
 
    Disable this client.  See also the "Enabled" property.
61
 
    
62
 
*** Enable() → nothing
63
 
    Enable this client.  See also the "Enabled" property.
64
 
    
65
 
*** StartChecker() → nothing
66
 
    Start a new checker for this client, if none is currently
67
 
    running.  See also the "CheckerRunning" property.
68
 
    
69
 
*** StopChecker() → nothing
70
 
    Abort a running checker process for this client, if any.  See also
71
 
    the "CheckerRunning" property.
72
58
 
73
59
** Properties
74
60
   
104
90
   
105
91
   b) An approval is currently pending.
106
92
   
107
 
   c) Setting this property is equivalent to calling StartChecker() or
108
 
      StopChecker().
 
93
   c) Changing this property can either start a new checker or abort a
 
94
      running one.
109
95
   
110
96
   d) The creation time of this client object, as an RFC 3339 string.
111
97
   
112
 
   e) Setting this property is equivalent to calling Enable() or
113
 
      Disable().
 
98
   e) Changing this property enables or disables a client.
114
99
   
115
100
   f) The date and time this client will be disabled, as an RFC 3339
116
101
      string, or an empty string if this is not scheduled.
134
119
   k) A raw byte array, not hexadecimal digits.
135
120
 
136
121
** Signals
137
 
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
122
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
138
123
    A checker (Command) has completed.  Exitcode is either the exit
139
 
    code or -1 for abnormal exit.  In any case, the full Waitstatus
140
 
    (as from wait(2)) is also available.
 
124
    code or -1 for abnormal exit, in which case, the signal number
 
125
    is available.
141
126
    
142
127
*** CheckerStarted(s: Command)
143
128
    A checker command (Command) has just been started.
150
135
    milliseconds, depending on ApprovedByDefault.  Approve() can now
151
136
    usefully be called on this client object.
152
137
    
153
 
*** PropertyChanged(s: Property, v: Value)
154
 
    The Property on this client has changed to Value.
155
 
    
156
138
*** Rejected(s: Reason)
157
139
    This client was not given its secret for a specified Reason.
158
140
 
159
141
* Copyright
160
142
 
161
 
    Copyright © 2010-2012 Teddy Hogeborn
162
 
    Copyright © 2010-2012 Björn Påhlsson
 
143
    Copyright © 2010-2015 Teddy Hogeborn
 
144
    Copyright © 2010-2015 Björn Påhlsson
163
145
  
164
146
** License:
165
147