Commit | Line | Data |
---|---|---|
a75e3a5a LOK |
1 | #pragma once |
2 | /* | |
3 | * This file is part of the libCEC(R) library. | |
4 | * | |
5 | * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved. | |
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 | ||
34 | #include "USBCECAdapterMessage.h" | |
8cdaa059 | 35 | #include <map> |
a75e3a5a LOK |
36 | |
37 | namespace CEC | |
38 | { | |
39 | class CUSBCECAdapterCommunication; | |
40 | ||
41 | class CCECAdapterMessageQueueEntry | |
42 | { | |
43 | public: | |
44 | CCECAdapterMessageQueueEntry(CCECAdapterMessage *message); | |
45 | virtual ~CCECAdapterMessageQueueEntry(void); | |
46 | ||
47 | /*! | |
48 | * @brief Signal waiting threads | |
49 | */ | |
50 | void Broadcast(void); | |
51 | ||
52 | /*! | |
53 | * @brief Called when a message was received. | |
54 | * @param message The message that was received. | |
55 | * @return True when this message was handled by this entry, false otherwise. | |
56 | */ | |
57 | bool MessageReceived(const CCECAdapterMessage &message); | |
58 | ||
59 | /*! | |
60 | * @brief Wait for a response to this command. | |
61 | * @param iTimeout The timeout to use while waiting. | |
62 | * @return True when a response was received before the timeout passed, false otherwise. | |
63 | */ | |
64 | bool Wait(uint32_t iTimeout); | |
65 | ||
66 | /*! | |
67 | * @return True while a thread is waiting for a signal or isn't waiting yet, false otherwise. | |
68 | */ | |
69 | bool IsWaiting(void); | |
70 | ||
71 | /*! | |
72 | * @return The msgcode of the command that was sent. | |
73 | */ | |
74 | cec_adapter_messagecode MessageCode(void); | |
75 | ||
76 | /*! | |
77 | * @brief Check whether a message is a response to this command. | |
78 | * @param msg The message to check. | |
79 | * @return True when it's a response, false otherwise. | |
80 | */ | |
81 | bool IsResponse(const CCECAdapterMessage &msg); | |
82 | ||
83 | /*! | |
84 | * @return The command that was sent in human readable form. | |
85 | */ | |
86 | const char *ToString(void) const; | |
87 | ||
88 | private: | |
89 | /*! | |
90 | * @brief Called when a 'command accepted' message was received. | |
91 | * @param message The message that was received. | |
8cdaa059 | 92 | * @return True when the message was handled, false otherwise. |
a75e3a5a LOK |
93 | */ |
94 | bool MessageReceivedCommandAccepted(const CCECAdapterMessage &message); | |
95 | ||
96 | /*! | |
97 | * @brief Called when a 'transmit succeeded' message was received. | |
98 | * @param message The message that was received. | |
8cdaa059 | 99 | * @return True when the message was handled, false otherwise. |
a75e3a5a LOK |
100 | */ |
101 | bool MessageReceivedTransmitSucceeded(const CCECAdapterMessage &message); | |
102 | ||
103 | /*! | |
104 | * @brief Called when a message that's not a 'command accepted' or 'transmit succeeded' message was received. | |
105 | * @param message The message that was received. | |
8cdaa059 | 106 | * @return True when the message was handled, false otherwise. |
a75e3a5a LOK |
107 | */ |
108 | bool MessageReceivedResponse(const CCECAdapterMessage &message); | |
109 | ||
8cdaa059 LOK |
110 | /*! |
111 | * @brief Signals the waiting thread. | |
112 | */ | |
113 | void Signal(void); | |
114 | ||
a75e3a5a LOK |
115 | CCECAdapterMessage * m_message; /**< the message that was sent */ |
116 | uint8_t m_iPacketsLeft; /**< the amount of acks that we're waiting on */ | |
117 | bool m_bSucceeded; /**< true when the command received a response, false otherwise */ | |
118 | bool m_bWaiting; /**< true while a thread is waiting or when it hasn't started waiting yet */ | |
119 | PLATFORM::CCondition<bool> m_condition; /**< the condition to wait on */ | |
120 | PLATFORM::CMutex m_mutex; /**< mutex for changes to this class */ | |
121 | }; | |
122 | ||
123 | class CCECAdapterMessageQueue | |
124 | { | |
125 | friend class CUSBCECAdapterCommunication; | |
126 | ||
127 | public: | |
128 | /*! | |
129 | * @brief Create a new message queue. | |
130 | * @param com The communication handler callback to use. | |
131 | * @param iQueueSize The outgoing message queue size. | |
132 | */ | |
8cdaa059 | 133 | CCECAdapterMessageQueue(CUSBCECAdapterCommunication *com) : |
a75e3a5a | 134 | m_com(com), |
8cdaa059 | 135 | m_iNextMessage(0) {} |
a75e3a5a LOK |
136 | virtual ~CCECAdapterMessageQueue(void); |
137 | ||
138 | /*! | |
139 | * @brief Signal and delete everything in the queue | |
140 | */ | |
141 | void Clear(void); | |
142 | ||
143 | /*! | |
144 | * @brief Called when a message was received from the adapter. | |
145 | * @param msg The message that was received. | |
146 | */ | |
147 | void MessageReceived(const CCECAdapterMessage &msg); | |
148 | ||
149 | /*! | |
150 | * @brief Adds received data to the current frame. | |
151 | * @param data The data to add. | |
152 | * @param iLen The length of the data to add. | |
153 | */ | |
154 | void AddData(uint8_t *data, size_t iLen); | |
155 | ||
156 | /*! | |
157 | * @brief Transmit a command to the adapter and wait for a response. | |
158 | * @param msg The command to send. | |
159 | * @return True when written, false otherwise. | |
160 | */ | |
161 | bool Write(CCECAdapterMessage *msg); | |
162 | ||
163 | private: | |
a75e3a5a LOK |
164 | CUSBCECAdapterCommunication * m_com; /**< the communication handler */ |
165 | PLATFORM::CMutex m_mutex; /**< mutex for changes to this class */ | |
8cdaa059 LOK |
166 | std::map<uint64_t, CCECAdapterMessageQueueEntry *> m_messages; /**< the outgoing message queue */ |
167 | uint64_t m_iNextMessage; /**< the index of the next message */ | |
a75e3a5a LOK |
168 | CCECAdapterMessage m_incomingAdapterMessage; /**< the current incoming message that's being assembled */ |
169 | cec_command m_currentCECFrame; /**< the current incoming CEC command that's being assembled */ | |
170 | }; | |
171 | } |