RTI Connext Micro  Version 2.4.1.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
wh_sm_history.h
Go to the documentation of this file.
1 /*
2  * FILE: wh_sm_history.h - Writer History API
3  *
4  * (c) Copyright 2011-2014 Real-Time Innovations,
5  *
6  * All rights reserved.
7  *
8  * No duplications, whole or partial, manual or electronic, may be made
9  * without express written permission. Any such copies, or
10  * revisions thereof, must display this notice unaltered.
11  * This code contains trade secrets of Real-Time Innovations, Inc.
12  *
13  * Modification History
14  * --------------------
15  * 16aug2011,tk Created
16  */
17 /*ce
18  * \file
19  * \brief Writer History API
20  */
21 /*ci \addtogroup WHSMModule
22  * @{
23  */
24 #ifndef wh_sm_history_h
25 #define wh_sm_history_h
26 
27 #ifndef wh_sm_dll_h
28 #include "wh_sm/wh_sm_dll.h"
29 #endif
30 #ifndef osapi_heap_h
31 #include "osapi/osapi_heap.h"
32 #endif
33 #ifndef osapi_mutex_h
34 #include "osapi/osapi_mutex.h"
35 #endif
36 #ifndef osapi_time_h
37 #include "osapi/osapi_time.h"
38 #endif
39 #ifndef osapi_system_h
40 #include "osapi/osapi_system.h"
41 #endif
42 #ifndef reda_buffer_h
43 #include "reda/reda_buffer.h"
44 #endif
45 #ifndef dds_c_discovery_plugin_h
46 #include "dds_c/dds_c_discovery_plugin.h"
47 #endif
48 #ifndef dds_c_discovery_h
49 #include "dds_c/dds_c_discovery.h"
50 #endif
51 #ifndef dds_c_type_h
52 #include "dds_c/dds_c_type.h"
53 #endif
54 
55 #ifdef __cplusplus
56 extern "C"
57 {
58 #endif
59 
60 struct WHSM_History;
61 
62 /*ci
63  * \brief WHSM History properties
64  */
65 struct WHSM_HistoryProperty
66 {
67  /*ci
68  * \brief Inherited properties from the base-class
69  */
70  struct DDSHST_WriterProperty _parent;
71 };
72 
73 /*ci
74  * \def WHSM_HistoryProperty_INITIALIZER
75  * \brief Constant to initialize \ref WHSM_HistoryProperty
76  */
77 #define WHSM_HistoryProperty_INITIALIZER {\
78  DDSHST_WriterProperty_INITIALIZER\
79 }
80 
81 /*ci
82  * \def WHSM_HISTORY_INTERFACE_ID
83  * \brief The WHSM interface id
84  */
85 #define WHSM_HISTORY_INTERFACE_ID RT_MKINTERFACEID(\
86  RT_COMPONENT_CLASS_WHISTORY,RT_COMPONENT_INSTANCE_WHISTORY_SM)
87 
88 /*ci
89  * \brief Get the pointer to the WHSM interface
90  *
91  * \return Pointer to the WHSM interface
92  */
93 MUST_CHECK_RETURN WHSMDllExport struct RT_ComponentFactoryI*
94 WHSM_HistoryFactory_get_interface(void);
95 
96 #ifdef __cplusplus
97 } /* extern "C" */
98 #endif
99 
100 #endif
101 
102 /*ci @} */
103 
RTI Connext Micro Version 2.4.1.0 Copyright © Thu Nov 20 2014 Real-Time Innovations, Inc