George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/DirHandle.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:e8fdba0ed044 1 /* mbed Microcontroller Library
gkroussos 0:e8fdba0ed044 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:e8fdba0ed044 3 *
gkroussos 0:e8fdba0ed044 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:e8fdba0ed044 5 * you may not use this file except in compliance with the License.
gkroussos 0:e8fdba0ed044 6 * You may obtain a copy of the License at
gkroussos 0:e8fdba0ed044 7 *
gkroussos 0:e8fdba0ed044 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:e8fdba0ed044 9 *
gkroussos 0:e8fdba0ed044 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:e8fdba0ed044 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:e8fdba0ed044 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:e8fdba0ed044 13 * See the License for the specific language governing permissions and
gkroussos 0:e8fdba0ed044 14 * limitations under the License.
gkroussos 0:e8fdba0ed044 15 */
gkroussos 0:e8fdba0ed044 16 #ifndef MBED_DIRHANDLE_H
gkroussos 0:e8fdba0ed044 17 #define MBED_DIRHANDLE_H
gkroussos 0:e8fdba0ed044 18
gkroussos 0:e8fdba0ed044 19 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
gkroussos 0:e8fdba0ed044 20 # define NAME_MAX 255
gkroussos 0:e8fdba0ed044 21 typedef int mode_t;
gkroussos 0:e8fdba0ed044 22
gkroussos 0:e8fdba0ed044 23 #else
gkroussos 0:e8fdba0ed044 24 # include <sys/syslimits.h>
gkroussos 0:e8fdba0ed044 25 #endif
gkroussos 0:e8fdba0ed044 26
gkroussos 0:e8fdba0ed044 27 #include "FileHandle.h"
gkroussos 0:e8fdba0ed044 28
gkroussos 0:e8fdba0ed044 29 struct dirent {
gkroussos 0:e8fdba0ed044 30 char d_name[NAME_MAX+1];
gkroussos 0:e8fdba0ed044 31 };
gkroussos 0:e8fdba0ed044 32
gkroussos 0:e8fdba0ed044 33 namespace mbed {
gkroussos 0:e8fdba0ed044 34
gkroussos 0:e8fdba0ed044 35 /** Represents a directory stream. Objects of this type are returned
gkroussos 0:e8fdba0ed044 36 * by a FileSystemLike's opendir method. Implementations must define
gkroussos 0:e8fdba0ed044 37 * at least closedir, readdir and rewinddir.
gkroussos 0:e8fdba0ed044 38 *
gkroussos 0:e8fdba0ed044 39 * If a FileSystemLike class defines the opendir method, then the
gkroussos 0:e8fdba0ed044 40 * directories of an object of that type can be accessed by
gkroussos 0:e8fdba0ed044 41 * DIR *d = opendir("/example/directory") (or opendir("/example")
gkroussos 0:e8fdba0ed044 42 * to open the root of the filesystem), and then using readdir(d) etc.
gkroussos 0:e8fdba0ed044 43 *
gkroussos 0:e8fdba0ed044 44 * The root directory is considered to contain all FileLike and
gkroussos 0:e8fdba0ed044 45 * FileSystemLike objects, so the DIR* returned by opendir("/") will
gkroussos 0:e8fdba0ed044 46 * reflect this.
gkroussos 0:e8fdba0ed044 47 */
gkroussos 0:e8fdba0ed044 48 class DirHandle {
gkroussos 0:e8fdba0ed044 49
gkroussos 0:e8fdba0ed044 50 public:
gkroussos 0:e8fdba0ed044 51 /** Closes the directory.
gkroussos 0:e8fdba0ed044 52 *
gkroussos 0:e8fdba0ed044 53 * @returns
gkroussos 0:e8fdba0ed044 54 * 0 on success,
gkroussos 0:e8fdba0ed044 55 * -1 on error.
gkroussos 0:e8fdba0ed044 56 */
gkroussos 0:e8fdba0ed044 57 virtual int closedir()=0;
gkroussos 0:e8fdba0ed044 58
gkroussos 0:e8fdba0ed044 59 /** Return the directory entry at the current position, and
gkroussos 0:e8fdba0ed044 60 * advances the position to the next entry.
gkroussos 0:e8fdba0ed044 61 *
gkroussos 0:e8fdba0ed044 62 * @returns
gkroussos 0:e8fdba0ed044 63 * A pointer to a dirent structure representing the
gkroussos 0:e8fdba0ed044 64 * directory entry at the current position, or NULL on reaching
gkroussos 0:e8fdba0ed044 65 * end of directory or error.
gkroussos 0:e8fdba0ed044 66 */
gkroussos 0:e8fdba0ed044 67 virtual struct dirent *readdir()=0;
gkroussos 0:e8fdba0ed044 68
gkroussos 0:e8fdba0ed044 69 /** Resets the position to the beginning of the directory.
gkroussos 0:e8fdba0ed044 70 */
gkroussos 0:e8fdba0ed044 71 virtual void rewinddir()=0;
gkroussos 0:e8fdba0ed044 72
gkroussos 0:e8fdba0ed044 73 /** Returns the current position of the DirHandle.
gkroussos 0:e8fdba0ed044 74 *
gkroussos 0:e8fdba0ed044 75 * @returns
gkroussos 0:e8fdba0ed044 76 * the current position,
gkroussos 0:e8fdba0ed044 77 * -1 on error.
gkroussos 0:e8fdba0ed044 78 */
gkroussos 0:e8fdba0ed044 79 virtual off_t telldir() { return -1; }
gkroussos 0:e8fdba0ed044 80
gkroussos 0:e8fdba0ed044 81 /** Sets the position of the DirHandle.
gkroussos 0:e8fdba0ed044 82 *
gkroussos 0:e8fdba0ed044 83 * @param location The location to seek to. Must be a value returned by telldir.
gkroussos 0:e8fdba0ed044 84 */
gkroussos 0:e8fdba0ed044 85 virtual void seekdir(off_t location) { }
gkroussos 0:e8fdba0ed044 86
gkroussos 0:e8fdba0ed044 87 virtual ~DirHandle() {}
gkroussos 0:e8fdba0ed044 88 };
gkroussos 0:e8fdba0ed044 89
gkroussos 0:e8fdba0ed044 90 } // namespace mbed
gkroussos 0:e8fdba0ed044 91
gkroussos 0:e8fdba0ed044 92 typedef mbed::DirHandle DIR;
gkroussos 0:e8fdba0ed044 93
gkroussos 0:e8fdba0ed044 94 extern "C" {
gkroussos 0:e8fdba0ed044 95 DIR *opendir(const char*);
gkroussos 0:e8fdba0ed044 96 struct dirent *readdir(DIR *);
gkroussos 0:e8fdba0ed044 97 int closedir(DIR*);
gkroussos 0:e8fdba0ed044 98 void rewinddir(DIR*);
gkroussos 0:e8fdba0ed044 99 long telldir(DIR*);
gkroussos 0:e8fdba0ed044 100 void seekdir(DIR*, long);
gkroussos 0:e8fdba0ed044 101 int mkdir(const char *name, mode_t n);
gkroussos 0:e8fdba0ed044 102 };
gkroussos 0:e8fdba0ed044 103
gkroussos 0:e8fdba0ed044 104 #endif /* MBED_DIRHANDLE_H */