All Classes Files Functions Variables Pages
PacketDump.idl
Go to the documentation of this file.
1 /**
2  * @file PacketDump.idl
3  * @brief API for packet dump handling, functions related to dump
4  * @version 1
5  */
6 
7 #import <kerio/web/idl/Logs.idl>
8 #import <common.idl>
9 
10 module webadmin {
11 
13  long sizeKb;
14  boolean running;
15  boolean exists; // dump file exists on disk
16 };
17 
18 interface PacketDump {
19 
20  /**
21  * Returns expression for dialog from debug log context menu 'Dump Expression...'
22  * @throws kerio::web::ApiException \n
23  * -32001 Session expired. - "The user is not logged in." \n
24  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
25  */
26  void getExpression(out string expression);
27 
28  /**
29  * Stores expression from debug log context menu dialog 'Dump Expression...'
30  * @throws kerio::web::ApiException \n
31  * -32001 Session expired. - "The user is not logged in." \n
32  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
33  */
34  void setExpression(in string expression);
35 
36  void start();
37  void stop();
38 
39  void clear();
40 
41  void download(out kerio::web::Download fileDownload);
42  void getStatus(out PacketDumpStatus status);
43 };
44 
45 }; //webadmin
Definition: PacketDump.idl:12
Common Kerio Control structures, enums and types.
Definition: SharedStructures.idl:342
Definition: PacketDump.idl:18
Definition: Accounting.idl:11