George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/FileSystemLike.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_FILESYSTEMLIKE_H
gkroussos 0:dd0fea342ad2 17 #define MBED_FILESYSTEMLIKE_H
gkroussos 0:dd0fea342ad2 18
gkroussos 0:dd0fea342ad2 19 #include "platform.h"
gkroussos 0:dd0fea342ad2 20
gkroussos 0:dd0fea342ad2 21 #include "FileBase.h"
gkroussos 0:dd0fea342ad2 22 #include "FileHandle.h"
gkroussos 0:dd0fea342ad2 23 #include "DirHandle.h"
gkroussos 0:dd0fea342ad2 24
gkroussos 0:dd0fea342ad2 25 namespace mbed {
gkroussos 0:dd0fea342ad2 26
gkroussos 0:dd0fea342ad2 27 /** A filesystem-like object is one that can be used to open files
gkroussos 0:dd0fea342ad2 28 * though it by fopen("/name/filename", mode)
gkroussos 0:dd0fea342ad2 29 *
gkroussos 0:dd0fea342ad2 30 * Implementations must define at least open (the default definitions
gkroussos 0:dd0fea342ad2 31 * of the rest of the functions just return error values).
gkroussos 0:dd0fea342ad2 32 */
gkroussos 0:dd0fea342ad2 33 class FileSystemLike : public FileBase {
gkroussos 0:dd0fea342ad2 34
gkroussos 0:dd0fea342ad2 35 public:
gkroussos 0:dd0fea342ad2 36 /** FileSystemLike constructor
gkroussos 0:dd0fea342ad2 37 *
gkroussos 0:dd0fea342ad2 38 * @param name The name to use for the filesystem.
gkroussos 0:dd0fea342ad2 39 */
gkroussos 0:dd0fea342ad2 40 FileSystemLike(const char *name);
gkroussos 0:dd0fea342ad2 41
gkroussos 0:dd0fea342ad2 42 virtual ~FileSystemLike();
gkroussos 0:dd0fea342ad2 43
gkroussos 0:dd0fea342ad2 44 static DirHandle *opendir();
gkroussos 0:dd0fea342ad2 45 friend class BaseDirHandle;
gkroussos 0:dd0fea342ad2 46
gkroussos 0:dd0fea342ad2 47 /** Opens a file from the filesystem
gkroussos 0:dd0fea342ad2 48 *
gkroussos 0:dd0fea342ad2 49 * @param filename The name of the file to open.
gkroussos 0:dd0fea342ad2 50 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
gkroussos 0:dd0fea342ad2 51 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
gkroussos 0:dd0fea342ad2 52 *
gkroussos 0:dd0fea342ad2 53 * @returns
gkroussos 0:dd0fea342ad2 54 * A pointer to a FileHandle object representing the
gkroussos 0:dd0fea342ad2 55 * file on success, or NULL on failure.
gkroussos 0:dd0fea342ad2 56 */
gkroussos 0:dd0fea342ad2 57 virtual FileHandle *open(const char *filename, int flags) = 0;
gkroussos 0:dd0fea342ad2 58
gkroussos 0:dd0fea342ad2 59 /** Remove a file from the filesystem.
gkroussos 0:dd0fea342ad2 60 *
gkroussos 0:dd0fea342ad2 61 * @param filename the name of the file to remove.
gkroussos 0:dd0fea342ad2 62 * @param returns 0 on success, -1 on failure.
gkroussos 0:dd0fea342ad2 63 */
gkroussos 0:dd0fea342ad2 64 virtual int remove(const char *filename) { return -1; };
gkroussos 0:dd0fea342ad2 65
gkroussos 0:dd0fea342ad2 66 /** Rename a file in the filesystem.
gkroussos 0:dd0fea342ad2 67 *
gkroussos 0:dd0fea342ad2 68 * @param oldname the name of the file to rename.
gkroussos 0:dd0fea342ad2 69 * @param newname the name to rename it to.
gkroussos 0:dd0fea342ad2 70 *
gkroussos 0:dd0fea342ad2 71 * @returns
gkroussos 0:dd0fea342ad2 72 * 0 on success,
gkroussos 0:dd0fea342ad2 73 * -1 on failure.
gkroussos 0:dd0fea342ad2 74 */
gkroussos 0:dd0fea342ad2 75 virtual int rename(const char *oldname, const char *newname) { return -1; };
gkroussos 0:dd0fea342ad2 76
gkroussos 0:dd0fea342ad2 77 /** Opens a directory in the filesystem and returns a DirHandle
gkroussos 0:dd0fea342ad2 78 * representing the directory stream.
gkroussos 0:dd0fea342ad2 79 *
gkroussos 0:dd0fea342ad2 80 * @param name The name of the directory to open.
gkroussos 0:dd0fea342ad2 81 *
gkroussos 0:dd0fea342ad2 82 * @returns
gkroussos 0:dd0fea342ad2 83 * A DirHandle representing the directory stream, or
gkroussos 0:dd0fea342ad2 84 * NULL on failure.
gkroussos 0:dd0fea342ad2 85 */
gkroussos 0:dd0fea342ad2 86 virtual DirHandle *opendir(const char *name) { return NULL; };
gkroussos 0:dd0fea342ad2 87
gkroussos 0:dd0fea342ad2 88 /** Creates a directory in the filesystem.
gkroussos 0:dd0fea342ad2 89 *
gkroussos 0:dd0fea342ad2 90 * @param name The name of the directory to create.
gkroussos 0:dd0fea342ad2 91 * @param mode The permissions to create the directory with.
gkroussos 0:dd0fea342ad2 92 *
gkroussos 0:dd0fea342ad2 93 * @returns
gkroussos 0:dd0fea342ad2 94 * 0 on success,
gkroussos 0:dd0fea342ad2 95 * -1 on failure.
gkroussos 0:dd0fea342ad2 96 */
gkroussos 0:dd0fea342ad2 97 virtual int mkdir(const char *name, mode_t mode) { return -1; }
gkroussos 0:dd0fea342ad2 98
gkroussos 0:dd0fea342ad2 99 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
gkroussos 0:dd0fea342ad2 100 };
gkroussos 0:dd0fea342ad2 101
gkroussos 0:dd0fea342ad2 102 } // namespace mbed
gkroussos 0:dd0fea342ad2 103
gkroussos 0:dd0fea342ad2 104 #endif