RTI Connext Micro  Version 2.4.1.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
rh_sm_history.h
Go to the documentation of this file.
1 /*
2  * FILE: rh_sm_history.h - Reader History API
3  *
4  * (c) Copyright 2008-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 Reader History API
20  */
21 /*ci \addtogroup RHSMModule
22  * @{
23  */
24 #ifndef rh_sm_history_h
25 #define rh_sm_history_h
26 
27 #ifndef rh_sm_dll_h
28 #include "rh_sm/rh_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 
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 
54 struct RHSM_History;
55 
56 /*ci
57  * \brief RHSM History properties
58  */
59 struct RHSM_HistoryProperty
60 {
61  /*ci
62  * \brief Inherited properties from the base-class
63  */
64  struct DDSHST_ReaderProperty _parent;
65 };
66 
67 /*ci
68  * \def DDSHST_ReaderProperty_INITIALIZER
69  * \brief Constant to initialize \ref RHSM_HistoryProperty
70  */
71 #define RHSM_HistoryProperty_INITIALIZER {\
72  DDSHST_ReaderProperty_INITIALIZER \
73 }
74 
75 /*ci
76  * \def RHSM_HISTORY_INTERFACE_ID
77  * \brief The RHSM interface id
78  */
79 #define RHSM_HISTORY_INTERFACE_ID \
80  RT_MKINTERFACEID(RT_COMPONENT_CLASS_RHISTORY,\
81  RT_COMPONENT_INSTANCE_RHISTORY_SM)
82 
83 /*ci
84  * \brief Get the pointer to the RHSM interface
85  *
86  * \return Pointer to the RHSM interface
87  */
88 MUST_CHECK_RETURN RHSMDllExport struct RT_ComponentFactoryI*
89 RHSM_HistoryFactory_get_interface(void);
90 
91 #ifdef __cplusplus
92 } /* extern "C" */
93 #endif
94 
95 
96 #endif
97 
98 /*ci @} */
99 
RTI Connext Micro Version 2.4.1.0 Copyright © Thu Nov 20 2014 Real-Time Innovations, Inc