Michiel Berckvens / Mbed 2 deprecated ProjectHTTP

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   DS1307 TextLCD mbed

NetServices/services/http/client/data/HTTPFile.h@0:f615d151a72c, 2014-12-04 (annotated)

Committer:
Michielber
Date:
Thu Dec 04 10:36:40 2014 +0000
Revision:
0:f615d151a72c
Berckvens Michiel & Basteyns Jonas 4/12/2014

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Michielber 0:f615d151a72c 1
Michielber 0:f615d151a72c 2 /*
Michielber 0:f615d151a72c 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Michielber 0:f615d151a72c 4
Michielber 0:f615d151a72c 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Michielber 0:f615d151a72c 6 of this software and associated documentation files (the "Software"), to deal
Michielber 0:f615d151a72c 7 in the Software without restriction, including without limitation the rights
Michielber 0:f615d151a72c 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Michielber 0:f615d151a72c 9 copies of the Software, and to permit persons to whom the Software is
Michielber 0:f615d151a72c 10 furnished to do so, subject to the following conditions:
Michielber 0:f615d151a72c 11
Michielber 0:f615d151a72c 12 The above copyright notice and this permission notice shall be included in
Michielber 0:f615d151a72c 13 all copies or substantial portions of the Software.
Michielber 0:f615d151a72c 14
Michielber 0:f615d151a72c 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Michielber 0:f615d151a72c 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Michielber 0:f615d151a72c 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Michielber 0:f615d151a72c 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Michielber 0:f615d151a72c 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Michielber 0:f615d151a72c 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Michielber 0:f615d151a72c 21 THE SOFTWARE.
Michielber 0:f615d151a72c 22 */
Michielber 0:f615d151a72c 23
Michielber 0:f615d151a72c 24 /** \file
Michielber 0:f615d151a72c 25 HTTP File data source/sink header file
Michielber 0:f615d151a72c 26 */
Michielber 0:f615d151a72c 27
Michielber 0:f615d151a72c 28 #ifndef HTTP_FILE_H
Michielber 0:f615d151a72c 29 #define HTTP_FILE_H
Michielber 0:f615d151a72c 30
Michielber 0:f615d151a72c 31 #include "../HTTPData.h"
Michielber 0:f615d151a72c 32 #include "mbed.h"
Michielber 0:f615d151a72c 33
Michielber 0:f615d151a72c 34 ///HTTP Client data container for files
Michielber 0:f615d151a72c 35 /**
Michielber 0:f615d151a72c 36 This class provides file access/storage for HTTP requests and responses' data payloads.
Michielber 0:f615d151a72c 37
Michielber 0:f615d151a72c 38
Michielber 0:f615d151a72c 39 */
Michielber 0:f615d151a72c 40 class HTTPFile : public HTTPData //Read or Write data from a file
Michielber 0:f615d151a72c 41 {
Michielber 0:f615d151a72c 42 public:
Michielber 0:f615d151a72c 43 ///Instantiates data source/sink with file in param.
Michielber 0:f615d151a72c 44 /**
Michielber 0:f615d151a72c 45 Uses file at path @a path.
Michielber 0:f615d151a72c 46 It will be opened when some data has to be read/written from/to it and closed when this operation is complete or on destruction of the instance.
Michielber 0:f615d151a72c 47 Note that the file will be opened with mode "w" for writing and mode "r" for reading, so the file will be cleared between each request if you are using it for writing.
Michielber 0:f615d151a72c 48
Michielber 0:f615d151a72c 49 @note
Michielber 0:f615d151a72c 50 Note that to use this you must instantiate a proper file system (such as the LocalFileSystem or the SDFileSystem).
Michielber 0:f615d151a72c 51 */
Michielber 0:f615d151a72c 52 HTTPFile(const char* path);
Michielber 0:f615d151a72c 53 virtual ~HTTPFile();
Michielber 0:f615d151a72c 54
Michielber 0:f615d151a72c 55 ///Forces file closure
Michielber 0:f615d151a72c 56 virtual void clear();
Michielber 0:f615d151a72c 57
Michielber 0:f615d151a72c 58 protected:
Michielber 0:f615d151a72c 59 virtual int read(char* buf, int len);
Michielber 0:f615d151a72c 60 virtual int write(const char* buf, int len);
Michielber 0:f615d151a72c 61
Michielber 0:f615d151a72c 62 virtual string getDataType(); //Internet media type for Content-Type header
Michielber 0:f615d151a72c 63 virtual void setDataType(const string& type); //Internet media type from Content-Type header
Michielber 0:f615d151a72c 64
Michielber 0:f615d151a72c 65 virtual bool getIsChunked(); //For Transfer-Encoding header
Michielber 0:f615d151a72c 66 virtual void setIsChunked(bool chunked); //From Transfer-Encoding header virtual
Michielber 0:f615d151a72c 67
Michielber 0:f615d151a72c 68 virtual int getDataLen(); //For Content-Length header
Michielber 0:f615d151a72c 69 virtual void setDataLen(int len); //From Content-Length header
Michielber 0:f615d151a72c 70
Michielber 0:f615d151a72c 71 private:
Michielber 0:f615d151a72c 72 bool openFile(const char* mode); //true on success, false otherwise
Michielber 0:f615d151a72c 73 void closeFile();
Michielber 0:f615d151a72c 74
Michielber 0:f615d151a72c 75 FILE* m_fp;
Michielber 0:f615d151a72c 76 string m_path;
Michielber 0:f615d151a72c 77 int m_len;
Michielber 0:f615d151a72c 78 bool m_chunked;
Michielber 0:f615d151a72c 79 };
Michielber 0:f615d151a72c 80
Michielber 0:f615d151a72c 81 #endif