EnOcean Link
1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoMessageHandler.h
Go to the documentation of this file.
1
/******************************************************************************
2
DISCLAIMER
3
4
THIS SOFTWARE PRODUCT ("SOFTWARE") IS PROPRIETARY TO ENOCEAN GMBH, OBERHACHING,
5
GERMANY (THE "OWNER") AND IS PROTECTED BY COPYRIGHT AND INTERNATIONAL TREATIES OR
6
PROTECTED AS TRADE SECRET OR AS OTHER INTELLECTUAL PROPERTY RIGHT. ALL RIGHTS, TITLE AND
7
INTEREST IN AND TO THE SOFTWARE, INCLUDING ANY COPYRIGHT, TRADE SECRET OR ANY OTHER
8
INTELLECTUAL PROPERTY EMBODIED IN THE SOFTWARE, AND ANY RIGHTS TO REPRODUCE,
9
DISTRIBUTE, MODIFY, DISPLAY OR OTHERWISE USE THE SOFTWARE SHALL EXCLUSIVELY VEST IN THE
10
OWNER. ANY UNAUTHORIZED REPRODUCTION, DISTRIBUTION, MODIFICATION, DISPLAY OR OTHER
11
USE OF THE SOFTWARE WITHOUT THE EXPLICIT PERMISSION OF OWNER IS PROHIBITED AND WILL
12
CONSTITUTE AN INFRINGEMENT OF THE OWNER'S RIGHT AND MAY BE SUBJECT TO CIVIL OR
13
CRIMINAL SANCTION.
14
15
THIS SOFTWARE IS PROVIDED BY THE OWNER "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
16
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
17
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN PARTICULAR, THE OWNER DOES NOT WARRANT
18
THAT THE SOFTWARE SHALL BE ERROR FREE AND WORKS WITHOUT INTERRUPTION.
19
20
IN NO EVENT SHALL THE OWNER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
******************************************************************************/
27
34
#ifndef EOMESSAGEHANDLER_H_
35
#define EOMESSAGEHANDLER_H_
36
37
#include "
eoHalTypes.h
"
38
#include "
eoMessage.h
"
39
#include "
eoTelegram.h
"
40
#include "eoMaintenanceMessage.h"
41
#include "
eoPacket.h
"
42
#include "
eoApiDef.h
"
43
#include "
eoReManChainer.h
"
44
#include "
eoGpChainer.h
"
45
#include "
eoSecTeachInChainer.h
"
46
#include "
eoMaintenanceChainer.h
"
47
48
class
eoChainedMessage
;
49
class
eoGateway
;
50
55
class
eoMessageHandler
56
{
57
private
:
58
eoReManChainer
remanChainer;
59
eoGpChainer
gpChainer;
60
eoSecTeachInChainer
secTeachInChainer;
61
62
eoMaintenanceChainer
maintenanceChainer;
63
64
public
:
65
eoMessageHandler
();
66
virtual
~
eoMessageHandler
();
67
74
eoReturn
ProcessTelegram
(
eoTelegram
&tel,
eoMessage
&msg);
81
eoReturn
ProcessTelegram
(
eoTelegram
&tel,
eoReManMessage
&msg);
88
eoReturn
ProcessTelegram
(
eoTelegram
&tel,
eoMaintenanceMessage
&msg);
93
void
CleanUpChainerLists
();
94
101
eoReturn
ComposeChainedMessage
(
const
eoMessage
&msg,
eoGateway
&gateway);
102
109
eoReturn
ComposeChainedMessage
(
const
eoMaintenanceMessage
&msg,
eoGateway
&gateway);
116
eoReturn
ComposeChainedMessage
(
const
eoReManMessage
&reMsg,
eoGateway
&gateway,
bool
shallBeRepeated=
false
);
117
};
118
119
#endif
/* EOMESSAGEHANDLER_H_ */
120
eoPacket.h
eoSecTeachInChainer
Definition:
eoSecTeachInChainer.h:48
eoTelegram.h
eoApiDef.h
contains Dolphin API Definitions
eoMessageHandler::ComposeChainedMessage
eoReturn ComposeChainedMessage(const eoMessage &msg, eoGateway &gateway)
eoMessageHandler
Definition:
eoMessageHandler.h:55
eoTelegram
every Communication from an EnOcean Device to another one consist out of one more Telegrams...
Definition:
eoTelegram.h:43
eoReManChainer
Definition:
eoReManChainer.h:50
eoGpChainer
Definition:
eoGpChainer.h:48
eoGpChainer.h
eoMessage
Message Class for communication.
Definition:
eoMessage.h:47
eoMaintenanceMessage
The maintenance message class, these messages represent an EnOcean maintenance message.
Definition:
eoMaintenanceMessage.h:56
eoMaintenanceChainer.h
eoMaintenanceChainer
Definition:
eoMaintenanceChainer.h:49
eoHalTypes.h
eoReturn
eoReturn
contains all the return values from different functions
Definition:
eoApiDef.h:40
eoGateway
EnOcean Gateway class, for handling a gateway Module.
Definition:
eoGateway.h:139
eoMessageHandler::CleanUpChainerLists
void CleanUpChainerLists()
eoMessage.h
eoMessageHandler::ProcessTelegram
eoReturn ProcessTelegram(eoTelegram &tel, eoMessage &msg)
eoChainedMessage
Definition:
eoChainedMessage.h:43
eoSecTeachInChainer.h
eoReManMessage
Definition:
eoReManMessage.h:43
eoReManChainer.h
SourceCode
EOLink
Includes
eoMessageHandler.h
Generated on Thu Aug 24 2023 10:09:53 for EnOcean Link by
1.8.13