FBI FRATER / Mbed 2 deprecated InetTest

Library for Bert van Dam's book "ARM MICROCONTROLLERS" For all chapters with internet.

Dependencies:   mbed

NetServices/services/http/client/data/HTTPFile.h@0:4edb816d21e1, 2015-10-16 (annotated)

Committer:
ICTFBI
Date:
Fri Oct 16 14:28:26 2015 +0000
Revision:
0:4edb816d21e1
Pre-update 16-10-15

Who changed what in which revision?

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