1 /*****************************************************************************
2  * async_queue.hpp
3  *****************************************************************************
4  * Copyright (C) 2003 the VideoLAN team
5  * $Id: 9288465e485c472e5f6269a655a9e3f1dd03ed83 $
6  *
7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
8  *          Olivier Teulière <ipkiss@via.ecp.fr>
9  *
10  * This program is free software; 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 along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24 
25 #ifndef ASYNC_QUEUE_HPP
26 #define ASYNC_QUEUE_HPP
27 
28 #include "cmd_generic.hpp"
29 
30 #include <list>
31 #include <string>
32 
33 class OSTimer;
34 
35 
36 /// Asynchronous queue for commands
37 class AsyncQueue: public SkinObject
38 {
39 public:
40     /// Get the instance of AsyncQueue
41     /// Returns NULL if initialization failed.
42     static AsyncQueue *instance( intf_thread_t *pIntf );
43 
44     /// Destroy the instance of AsyncQueue
45     static void destroy( intf_thread_t *pIntf );
46 
47     /// Add a command in the queue, after having removed the commands
48     /// of the same type already in the queue if needed
49     void push( const CmdGenericPtr &rcCommand, bool removePrev = true );
50 
51     /// Remove the commands of the given type
52     void remove( const std::string &rType , const CmdGenericPtr &rcCommand );
53 
54     /// Flush the queue and execute the commands
55     void flush();
56 
57 private:
58     /// Command queue
59     typedef std::list<CmdGenericPtr> cmdList_t;
60     cmdList_t m_cmdList;
61     /// Timer
62     OSTimer *m_pTimer;
63     /// Mutex
64     vlc_mutex_t m_lock;
65 
66     // Private because it is a singleton
67     AsyncQueue( intf_thread_t *pIntf );
68     virtual ~AsyncQueue();
69 
70     // Callback to flush the queue
71     DEFINE_CALLBACK( AsyncQueue, Flush );
72 };
73 
74 
75 #endif
76