All Classes Files Functions Variables Pages
P2pEliminator.idl
1 /**
2  * @file P2PEliminator.idl
3  * @brief API for P2PEliminator
4  * @version 2
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 
9 module webadmin {
10 
11 /* must be included after BandwidthLimiter */
12 
14  string ports; /**< list of ports or port ranges (e.g. "5,10-20,30") */
15  long connectionCount; /**< should be > 0 */
16  kerio::web::KIdList trustedServiceIdList; /**< list of ids of services beeing trusted not to be P2P traffic */
17 };
18 
19 interface P2pEliminator {
20 
21  /**
22  * Returns the configuration of P2P eleminator.
23  * @param config - structure with configuration of P2P eliminator.
24  * @throws kerio::web::ApiException \n
25  * -32001 Session expired. - "The user is not logged in." \n
26  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
27  */
28  void get(out P2pEliminatorConfig config);
29 
30  /**
31  * Sets the configuration of P2P eleminator.
32  * @param errors - list of errors \n
33  * 1002 No such entity. - "Some of the added services do not exist any longer."
34  * @param config - structure with configuration of P2P eliminator.
35  * @throws kerio::web::ApiException \n
36  * -32001 Session expired. - "The user is not logged in." \n
37  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
38  */
39  void set(out kerio::web::ErrorList errors, in P2pEliminatorConfig config);
40 };
41 
42 }; //webadmin
long connectionCount
Definition: P2pEliminator.idl:15
Definition: P2pEliminator.idl:19
string ports
Definition: P2pEliminator.idl:14
kerio::web::KIdList trustedServiceIdList
Definition: P2pEliminator.idl:16
Definition: P2pEliminator.idl:13
Definition: Accounting.idl:11