OpenZWave Library  1.6.943
Http.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Http.h
4 //
5 // Simple HTTP Client Interface to download updated config files
6 //
7 // Copyright (c) 2015 Justin Hammond <Justin@dynam.ac>
8 //
9 // SOFTWARE NOTICE AND LICENSE
10 //
11 // This file is part of OpenZWave.
12 //
13 // OpenZWave is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU Lesser General Public License as published
15 // by the Free Software Foundation, either version 3 of the License,
16 // or (at your option) any later version.
17 //
18 // OpenZWave is distributed in the hope that it will be useful,
19 // but WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU Lesser General Public License for more details.
22 //
23 // You should have received a copy of the GNU Lesser General Public License
24 // along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
25 //
26 //-----------------------------------------------------------------------------
27 
28 #ifndef _Http_H
29 #define _Http_H
30 
31 #include "Defs.h"
32 #include "platform/Event.h"
33 #include "platform/Thread.h"
34 #include "platform/Mutex.h"
35 
36 namespace OpenZWave
37 {
38  class Driver;
39 
40  namespace Internal
41  {
42  /* This is a abstract class you can implement if you wish to override the built in HTTP Client
43  * Code in OZW with your own code.
44  *
45  * The built in Code uses threads to download updated files to a temporary file
46  * and then this class moves the files into the correct place.
47  *
48  */
49 
50  struct HttpDownload
51  {
52  string filename;
53  string url;
56  {
61  };
63  enum Status
64  {
65  Ok,
67  };
69 
70  };
71 
73  {
74  public:
76  virtual ~i_HttpClient()
77  {
78  }
79  ;
80  virtual bool StartDownload(HttpDownload *transfer) = 0;
81  void FinishDownload(HttpDownload *transfer);
82  private:
83  Driver* m_driver;
84  };
85 
86  /* this is OZW's implementation of a Http Client. It uses threads to download Config Files in the background.
87  *
88  */
89 
90  class HttpClient: public i_HttpClient
91  {
92  public:
93  HttpClient(Driver *);
94  ~HttpClient();
95  bool StartDownload(HttpDownload *transfer);
96  private:
97 
98  static void HttpThreadProc(Internal::Platform::Event* _exitEvent, void* _context);
99  //Driver* m_driver;
100  Internal::Platform::Event* m_exitEvent;
101 
102  Internal::Platform::Thread* m_httpThread;
103  bool m_httpThreadRunning;
104  Internal::Platform::Mutex* m_httpMutex;
105  list<HttpDownload *> m_httpDownlist;
106  Internal::Platform::Event* m_httpDownloadEvent;
107 
108  };
109 
110  } // namespace Internal
111 } /* namespace OpenZWave */
112 
113 #endif
DownloadType operation
Definition: Http.h:62
i_HttpClient(Driver *)
Definition: Http.cpp:45
Definition: Bitfield.cpp:30
uint8 node
Definition: Http.h:54
bool StartDownload(HttpDownload *transfer)
Definition: Http.cpp:75
Implements a platform-independent thread management class.
Definition: Thread.h:47
Platform-independent definition of event objects.
Definition: Event.h:44
void FinishDownload(HttpDownload *transfer)
Definition: Http.cpp:51
Status transferStatus
Definition: Http.h:68
Definition: Http.h:90
string url
Definition: Http.h:53
The Driver class handles communication between OpenZWave and a device attached via a serial port (typ...
Definition: Driver.h:84
DownloadType
Definition: Http.h:55
HttpClient(Driver *)
Definition: Http.cpp:60
Implements a platform-independent mutex–for serializing access to a shared resource.
Definition: Mutex.h:44
string filename
Definition: Http.h:52
virtual bool StartDownload(HttpDownload *transfer)=0
virtual ~i_HttpClient()
Definition: Http.h:76
~HttpClient()
Definition: Http.cpp:65
unsigned char uint8
Definition: Defs.h:85