mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/DirHandle.h@140:97feb9bacc10, 2017-04-12 (annotated)

Committer:
<>
Date:
Wed Apr 12 16:07:08 2017 +0100
Revision:
140:97feb9bacc10
Parent:
138:093f2bd7b9eb 
Release 140 of the mbed library



Ports for Upcoming Targets



3841: Add nRf52840 target https://github.com/ARMmbed/mbed-os/pull/3841

3992: Introducing UBLOX_C030 platform. https://github.com/ARMmbed/mbed-os/pull/3992



Fixes and Changes



3951: [NUCLEO_F303ZE] Correct ARDUINO pin https://github.com/ARMmbed/mbed-os/pull/3951

4021: Fixing a macro to detect when RTOS was in use for the NRF52840_DK https://github.com/ARMmbed/mbed-os/pull/4021

3979: KW24D: Add missing SPI defines and Arduino connector definitions https://github.com/ARMmbed/mbed-os/pull/3979

3990: UBLOX_C027: construct a ticker-based wait, rather than calling wait_ms(), in the  https://github.com/ARMmbed/mbed-os/pull/3990

4003: Fixed OBOE in async serial tx for NRF52 target, fixes #4002 https://github.com/ARMmbed/mbed-os/pull/4003

4012: STM32: Correct I2C master error handling https://github.com/ARMmbed/mbed-os/pull/4012

4020: NUCLEO_L011K4 remove unsupported tool chain files https://github.com/ARMmbed/mbed-os/pull/4020

4065: K66F: Move bss section to m_data_2 Section https://github.com/ARMmbed/mbed-os/pull/4065

4014: Issue 3763: Reduce heap allocation in the GCC linker file https://github.com/ARMmbed/mbed-os/pull/4014

4030: [STM32L0] reduce IAR heap and stack size for small targets https://github.com/ARMmbed/mbed-os/pull/4030

4109: NUCLEO_L476RG : minor serial pin update https://github.com/ARMmbed/mbed-os/pull/4109

