All Classes Files Functions Variables Enumerations Enumerator Groups Pages
Dumps.idl
Go to the documentation of this file.
1 /**
2  * @file Dumps.idl
3  * @brief Work with coredumps which are generated while server crashes.
4  *
5  * @author Dusan Juhas, Frantisek Boranek
6  *
7  * @copyright Copyright © 2017 Kerio Technologies s.r.o.
8  */
9 
10 #import <kerio/web/idl/SharedStructures.idl>
11 #import <common.idl> //DateTimeStamp
12 
13 module kerio {
14 module jsonapi {
15 module admin {
16 
17 struct CoreDump {
18  kerio::web::ByteValueWithUnits size;
19  DateTimeStamp timestamp;
20 };
21 
22 typedef sequence<CoreDump> DumpList;
23 
24 
25 interface Dumps {
26 
27  /**
28  * Obtain list of available crash dumps
29  *
30  * @param dumps - list of all available crash dumps
31  */
32  void get(out DumpList dumps);
33 
34  /**
35  * Remove all crash dumps from server disk
36  */
37  void remove();
38 
39  /**
40  * Upload last available crash dump to Kerio.
41  *
42  * @param description - plain text information to be sent with crash dump
43  * @param email - contact information to be sent with crash dump
44  */
45  void send(in string description, in string email);
46 };
47 
48 }; }; };//end of namespace