[deb_libcec.git] / src / lib / adapter / USBCECAdapterMessageQueue.h

#pragma once
/*
 * This file is part of the libCEC(R) library.
 *
 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
 * libCEC(R) is an original work, containing original code.
 *
 * libCEC(R) is a trademark of Pulse-Eight Limited.
 *
 * This program is dual-licensed; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *
 * Alternatively, you can license this library under a commercial license,
 * please contact Pulse-Eight Licensing for more information.
 *
 * For more information contact:
 * Pulse-Eight Licensing       <license@pulse-eight.com>
 *     http://www.pulse-eight.com/
 *     http://www.pulse-eight.net/
 */

#include "USBCECAdapterMessage.h"
#include "../platform/threads/threads.h"
#include <map>

namespace CEC
{
  class CUSBCECAdapterCommunication;
  class CCECAdapterMessageQueue;

  class CCECAdapterMessageQueueEntry
  {
  public:
    CCECAdapterMessageQueueEntry(CCECAdapterMessageQueue *queue, CCECAdapterMessage *message);
    virtual ~CCECAdapterMessageQueueEntry(void);

    /*!
     * @brief Signal waiting threads
     */
    void Broadcast(void);

    /*!
     * @brief Called when a message was received.
     * @param message The message that was received.
     * @return True when this message was handled by this entry, false otherwise.
     */
    bool MessageReceived(const CCECAdapterMessage &message);

    /*!
     * @brief Wait for a response to this command.
     * @param iTimeout The timeout to use while waiting.
     * @return True when a response was received before the timeout passed, false otherwise.
     */
    bool Wait(uint32_t iTimeout);

    /*!
     * @return True while a thread is waiting for a signal or isn't waiting yet, false otherwise.
     */
    bool IsWaiting(void);

    /*!
     * @return The msgcode of the command that was sent.
     */
    cec_adapter_messagecode MessageCode(void);

    /*!
     * @brief Check whether a message is a response to this command.
     * @param msg The message to check.
     * @return True when it's a response, false otherwise.
     */
    bool IsResponse(const CCECAdapterMessage &msg);

    /*!
     * @return The command that was sent in human readable form.
     */
    const char *ToString(void) const;

    /*!
     * @brief Called when a 'command accepted' message was received.
     * @param message The message that was received.
     * @return True when the message was handled, false otherwise.
     */
    bool MessageReceivedCommandAccepted(const CCECAdapterMessage &message);

    /*!
     * @brief Called when a 'transmit succeeded' message was received.
     * @param message The message that was received.
     * @return True when the message was handled, false otherwise.
     */
    bool MessageReceivedTransmitSucceeded(const CCECAdapterMessage &message);

    /*!
     * @brief Called when a message that's not a 'command accepted' or 'transmit succeeded' message was received.
     * @param message The message that was received.
     * @return True when the message was handled, false otherwise.
     */
    bool MessageReceivedResponse(const CCECAdapterMessage &message);

    /*!
     * @brief Signals the waiting thread.
     */
    void Signal(void);

    CCECAdapterMessageQueue *  m_queue;
    CCECAdapterMessage *       m_message;      /**< the message that was sent */
    uint8_t                    m_iPacketsLeft; /**< the amount of acks that we're waiting on */
    bool                       m_bSucceeded;   /**< true when the command received a response, false otherwise */
    bool                       m_bWaiting;     /**< true while a thread is waiting or when it hasn't started waiting yet */
    PLATFORM::CCondition<bool> m_condition;    /**< the condition to wait on */
    PLATFORM::CMutex           m_mutex;        /**< mutex for changes to this class */
  };

  class CCECAdapterMessageQueue : public PLATFORM::CThread
  {
    friend class CUSBCECAdapterCommunication;
    friend class CCECAdapterMessageQueueEntry;

  public:
    /*!
     * @brief Create a new message queue.
     * @param com The communication handler callback to use.
     * @param iQueueSize The outgoing message queue size.
     */
    CCECAdapterMessageQueue(CUSBCECAdapterCommunication *com) :
      PLATFORM::CThread(),
      m_com(com),
      m_iNextMessage(0) {}
    virtual ~CCECAdapterMessageQueue(void);

    /*!
     * @brief Signal and delete everything in the queue
     */
    void Clear(void);

    /*!
     * @brief Called when a message was received from the adapter.
     * @param msg The message that was received.
     */
    void MessageReceived(const CCECAdapterMessage &msg);

    /*!
     * @brief Adds received data to the current frame.
     * @param data The data to add.
     * @param iLen The length of the data to add.
     */
    void AddData(uint8_t *data, size_t iLen);

    /*!
     * @brief Transmit a command to the adapter and wait for a response.
     * @param msg The command to send.
     * @return True when written, false otherwise.
     */
    bool Write(CCECAdapterMessage *msg);

    virtual void *Process(void);

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