Dependencies:   mbed

Dependents:   TCP

Committer:
slowness
Date:
Tue Sep 06 18:05:46 2011 +0000
Revision:
0:58c3d014a4e7

        

Who changed what in which revision?

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