3982: Ticker - kl25z bugfix for handling events in the past https://github.com/ARMmbed/mbed-os/pull/3982

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 2 * Copyright (c) 2006-2013 ARM Limited
<> 128:9bcdf88f62b0 3 *
<> 128:9bcdf88f62b0 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 5 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 6 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 7 *
<> 128:9bcdf88f62b0 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 9 *
<> 128:9bcdf88f62b0 10 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 13 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 14 * limitations under the License.
<> 128:9bcdf88f62b0 15 */
<> 128:9bcdf88f62b0 16 #ifndef MBED_DIRHANDLE_H
<> 128:9bcdf88f62b0 17 #define MBED_DIRHANDLE_H
<> 128:9bcdf88f62b0 18
<> 138:093f2bd7b9eb 19 #include <stdint.h>
<> 138:093f2bd7b9eb 20 #include "platform/platform.h"
<> 128:9bcdf88f62b0 21
<> 128:9bcdf88f62b0 22 #include "FileHandle.h"
<> 128:9bcdf88f62b0 23
<> 128:9bcdf88f62b0 24 namespace mbed {
<> 128:9bcdf88f62b0 25 /** \addtogroup drivers */
<> 128:9bcdf88f62b0 26 /** @{*/
<> 128:9bcdf88f62b0 27
<> 128:9bcdf88f62b0 28 /** Represents a directory stream. Objects of this type are returned
<> 128:9bcdf88f62b0 29 * by a FileSystemLike's opendir method. Implementations must define
<> 128:9bcdf88f62b0 30 * at least closedir, readdir and rewinddir.
<> 128:9bcdf88f62b0 31 *
<> 128:9bcdf88f62b0 32 * If a FileSystemLike class defines the opendir method, then the
<> 128:9bcdf88f62b0 33 * directories of an object of that type can be accessed by
<> 128:9bcdf88f62b0 34 * DIR *d = opendir("/example/directory") (or opendir("/example")
<> 128:9bcdf88f62b0 35 * to open the root of the filesystem), and then using readdir(d) etc.
<> 128:9bcdf88f62b0 36 *
<> 128:9bcdf88f62b0 37 * The root directory is considered to contain all FileLike and
<> 128:9bcdf88f62b0 38 * FileSystemLike objects, so the DIR* returned by opendir("/") will
<> 128:9bcdf88f62b0 39 * reflect this.
<> 128:9bcdf88f62b0 40 *
<> 128:9bcdf88f62b0 41 * @Note Synchronization level: Set by subclass
<> 128:9bcdf88f62b0 42 */
<> 128:9bcdf88f62b0 43 class DirHandle {
<> 138:093f2bd7b9eb 44 public:
<> 138:093f2bd7b9eb 45 MBED_DEPRECATED_SINCE("mbed-os-5.4",
<> 138:093f2bd7b9eb 46 "The mbed 2 filesystem classes have been superseeded by the FileSystem api, "
<> 138:093f2bd7b9eb 47 "Replaced by File")
<> 138:093f2bd7b9eb 48 DirHandle() {}
<> 128:9bcdf88f62b0 49
<> 128:9bcdf88f62b0 50 /** Closes the directory.
<> 128:9bcdf88f62b0 51 *
<> 128:9bcdf88f62b0 52 * @returns
<> 128:9bcdf88f62b0 53 * 0 on success,
<> 128:9bcdf88f62b0 54 * -1 on error.
<> 128:9bcdf88f62b0 55 */
<> 128:9bcdf88f62b0 56 virtual int closedir()=0;
<> 128:9bcdf88f62b0 57
<> 128:9bcdf88f62b0 58 /** Return the directory entry at the current position, and
<> 128:9bcdf88f62b0 59 * advances the position to the next entry.
<> 128:9bcdf88f62b0 60 *
<> 128:9bcdf88f62b0 61 * @returns
<> 128:9bcdf88f62b0 62 * A pointer to a dirent structure representing the
<> 128:9bcdf88f62b0 63 * directory entry at the current position, or NULL on reaching
<> 128:9bcdf88f62b0 64 * end of directory or error.
<> 128:9bcdf88f62b0 65 */
<> 128:9bcdf88f62b0 66 virtual struct dirent *readdir()=0;
<> 128:9bcdf88f62b0 67
<> 128:9bcdf88f62b0 68 /** Resets the position to the beginning of the directory.
<> 128:9bcdf88f62b0 69 */
<> 128:9bcdf88f62b0 70 virtual void rewinddir()=0;
<> 128:9bcdf88f62b0 71
<> 128:9bcdf88f62b0 72 /** Returns the current position of the DirHandle.
<> 128:9bcdf88f62b0 73 *
<> 128:9bcdf88f62b0 74 * @returns
<> 128:9bcdf88f62b0 75 * the current position,
<> 128:9bcdf88f62b0 76 * -1 on error.
<> 128:9bcdf88f62b0 77 */
<> 128:9bcdf88f62b0 78 virtual off_t telldir() { return -1; }
<> 128:9bcdf88f62b0 79
<> 128:9bcdf88f62b0 80 /** Sets the position of the DirHandle.
<> 128:9bcdf88f62b0 81 *
<> 128:9bcdf88f62b0 82 * @param location The location to seek to. Must be a value returned by telldir.
<> 128:9bcdf88f62b0 83 */
<> 128:9bcdf88f62b0 84 virtual void seekdir(off_t location) { (void)location;}
<> 128:9bcdf88f62b0 85
<> 128:9bcdf88f62b0 86 virtual ~DirHandle() {}
<> 128:9bcdf88f62b0 87
<> 128:9bcdf88f62b0 88 protected:
<> 128:9bcdf88f62b0 89
<> 128:9bcdf88f62b0 90 /** Acquire exclusive access to this object.
<> 128:9bcdf88f62b0 91 */
<> 128:9bcdf88f62b0 92 virtual void lock() {
<> 128:9bcdf88f62b0 93 // Stub
<> 128:9bcdf88f62b0 94 }
<> 128:9bcdf88f62b0 95
<> 128:9bcdf88f62b0 96 /** Release exclusive access to this object.
<> 128:9bcdf88f62b0 97 */
<> 128:9bcdf88f62b0 98 virtual void unlock() {
<> 128:9bcdf88f62b0 99 // Stub
<> 128:9bcdf88f62b0 100 }
<> 138:093f2bd7b9eb 101
<> 138:093f2bd7b9eb 102 protected:
<> 138:093f2bd7b9eb 103 /** Internal-only constructor to work around deprecated notices when not used
<> 138:093f2bd7b9eb 104 *. due to nested deprecations and difficulty of compilers finding their way around
<> 138:093f2bd7b9eb 105 * the class hierarchy
<> 138:093f2bd7b9eb 106 */
<> 138:093f2bd7b9eb 107 friend class FileSystemLike;
<> 138:093f2bd7b9eb 108 DirHandle(int) {}
<> 128:9bcdf88f62b0 109 };
<> 128:9bcdf88f62b0 110
<> 128:9bcdf88f62b0 111 } // namespace mbed
<> 128:9bcdf88f62b0 112
<> 128:9bcdf88f62b0 113 #endif /* MBED_DIRHANDLE_H */
<> 128:9bcdf88f62b0 114
<> 128:9bcdf88f62b0 115 /** @}*/