All Classes Files Functions Variables Pages
ActiveConnections.idl
Go to the documentation of this file.
1 /**
2  * @file ActiveConnections.idl
3  * @brief Active Connections API
4  * @version 2
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 
9 module webadmin {
10 
11 enum ConnectionDirection {
12  ConnectionDirectionInbound,
13  ConnectionDirectionOutbound,
14  ConnectionDirectionLocal
15 };
16 
18  string host;
19  kerio::web::IpAddress ip;
20  kerio::web::KId country;
21  long port;
22 };
23 
25  kerio::web::KId id;
26  ConnectionPoint src;
27  ConnectionPoint dst;
28  string protocol;
29  long timeout;
30  long age;
31  string rx; /**< in KB, obsolete */
32  string tx; /**< in KB, obsolete */
33  double rxNum; /**< in KB */
34  double txNum; /**< in KB */
35  string info;
36  boolean active;
37  ConnectionDirection direction;
38  string trafficRule;
39  string service;
40  string internetLink;
41  string bandwidthRuleName;
42 };
43 
44 typedef sequence<ActiveConnection> ActiveConnectionList;
45 
46 interface ActiveConnections {
47 
48  /**
49  * Returns Active Connections data
50  *
51  * @param list - output data
52  * @param totalItems - all data count
53  * @param query - filter/sort query \n
54  * Hide local connections is solved as: \n
55  * operandValue = 'direction' \n
56  * isColumnName = true \n
57  * comparator = NotEq \n
58  * operandValue = ConnectionDirectionLocal \n
59  * isColumnName = false
60  *
61  * @param refresh - true in case, that data snapshot have to be refreshed
62  * @param hostId - return data only for this host id
63  * @throws kerio::web::ApiException \n
64  * -32001 Session expired. - "The user is not logged in." \n
65  * 1004 Access denied - "Insufficient rights to perform the requested operation."
66  */
67  void get(out ActiveConnectionList list, out long totalItems, in kerio::web::SearchQuery query, in boolean refresh, in kerio::web::KId hostId);
68 
69  /**
70  * Kills connections specified in ids list
71  *
72  * @throws kerio::web::ApiException \n
73  * -32001 Session expired. - "The user is not logged in." \n
74  * 1004 Access denied - "Insufficient rights to perform the requested operation."
75  */
76  void kill(in kerio::web::KIdList ids);
77 
78 };
79 
80 };//webadmin
81 
double txNum
Definition: ActiveConnections.idl:34
Definition: SharedStructures.idl:139
Definition: ActiveConnections.idl:24
double rxNum
Definition: ActiveConnections.idl:33
Definition: ActiveConnections.idl:46
string tx
Definition: ActiveConnections.idl:32
Definition: Accounting.idl:11
string rx
Definition: ActiveConnections.idl:31
Definition: ActiveConnections.idl:17