blob: 61b30539720bccf6dce5c0f354affb4bdfa96dad (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/***************************************************************************
*
* Copyright 2010,2011 BMW Car IT GmbH
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
****************************************************************************/
#ifndef _ICOMMUNICATOR_H_
#define _ICOMMUNICATOR_H_
class ICommandExecutor;
/**
* Abstract Base of all Communicator plugins.
* \defgroup CommunicatorAPI Layer Management Communicator API
*/
class ICommunicator
{
public:
/**
* \brief constructor: any communicator need a executor for commands
* \ingroup CommunicatorAPI
* \param[in] executor Pointer to an object to send commands to
*/
ICommunicator(ICommandExecutor* executor);
/**
* \brief default destructor
*/
virtual ~ICommunicator() {}
/**
* \brief Start communication process, i.e. start specific listening process of communication method
* \ingroup CommunicatorAPI
*/
virtual bool start() = 0;
/**
* \brief Stop communication. Stop sending command objects.
* \ingroup CommunicatorAPI
*/
virtual void stop() = 0;
/**
* \brief Process communication.
* \ingroup CommunicatorAPI
* \param[in] timeout_ms timeout value in milliseconds
*/
virtual void process(int timeout_ms) = 0;
/**
* \brief Switch debug mode of this component on or off
* \ingroup CommunicatorAPI
* \param[in] onoff TRUE: Turn on debug mode, FALSE: Turn off debug mode
*/
virtual void setdebug(bool onoff) = 0;
protected:
ICommandExecutor* m_executor;
};
inline ICommunicator::ICommunicator(ICommandExecutor* executor)
: m_executor(executor)
{
}
#endif // _ICOMMUNICATOR_H_
|
