PES4 / Mbed OS Queue_02

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/Dir.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 DIR_H
demayer 0:6bf0743ece18 18 #define DIR_H
demayer 0:6bf0743ece18 19
demayer 0:6bf0743ece18 20 #include "filesystem/FileSystem.h"
demayer 0:6bf0743ece18 21 #include "platform/DirHandle.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 /** Dir class
demayer 0:6bf0743ece18 29 */
demayer 0:6bf0743ece18 30 class Dir : public DirHandle {
demayer 0:6bf0743ece18 31 public:
demayer 0:6bf0743ece18 32 /** Create an uninitialized directory
demayer 0:6bf0743ece18 33 *
demayer 0:6bf0743ece18 34 * Must call open to initialize the directory on a file system
demayer 0:6bf0743ece18 35 */
demayer 0:6bf0743ece18 36 Dir();
demayer 0:6bf0743ece18 37
demayer 0:6bf0743ece18 38 /** Open a directory on a filesystem
demayer 0:6bf0743ece18 39 *
demayer 0:6bf0743ece18 40 * @param fs Filesystem as target for a directory
demayer 0:6bf0743ece18 41 * @param path Name of the directory to open
demayer 0:6bf0743ece18 42 */
demayer 0:6bf0743ece18 43 Dir(FileSystem *fs, const char *path);
demayer 0:6bf0743ece18 44
demayer 0:6bf0743ece18 45 /** Destroy a file
demayer 0:6bf0743ece18 46 *
demayer 0:6bf0743ece18 47 * Closes file if the file is still open
demayer 0:6bf0743ece18 48 */
demayer 0:6bf0743ece18 49 virtual ~Dir();
demayer 0:6bf0743ece18 50
demayer 0:6bf0743ece18 51 /** Open a directory on the filesystem
demayer 0:6bf0743ece18 52 *
demayer 0:6bf0743ece18 53 * @param fs Filesystem as target for a directory
demayer 0:6bf0743ece18 54 * @param path Name of the directory to open
demayer 0:6bf0743ece18 55 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 56 */
demayer 0:6bf0743ece18 57 virtual int open(FileSystem *fs, const char *path);
demayer 0:6bf0743ece18 58
demayer 0:6bf0743ece18 59 /** Close a directory
demayer 0:6bf0743ece18 60 *
demayer 0:6bf0743ece18 61 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 62 */
demayer 0:6bf0743ece18 63 virtual int close();
demayer 0:6bf0743ece18 64
demayer 0:6bf0743ece18 65 /** Read the next directory entry
demayer 0:6bf0743ece18 66 *
demayer 0:6bf0743ece18 67 * @param ent The directory entry to fill out
demayer 0:6bf0743ece18 68 * @return 1 on reading a filename, 0 at end of directory, negative error on failure
demayer 0:6bf0743ece18 69 */
demayer 0:6bf0743ece18 70 virtual ssize_t read(struct dirent *ent);
demayer 0:6bf0743ece18 71
demayer 0:6bf0743ece18 72 /** Set the current position of the directory
demayer 0:6bf0743ece18 73 *
demayer 0:6bf0743ece18 74 * @param offset Offset of the location to seek to,
demayer 0:6bf0743ece18 75 * must be a value returned from tell
demayer 0:6bf0743ece18 76 */
demayer 0:6bf0743ece18 77 virtual void seek(off_t offset);
demayer 0:6bf0743ece18 78
demayer 0:6bf0743ece18 79 /** Get the current position of the directory
demayer 0:6bf0743ece18 80 *
demayer 0:6bf0743ece18 81 * @return Position of the directory that can be passed to rewind
demayer 0:6bf0743ece18 82 */
demayer 0:6bf0743ece18 83 virtual off_t tell();
demayer 0:6bf0743ece18 84
demayer 0:6bf0743ece18 85 /** Rewind the current position to the beginning of the directory
demayer 0:6bf0743ece18 86 */
demayer 0:6bf0743ece18 87 virtual void rewind();
demayer 0:6bf0743ece18 88
demayer 0:6bf0743ece18 89 /** Get the sizeof the directory
demayer 0:6bf0743ece18 90 *
demayer 0:6bf0743ece18 91 * @return Number of files in the directory
demayer 0:6bf0743ece18 92 */
demayer 0:6bf0743ece18 93 virtual size_t size();
demayer 0:6bf0743ece18 94
demayer 0:6bf0743ece18 95 private:
demayer 0:6bf0743ece18 96 FileSystem *_fs;
demayer 0:6bf0743ece18 97 fs_dir_t _dir;
demayer 0:6bf0743ece18 98 };
demayer 0:6bf0743ece18 99
demayer 0:6bf0743ece18 100
demayer 0:6bf0743ece18 101 /** @}*/
demayer 0:6bf0743ece18 102 } // namespace mbed
demayer 0:6bf0743ece18 103
demayer 0:6bf0743ece18 104 #endif