src/lib/adapter/Pulse-Eight/USBCECAdapterMessageQueue.h

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