Marco Mayer / Mbed OS Queue

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.

mbed-os/features/filesystem/File.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 /* mbed Microcontroller Library
demayer 0:6bf0743ece18 2 * Copyright (c) 2015 ARM Limited
demayer 0:6bf0743ece18 3 *
demayer 0:6bf0743ece18 4 * Licensed under the Apache License, Version 2.0 (the "License");
demayer 0:6bf0743ece18 5 * you may not use this file except in compliance with the License.
demayer 0:6bf0743ece18 6 * You may obtain a copy of the License at
demayer 0:6bf0743ece18 7 *
demayer 0:6bf0743ece18 8 * http://www.apache.org/licenses/LICENSE-2.0
demayer 0:6bf0743ece18 9 *
demayer 0:6bf0743ece18 10 * Unless required by applicable law or agreed to in writing, software
demayer 0:6bf0743ece18 11 * distributed under the License is distributed on an "AS IS" BASIS,
demayer 0:6bf0743ece18 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
demayer 0:6bf0743ece18 13 * See the License for the specific language governing permissions and
demayer 0:6bf0743ece18 14 * limitations under the License.
demayer 0:6bf0743ece18 15 */
demayer 0:6bf0743ece18 16
demayer 0:6bf0743ece18 17 #ifndef FILE_H
demayer 0:6bf0743ece18 18 #define FILE_H
demayer 0:6bf0743ece18 19
demayer 0:6bf0743ece18 20 #include "filesystem/FileSystem.h"
demayer 0:6bf0743ece18 21 #include "platform/FileHandle.h"
demayer 0:6bf0743ece18 22
demayer 0:6bf0743ece18 23 namespace mbed {
demayer 0:6bf0743ece18 24 /** \addtogroup filesystem */
demayer 0:6bf0743ece18 25 /** @{*/
demayer 0:6bf0743ece18 26
demayer 0:6bf0743ece18 27
demayer 0:6bf0743ece18 28 /** File class
demayer 0:6bf0743ece18 29 */
demayer 0:6bf0743ece18 30 class File : public FileHandle {
demayer 0:6bf0743ece18 31 public:
demayer 0:6bf0743ece18 32 /** Create an uninitialized file
demayer 0:6bf0743ece18 33 *
demayer 0:6bf0743ece18 34 * Must call open to initialize the file on a file system
demayer 0:6bf0743ece18 35 */
demayer 0:6bf0743ece18 36 File();
demayer 0:6bf0743ece18 37
demayer 0:6bf0743ece18 38 /** Create a file on a filesystem
demayer 0:6bf0743ece18 39 *
demayer 0:6bf0743ece18 40 * Creates and opens a file on a filesystem
demayer 0:6bf0743ece18 41 *
demayer 0:6bf0743ece18 42 * @param fs Filesystem as target for the file
demayer 0:6bf0743ece18 43 * @param path The name of the file to open
demayer 0:6bf0743ece18 44 * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
demayer 0:6bf0743ece18 45 * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
demayer 0:6bf0743ece18 46 */
demayer 0:6bf0743ece18 47 File(FileSystem *fs, const char *path, int flags = O_RDONLY);
demayer 0:6bf0743ece18 48
demayer 0:6bf0743ece18 49 /** Destroy a file
demayer 0:6bf0743ece18 50 *
demayer 0:6bf0743ece18 51 * Closes file if the file is still open
demayer 0:6bf0743ece18 52 */
demayer 0:6bf0743ece18 53 virtual ~File();
demayer 0:6bf0743ece18 54
demayer 0:6bf0743ece18 55 /** Open a file on the filesystem
demayer 0:6bf0743ece18 56 *
demayer 0:6bf0743ece18 57 * @param fs Filesystem as target for the file
demayer 0:6bf0743ece18 58 * @param path The name of the file to open
demayer 0:6bf0743ece18 59 * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
demayer 0:6bf0743ece18 60 * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
demayer 0:6bf0743ece18 61 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 62 */
demayer 0:6bf0743ece18 63 virtual int open(FileSystem *fs, const char *path, int flags=O_RDONLY);
demayer 0:6bf0743ece18 64
demayer 0:6bf0743ece18 65 /** Close a file
demayer 0:6bf0743ece18 66 *
demayer 0:6bf0743ece18 67 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 68 */
demayer 0:6bf0743ece18 69 virtual int close();
demayer 0:6bf0743ece18 70
demayer 0:6bf0743ece18 71 /** Read the contents of a file into a buffer
demayer 0:6bf0743ece18 72 *
demayer 0:6bf0743ece18 73 * @param buffer The buffer to read in to
demayer 0:6bf0743ece18 74 * @param size The number of bytes to read
demayer 0:6bf0743ece18 75 * @return The number of bytes read, 0 at end of file, negative error on failure
demayer 0:6bf0743ece18 76 */
demayer 0:6bf0743ece18 77
demayer 0:6bf0743ece18 78 virtual ssize_t read(void *buffer, size_t size);
demayer 0:6bf0743ece18 79
demayer 0:6bf0743ece18 80 /** Write the contents of a buffer to a file
demayer 0:6bf0743ece18 81 *
demayer 0:6bf0743ece18 82 * @param buffer The buffer to write from
demayer 0:6bf0743ece18 83 * @param size The number of bytes to write
demayer 0:6bf0743ece18 84 * @return The number of bytes written, negative error on failure
demayer 0:6bf0743ece18 85 */
demayer 0:6bf0743ece18 86 virtual ssize_t write(const void *buffer, size_t size);
demayer 0:6bf0743ece18 87
demayer 0:6bf0743ece18 88 /** Flush any buffers associated with the file
demayer 0:6bf0743ece18 89 *
demayer 0:6bf0743ece18 90 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 91 */
demayer 0:6bf0743ece18 92 virtual int sync();
demayer 0:6bf0743ece18 93
demayer 0:6bf0743ece18 94 /** Check if the file in an interactive terminal device
demayer 0:6bf0743ece18 95 *
demayer 0:6bf0743ece18 96 * @return True if the file is a terminal
demayer 0:6bf0743ece18 97 */
demayer 0:6bf0743ece18 98 virtual int isatty();
demayer 0:6bf0743ece18 99
demayer 0:6bf0743ece18 100 /** Move the file position to a given offset from from a given location
demayer 0:6bf0743ece18 101 *
demayer 0:6bf0743ece18 102 * @param offset The offset from whence to move to
demayer 0:6bf0743ece18 103 * @param whence The start of where to seek
demayer 0:6bf0743ece18 104 * SEEK_SET to start from beginning of file,
demayer 0:6bf0743ece18 105 * SEEK_CUR to start from current position in file,
demayer 0:6bf0743ece18 106 * SEEK_END to start from end of file
demayer 0:6bf0743ece18 107 * @return The new offset of the file
demayer 0:6bf0743ece18 108 */
demayer 0:6bf0743ece18 109 virtual off_t seek(off_t offset, int whence = SEEK_SET);
demayer 0:6bf0743ece18 110
demayer 0:6bf0743ece18 111 /** Get the file position of the file
demayer 0:6bf0743ece18 112 *
demayer 0:6bf0743ece18 113 * @return The current offset in the file
demayer 0:6bf0743ece18 114 */
demayer 0:6bf0743ece18 115 virtual off_t tell();
demayer 0:6bf0743ece18 116
demayer 0:6bf0743ece18 117 /** Rewind the file position to the beginning of the file
demayer 0:6bf0743ece18 118 *
demayer 0:6bf0743ece18 119 * @note This is equivalent to file_seek(file, 0, FS_SEEK_SET)
demayer 0:6bf0743ece18 120 */
demayer 0:6bf0743ece18 121 virtual void rewind();
demayer 0:6bf0743ece18 122
demayer 0:6bf0743ece18 123 /** Get the size of the file
demayer 0:6bf0743ece18 124 *
demayer 0:6bf0743ece18 125 * @return Size of the file in bytes
demayer 0:6bf0743ece18 126 */
demayer 0:6bf0743ece18 127 virtual off_t size();
demayer 0:6bf0743ece18 128
demayer 0:6bf0743ece18 129 private:
demayer 0:6bf0743ece18 130 FileSystem *_fs;
demayer 0:6bf0743ece18 131 fs_file_t _file;
demayer 0:6bf0743ece18 132 };
demayer 0:6bf0743ece18 133
demayer 0:6bf0743ece18 134
demayer 0:6bf0743ece18 135 /** @}*/
demayer 0:6bf0743ece18 136 } // namespace mbed
demayer 0:6bf0743ece18 137
demayer 0:6bf0743ece18 138 #endif