George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/DirHandle.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

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