cec: fixed leak in CCECAdapterMessageQueue::Write
[deb_libcec.git] / src / lib / adapter / AdapterCommunication.h
CommitLineData
abbca718
LOK
1#pragma once
2/*
3 * This file is part of the libCEC(R) library.
4 *
b492c10e 5 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
abbca718
LOK
6 * libCEC(R) is an original work, containing original code.
7 *
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 *
10 * This program is dual-licensed; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 *
24 *
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
27 *
28 * For more information contact:
29 * Pulse-Eight Licensing <license@pulse-eight.com>
30 * http://www.pulse-eight.com/
31 * http://www.pulse-eight.net/
32 */
33
ba65909d 34#include "../platform/util/StdString.h"
a75e3a5a 35#include "USBCECAdapterMessage.h"
ef7696f5 36
abbca718
LOK
37namespace CEC
38{
9ceaabcd 39 class IAdapterCommunicationCallback
b1f94db1
LOK
40 {
41 public:
9ceaabcd
LOK
42 IAdapterCommunicationCallback(void) {}
43 virtual ~IAdapterCommunicationCallback(void) {}
44
b1f94db1
LOK
45 /*!
46 * @brief Callback method for IAdapterCommunication, called when a new cec_command is received
47 * @param command The command that has been received
48 * @return True when it was handled by this listener, false otherwise.
49 */
50 virtual bool OnCommandReceived(const cec_command &command) = 0;
a75e3a5a
LOK
51
52 /*!
53 * @brief Callback method for IAdapterCommunication, called when a poll was received.
54 * @param initiator The initiator that sent the poll.
55 * @param destination The destination of the poll message.
56 */
57 virtual void HandlePoll(cec_logical_address initiator, cec_logical_address destination) = 0;
58
59 /*!
60 * @brief Callback method for IAdapterCommunication, called when a receive failed message was received.
61 * @param initiator The initiator that sent the receive failed message.
62 * @return True when this is an error, false otherwise.
63 */
64 virtual bool HandleReceiveFailed(cec_logical_address initiator) = 0;
b1f94db1
LOK
65 };
66
9ceaabcd 67 class IAdapterCommunication
abbca718
LOK
68 {
69 public:
a75e3a5a
LOK
70 /*!
71 * @param callback The callback struct. if set to NULL, the Read() method has to be used to read commands. if set, OnCommandReceived() will be called for each command that was received
72 */
73 IAdapterCommunication(IAdapterCommunicationCallback *callback) :
74 m_callback(callback) {}
9ceaabcd
LOK
75 virtual ~IAdapterCommunication(void) {}
76
7bb4ed43
LOK
77 /*!
78 * @brief Open a connection to the CEC adapter
79 * @param iTimeoutMs Connection timeout in ms
a2198e5e 80 * @param bSkipChecks Skips all initial checks of the adapter, and starts the reader/writer threads directly after connecting.
f80cd208 81 * @param bStartListening Start a listener thread when true. False to just open a connection, read the device info, and close the connection.
7bb4ed43
LOK
82 * @return True when connected, false otherwise
83 */
a75e3a5a 84 virtual bool Open(uint32_t iTimeoutMs = 10000, bool bSkipChecks = false, bool bStartListening = true) = 0;
7bb4ed43
LOK
85
86 /*!
87 * @brief Close an open connection
88 */
89 virtual void Close(void) = 0;
90
91 /*!
92 * @return True when the connection is open, false otherwise
93 */
94 virtual bool IsOpen(void) = 0;
95
96 /*!
97 * @return The last error message, or an empty string if there was none
98 */
99 virtual CStdString GetError(void) const = 0;
100
7bb4ed43
LOK
101 /*!
102 * @brief Write a cec_command to the adapter
103 * @param data The command to write
33dd87a9
MK
104 * @param bRetry The command can be retried
105 * @param iLineTimeout The line timeout to be used
7bb4ed43
LOK
106 * @return The last state of the transmitted command
107 */
33dd87a9 108 virtual cec_adapter_message_state Write(const cec_command &data, bool &bRetry, uint8_t iLineTimeout = 3) = 0;
ef7696f5 109
7bb4ed43
LOK
110 /*!
111 * @brief Change the current line timeout on the CEC bus
112 * @param iTimeout The new timeout
113 * @return True when set, false otherwise
114 */
115 virtual bool SetLineTimeout(uint8_t iTimeout) = 0;
ef7696f5 116
7bb4ed43
LOK
117 /*!
118 * @brief Put the device in bootloader mode (which will disrupt CEC communication when it succeeds)
119 * @return True when the bootloader command has been sent, false otherwise.
120 */
121 virtual bool StartBootloader(void) = 0;
ef7696f5 122
7bb4ed43
LOK
123 /*!
124 * @brief Change the ACK-mask of the device, the mask for logical addresses to which the CEC device should ACK
125 * @param iMask The new mask
126 * @return True when set, false otherwise.
127 */
128 virtual bool SetAckMask(uint16_t iMask) = 0;
6729ac71 129
7bb4ed43
LOK
130 /*!
131 * @brief Check whether the CEC adapter responds
132 * @return True when the ping was sent and acked, false otherwise.
133 */
134 virtual bool PingAdapter(void) = 0;
ef7696f5 135
7bb4ed43 136 /*!
e69d8f19 137 * @return The firmware version of this CEC adapter, or 0 if it's unknown.
7bb4ed43
LOK
138 */
139 virtual uint16_t GetFirmwareVersion(void) = 0;
b057edad
BL
140
141 /*!
142 * @return True when the control mode has been set, false otherwise.
143 */
144 virtual bool SetControlledMode(bool controlled) = 0;
224ea877
LOK
145
146 /*!
147 * @brief Persist the given configuration in adapter (if supported)
148 * @brief The configuration to store.
149 * @return True when the configuration was persisted, false otherwise.
150 */
151 virtual bool PersistConfiguration(libcec_configuration *configuration) = 0;
cba904a6 152
12a36be9
LOK
153 /*!
154 * @brief Get the persisted configuration from the adapter (if supported)
155 * @param configuration The updated configuration.
156 * @return True when the configuration was updated, false otherwise.
157 */
158 virtual bool GetConfiguration(libcec_configuration *configuration) = 0;
159
cba904a6
LOK
160 /*!
161 * @return The name of the port
162 */
163 virtual CStdString GetPortName(void) = 0;
8670c970
LOK
164
165 /*!
166 * @return The physical address, if the adapter supports this. 0 otherwise.
167 */
168 virtual uint16_t GetPhysicalAddress(void) = 0;
a75e3a5a
LOK
169
170 protected:
171 IAdapterCommunicationCallback *m_callback;
abbca718
LOK
172 };
173};