Windows Virtual Shields for Arduino
Web.h
Go to the documentation of this file.
1 /*
2  Copyright(c) Microsoft Open Technologies, Inc. All rights reserved.
3 
4  The MIT License(MIT)
5 
6  Permission is hereby granted, free of charge, to any person obtaining a copy
7  of this software and associated documentation files(the "Software"), to deal
8  in the Software without restriction, including without limitation the rights
9  to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
10  copies of the Software, and to permit persons to whom the Software is
11  furnished to do so, subject to the following conditions :
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  THE SOFTWARE.
23 */
24 
25 #ifndef Web_h
26 #define Web_h
27 
28 #include "Sensor.h"
29 
30 const PROGMEM char PARSE[] = "Parse";
31 
32 namespace ArduinoJson{
33  class JsonObject;
34 }
35 
36 const int maxResponseLength = 200;
37 
38 class Web : public Sensor
39 {
40 public:
41  int resultId;
42 
43  Web(const VirtualShield &shield);
44 
45  int get(String url, String parsingInstructions = (const char*) 0, int maxLength = 0);
46  int post(String url, String data, String parsingInstructions = (const char*) 0, int maxLength = 0);
47 
48  int get(EPtr url, EPtr parsingInstructions, int maxLength = 0);
49  int post(EPtr url, EPtr data, EPtr parsingInstructions, int maxLength = 0);
50 
51  void getResponse(char* responseBuffer, int length, char** parts = 0, int partCount = 0);
52 
53  void onJsonReceived(ArduinoJson::JsonObject& root, ShieldEvent* shieldEvent) override;
54 private:
55  const char* response;
56 };
57 
58 #endif
Definition: Sensor.h:51
int resultId
Definition: Web.h:41
Definition: VirtualShield.h:50
VirtualShield & shield
Definition: Sensor.h:55
Definition: Web.h:32
const PROGMEM char PARSE[]
Definition: Web.h:30
int post(String url, String data, String parsingInstructions=(const char *) 0, int maxLength=0)
Performs a web Post, optionally returning a result.
Definition: Web.cpp:68
Definition: Web.h:38
const int maxResponseLength
Definition: Web.h:36
void getResponse(char *responseBuffer, int length, char **parts=0, int partCount=0)
Copies the current web response (only valid before another web event) into a supplied buffer...
Definition: Web.cpp:111
Definition: SensorModels.h:101
Definition: ShieldEvent.h:35
Web(const VirtualShield &shield)
Initializes a new instance of the Web class.
Definition: Web.cpp:45
void onJsonReceived(ArduinoJson::JsonObject &root, ShieldEvent *shieldEvent) override
Event called when a valid json message was received. Consumes the proper values for this sensor...
Definition: Web.cpp:138