All Classes Files Functions Variables Pages
ConnLimit.idl
Go to the documentation of this file.
1 /**
2  * @file ConnLimit.idl
3  * @brief API for Connection limit settings
4  * @version 1
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 #import <common.idl>
9 
10 module webadmin {
11 
12 struct ConnLimitSettings {
13  kerio::web::OptionalLong srcLimit;
14  kerio::web::OptionalLong srcRateLimit;
15  kerio::web::OptionalLong dstLimit;
16  kerio::web::OptionalLong dstPerSrcLimit;
17  OptionalIdReference exclusions;
18  kerio::web::OptionalLong exclSrcLimit;
19  kerio::web::OptionalLong exclSrcRateLimit;
20 };
21 
22 interface ConnLimit {
23 
24  /**
25  * Returns Connection Limit configuration
26  * @param settings - A structure containing all the settings of Connection Limit.
27  * @throws kerio::web::ApiException \n
28  * -32001 Session expired. - "The user is not logged in." \n
29  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
30  */
31  void get(out ConnLimitSettings config);
32 
33  /**
34  * Stores Connection Limit configuration
35  * @param settings - A structure containing all the settings of Connection Limit.
36  * @throws kerio::web::ApiException \n
37  * -32001 Session expired. - "The user is not logged in." \n
38  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
39  */
40  void set(in ConnLimitSettings config);
41 };
42 
43 }; //webadmin
webadmin::ConnLimit
Definition: ConnLimit.idl:22
common.idl
Common Kerio Control structures, enums and types.
kerio::web::OptionalLong
Definition: SharedStructures.idl:298
webadmin::OptionalIdReference
Definition: common.idl:36
webadmin
Definition: Accounting.idl:11
webadmin::ConnLimitSettings
Definition: ConnLimit.idl:12