Michael Spencer / Mbed 2 deprecated LaOS

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:   mbed

NetServices/services/http/client/data/HTTPFile.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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