4c91412be5d6196ef049f10abcd6b15339de82ed
[platform/upstream/csf-framework.git] / framework / IpcMacros.h
1 /*
2     Copyright (c) 2014, McAfee, Inc.
3     
4     All rights reserved.
5     
6     Redistribution and use in source and binary forms, with or without modification,
7     are permitted provided that the following conditions are met:
8     
9     Redistributions of source code must retain the above copyright notice, this list
10     of conditions and the following disclaimer.
11     
12     Redistributions in binary form must reproduce the above copyright notice, this
13     list of conditions and the following disclaimer in the documentation and/or other
14     materials provided with the distribution.
15     
16     Neither the name of McAfee, Inc. nor the names of its contributors may be used
17     to endorse or promote products derived from this software without specific prior
18     written permission.
19     
20     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23     IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
24     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25     BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
28     OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29     OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef IPCMACROS_H
33 #define IPCMACROS_H
34
35 /**
36  * \file IpcMacros.h
37  * \brief Common constants and macros Header File
38  *  
39  * This file provides the constants and macros for IPC used by Security framework.
40  */
41
42 #define TSC_DBUS_SERVER_GENERIC_STUB "com.tsc.ipc.server.generic"
43 #define TSC_DBUS_SERVER_WP_CHANNEL "com.tsc.ipc.server.wp"
44 #define TSC_DBUS_SERVER_PLUGIN_CHANNEL "com.tsc.ipc.server.plugin"
45 #define TSC_DBUS_SERVER_INTEGRITY_TEST_STUB "com.tsc.ipc.server.integrity"
46
47 #define TSC_DBUS_SERVER        "com.tsc.ipc.server"
48 #define TSC_DBUS_INTERFACE     "org.tsc.ipc.interface"
49 #define TSC_DBUS_PATH          "/org/tsc/ipc/path"
50 #define TSC_DBUS_CLIENT        "com.tsc.ipc.client"
51 #define TSC_FN_FETCHLIST       "FetchList"
52 #define TSC_FN_CANCELMETHOD    "_Cancel_"
53 #define TSC_FN_PROGRESSMETHOD  "_Progress_"
54 #define TSC_FN_SHUTDOWN "IpcShutdown"
55
56 #define TSC_MID_PREFIX_FORMAT  "%u_%lu_"
57 #define TSC_MID_FORMAT         TSC_MID_PREFIX_FORMAT"%u"
58 #define TSC_MID_SVR_FORMAT     "%s%u"
59
60 #define TSC_READ_WRITE_DISPATCH_SLEEP_SECONDS   1
61 #define TSC_SEND_MESSAGE_REPLY_TIME     5000
62
63 #define TSC_THREAD_POOL_NUMBERS 3
64
65 #define TSC_REQ_STR_LEN         128
66 #define TSC_INFO_RULE_LEN       128
67 #define TSC_SERVER_NAME_LEN 128
68 #define TSC_METHOD_NAME_LEN 128
69
70 #define TSC_REPLY_MSG_COUNT_AVERAGE 4
71
72
73 // Client side call handle length.
74 // TODO: Reduce size by avoiding string type handle.
75 #define MSGHANDLE_LEN   25
76
77 typedef enum
78 {
79     TSC_CANCEL = -1,
80     TSC_PROGRESS = 0
81 } TSC_METHOD_REASON_CODE;
82
83 #define TSC_IS_CANCEL   0
84 #define TSC_NON_CANCEL   1;
85
86 #endif  /* IPCMACROS_H */
87