Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/FileHandle.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vipinranka 12:9a20164dcc47 1 /* mbed Microcontroller Library
vipinranka 12:9a20164dcc47 2 * Copyright (c) 2006-2013 ARM Limited
vipinranka 12:9a20164dcc47 3 *
vipinranka 12:9a20164dcc47 4 * Licensed under the Apache License, Version 2.0 (the "License");
vipinranka 12:9a20164dcc47 5 * you may not use this file except in compliance with the License.
vipinranka 12:9a20164dcc47 6 * You may obtain a copy of the License at
vipinranka 12:9a20164dcc47 7 *
vipinranka 12:9a20164dcc47 8 * http://www.apache.org/licenses/LICENSE-2.0
vipinranka 12:9a20164dcc47 9 *
vipinranka 12:9a20164dcc47 10 * Unless required by applicable law or agreed to in writing, software
vipinranka 12:9a20164dcc47 11 * distributed under the License is distributed on an "AS IS" BASIS,
vipinranka 12:9a20164dcc47 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vipinranka 12:9a20164dcc47 13 * See the License for the specific language governing permissions and
vipinranka 12:9a20164dcc47 14 * limitations under the License.
vipinranka 12:9a20164dcc47 15 */
vipinranka 12:9a20164dcc47 16 #ifndef MBED_FILEHANDLE_H
vipinranka 12:9a20164dcc47 17 #define MBED_FILEHANDLE_H
vipinranka 12:9a20164dcc47 18
vipinranka 12:9a20164dcc47 19 typedef int FILEHANDLE;
vipinranka 12:9a20164dcc47 20
vipinranka 12:9a20164dcc47 21 #include <stdio.h>
vipinranka 12:9a20164dcc47 22
vipinranka 12:9a20164dcc47 23 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
vipinranka 12:9a20164dcc47 24 typedef int ssize_t;
vipinranka 12:9a20164dcc47 25 typedef long off_t;
vipinranka 12:9a20164dcc47 26
vipinranka 12:9a20164dcc47 27 #else
vipinranka 12:9a20164dcc47 28 # include <sys/types.h>
vipinranka 12:9a20164dcc47 29 #endif
vipinranka 12:9a20164dcc47 30
vipinranka 12:9a20164dcc47 31 namespace mbed {
vipinranka 12:9a20164dcc47 32 /** \addtogroup drivers */
vipinranka 12:9a20164dcc47 33 /** @{*/
vipinranka 12:9a20164dcc47 34
vipinranka 12:9a20164dcc47 35 /** An OO equivalent of the internal FILEHANDLE variable
vipinranka 12:9a20164dcc47 36 * and associated _sys_* functions.
vipinranka 12:9a20164dcc47 37 *
vipinranka 12:9a20164dcc47 38 * FileHandle is an abstract class, needing at least sys_write and
vipinranka 12:9a20164dcc47 39 * sys_read to be implmented for a simple interactive device.
vipinranka 12:9a20164dcc47 40 *
vipinranka 12:9a20164dcc47 41 * No one ever directly tals to/instanciates a FileHandle - it gets
vipinranka 12:9a20164dcc47 42 * created by FileSystem, and wrapped up by stdio.
vipinranka 12:9a20164dcc47 43 *
vipinranka 12:9a20164dcc47 44 * @Note Synchronization level: Set by subclass
vipinranka 12:9a20164dcc47 45 */
vipinranka 12:9a20164dcc47 46 class FileHandle {
vipinranka 12:9a20164dcc47 47
vipinranka 12:9a20164dcc47 48 public:
vipinranka 12:9a20164dcc47 49 /** Write the contents of a buffer to the file
vipinranka 12:9a20164dcc47 50 *
vipinranka 12:9a20164dcc47 51 * @param buffer the buffer to write from
vipinranka 12:9a20164dcc47 52 * @param length the number of characters to write
vipinranka 12:9a20164dcc47 53 *
vipinranka 12:9a20164dcc47 54 * @returns
vipinranka 12:9a20164dcc47 55 * The number of characters written (possibly 0) on success, -1 on error.
vipinranka 12:9a20164dcc47 56 */
vipinranka 12:9a20164dcc47 57 virtual ssize_t write(const void* buffer, size_t length) = 0;
vipinranka 12:9a20164dcc47 58
vipinranka 12:9a20164dcc47 59 /** Close the file
vipinranka 12:9a20164dcc47 60 *
vipinranka 12:9a20164dcc47 61 * @returns
vipinranka 12:9a20164dcc47 62 * Zero on success, -1 on error.
vipinranka 12:9a20164dcc47 63 */
vipinranka 12:9a20164dcc47 64 virtual int close() = 0;
vipinranka 12:9a20164dcc47 65
vipinranka 12:9a20164dcc47 66 /** Function read
vipinranka 12:9a20164dcc47 67 * Reads the contents of the file into a buffer
vipinranka 12:9a20164dcc47 68 *
vipinranka 12:9a20164dcc47 69 * @param buffer the buffer to read in to
vipinranka 12:9a20164dcc47 70 * @param length the number of characters to read
vipinranka 12:9a20164dcc47 71 *
vipinranka 12:9a20164dcc47 72 * @returns
vipinranka 12:9a20164dcc47 73 * The number of characters read (zero at end of file) on success, -1 on error.
vipinranka 12:9a20164dcc47 74 */
vipinranka 12:9a20164dcc47 75 virtual ssize_t read(void* buffer, size_t length) = 0;
vipinranka 12:9a20164dcc47 76
vipinranka 12:9a20164dcc47 77 /** Check if the handle is for a interactive terminal device.
vipinranka 12:9a20164dcc47 78 * If so, line buffered behaviour is used by default
vipinranka 12:9a20164dcc47 79 *
vipinranka 12:9a20164dcc47 80 * @returns
vipinranka 12:9a20164dcc47 81 * 1 if it is a terminal,
vipinranka 12:9a20164dcc47 82 * 0 otherwise
vipinranka 12:9a20164dcc47 83 */
vipinranka 12:9a20164dcc47 84 virtual int isatty() = 0;
vipinranka 12:9a20164dcc47 85
vipinranka 12:9a20164dcc47 86 /** Move the file position to a given offset from a given location.
vipinranka 12:9a20164dcc47 87 *
vipinranka 12:9a20164dcc47 88 * @param offset The offset from whence to move to
vipinranka 12:9a20164dcc47 89 * @param whence SEEK_SET for the start of the file, SEEK_CUR for the
vipinranka 12:9a20164dcc47 90 * current file position, or SEEK_END for the end of the file.
vipinranka 12:9a20164dcc47 91 *
vipinranka 12:9a20164dcc47 92 * @returns
vipinranka 12:9a20164dcc47 93 * new file position on success,
vipinranka 12:9a20164dcc47 94 * -1 on failure or unsupported
vipinranka 12:9a20164dcc47 95 */
vipinranka 12:9a20164dcc47 96 virtual off_t lseek(off_t offset, int whence) = 0;
vipinranka 12:9a20164dcc47 97
vipinranka 12:9a20164dcc47 98 /** Flush any buffers associated with the FileHandle, ensuring it
vipinranka 12:9a20164dcc47 99 * is up to date on disk
vipinranka 12:9a20164dcc47 100 *
vipinranka 12:9a20164dcc47 101 * @returns
vipinranka 12:9a20164dcc47 102 * 0 on success or un-needed,
vipinranka 12:9a20164dcc47 103 * -1 on error
vipinranka 12:9a20164dcc47 104 */
vipinranka 12:9a20164dcc47 105 virtual int fsync() = 0;
vipinranka 12:9a20164dcc47 106
vipinranka 12:9a20164dcc47 107 virtual off_t flen() {
vipinranka 12:9a20164dcc47 108 lock();
vipinranka 12:9a20164dcc47 109 /* remember our current position */
vipinranka 12:9a20164dcc47 110 off_t pos = lseek(0, SEEK_CUR);
vipinranka 12:9a20164dcc47 111 if(pos == -1) {
vipinranka 12:9a20164dcc47 112 unlock();
vipinranka 12:9a20164dcc47 113 return -1;
vipinranka 12:9a20164dcc47 114 }
vipinranka 12:9a20164dcc47 115 /* seek to the end to get the file length */
vipinranka 12:9a20164dcc47 116 off_t res = lseek(0, SEEK_END);
vipinranka 12:9a20164dcc47 117 /* return to our old position */
vipinranka 12:9a20164dcc47 118 lseek(pos, SEEK_SET);
vipinranka 12:9a20164dcc47 119 unlock();
vipinranka 12:9a20164dcc47 120 return res;
vipinranka 12:9a20164dcc47 121 }
vipinranka 12:9a20164dcc47 122
vipinranka 12:9a20164dcc47 123 virtual ~FileHandle();
vipinranka 12:9a20164dcc47 124
vipinranka 12:9a20164dcc47 125 protected:
vipinranka 12:9a20164dcc47 126
vipinranka 12:9a20164dcc47 127 /** Acquire exclusive access to this object.
vipinranka 12:9a20164dcc47 128 */
vipinranka 12:9a20164dcc47 129 virtual void lock() {
vipinranka 12:9a20164dcc47 130 // Stub
vipinranka 12:9a20164dcc47 131 }
vipinranka 12:9a20164dcc47 132
vipinranka 12:9a20164dcc47 133 /** Release exclusive access to this object.
vipinranka 12:9a20164dcc47 134 */
vipinranka 12:9a20164dcc47 135 virtual void unlock() {
vipinranka 12:9a20164dcc47 136 // Stub
vipinranka 12:9a20164dcc47 137 }
vipinranka 12:9a20164dcc47 138 };
vipinranka 12:9a20164dcc47 139
vipinranka 12:9a20164dcc47 140 } // namespace mbed
vipinranka 12:9a20164dcc47 141
vipinranka 12:9a20164dcc47 142 #endif
vipinranka 12:9a20164dcc47 143
vipinranka 12:9a20164dcc47 144 /** @}*/