Mike Pulice / ublox_C200Test

Integrating the ublox LISA C200 modem

Fork of SprintUSBModemHTTPClientTest by Donatien Garnier

mbed-src/api/FileSystemLike.h@5:3f93dd1d4cb3, 2013-09-26 (annotated)

Committer:
sam_grove
Date:
Thu Sep 26 00:44:20 2013 -0500
Revision:
5:3f93dd1d4cb3
Exported program and replaced contents of the repo with the source

to build and debug using keil mdk. Libs NOT upto date are lwip, lwip-sys

and socket. these have newer versions under mbed_official but were starting

from a know working point

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sam_grove 5:3f93dd1d4cb3 1 /* mbed Microcontroller Library
sam_grove 5:3f93dd1d4cb3 2 * Copyright (c) 2006-2013 ARM Limited
sam_grove 5:3f93dd1d4cb3 3 *
sam_grove 5:3f93dd1d4cb3 4 * Licensed under the Apache License, Version 2.0 (the "License");
sam_grove 5:3f93dd1d4cb3 5 * you may not use this file except in compliance with the License.
sam_grove 5:3f93dd1d4cb3 6 * You may obtain a copy of the License at
sam_grove 5:3f93dd1d4cb3 7 *
sam_grove 5:3f93dd1d4cb3 8 * http://www.apache.org/licenses/LICENSE-2.0
sam_grove 5:3f93dd1d4cb3 9 *
sam_grove 5:3f93dd1d4cb3 10 * Unless required by applicable law or agreed to in writing, software
sam_grove 5:3f93dd1d4cb3 11 * distributed under the License is distributed on an "AS IS" BASIS,
sam_grove 5:3f93dd1d4cb3 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sam_grove 5:3f93dd1d4cb3 13 * See the License for the specific language governing permissions and
sam_grove 5:3f93dd1d4cb3 14 * limitations under the License.
sam_grove 5:3f93dd1d4cb3 15 */
sam_grove 5:3f93dd1d4cb3 16 #ifndef MBED_FILESYSTEMLIKE_H
sam_grove 5:3f93dd1d4cb3 17 #define MBED_FILESYSTEMLIKE_H
sam_grove 5:3f93dd1d4cb3 18
sam_grove 5:3f93dd1d4cb3 19 #include "platform.h"
sam_grove 5:3f93dd1d4cb3 20
sam_grove 5:3f93dd1d4cb3 21 #include "FileBase.h"
sam_grove 5:3f93dd1d4cb3 22 #include "FileHandle.h"
sam_grove 5:3f93dd1d4cb3 23 #include "DirHandle.h"
sam_grove 5:3f93dd1d4cb3 24
sam_grove 5:3f93dd1d4cb3 25 namespace mbed {
sam_grove 5:3f93dd1d4cb3 26
sam_grove 5:3f93dd1d4cb3 27 /** A filesystem-like object is one that can be used to open files
sam_grove 5:3f93dd1d4cb3 28 * though it by fopen("/name/filename", mode)
sam_grove 5:3f93dd1d4cb3 29 *
sam_grove 5:3f93dd1d4cb3 30 * Implementations must define at least open (the default definitions
sam_grove 5:3f93dd1d4cb3 31 * of the rest of the functions just return error values).
sam_grove 5:3f93dd1d4cb3 32 */
sam_grove 5:3f93dd1d4cb3 33 class FileSystemLike : public FileBase {
sam_grove 5:3f93dd1d4cb3 34
sam_grove 5:3f93dd1d4cb3 35 public:
sam_grove 5:3f93dd1d4cb3 36 /** FileSystemLike constructor
sam_grove 5:3f93dd1d4cb3 37 *
sam_grove 5:3f93dd1d4cb3 38 * @param name The name to use for the filesystem.
sam_grove 5:3f93dd1d4cb3 39 */
sam_grove 5:3f93dd1d4cb3 40 FileSystemLike(const char *name);
sam_grove 5:3f93dd1d4cb3 41
sam_grove 5:3f93dd1d4cb3 42 virtual ~FileSystemLike();
sam_grove 5:3f93dd1d4cb3 43
sam_grove 5:3f93dd1d4cb3 44 static DirHandle *opendir();
sam_grove 5:3f93dd1d4cb3 45 friend class BaseDirHandle;
sam_grove 5:3f93dd1d4cb3 46
sam_grove 5:3f93dd1d4cb3 47 /** Opens a file from the filesystem
sam_grove 5:3f93dd1d4cb3 48 *
sam_grove 5:3f93dd1d4cb3 49 * @param filename The name of the file to open.
sam_grove 5:3f93dd1d4cb3 50 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
sam_grove 5:3f93dd1d4cb3 51 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
sam_grove 5:3f93dd1d4cb3 52 *
sam_grove 5:3f93dd1d4cb3 53 * @returns
sam_grove 5:3f93dd1d4cb3 54 * A pointer to a FileHandle object representing the
sam_grove 5:3f93dd1d4cb3 55 * file on success, or NULL on failure.
sam_grove 5:3f93dd1d4cb3 56 */
sam_grove 5:3f93dd1d4cb3 57 virtual FileHandle *open(const char *filename, int flags) = 0;
sam_grove 5:3f93dd1d4cb3 58
sam_grove 5:3f93dd1d4cb3 59 /** Remove a file from the filesystem.
sam_grove 5:3f93dd1d4cb3 60 *
sam_grove 5:3f93dd1d4cb3 61 * @param filename the name of the file to remove.
sam_grove 5:3f93dd1d4cb3 62 * @param returns 0 on success, -1 on failure.
sam_grove 5:3f93dd1d4cb3 63 */
sam_grove 5:3f93dd1d4cb3 64 virtual int remove(const char *filename) { return -1; };
sam_grove 5:3f93dd1d4cb3 65
sam_grove 5:3f93dd1d4cb3 66 /** Rename a file in the filesystem.
sam_grove 5:3f93dd1d4cb3 67 *
sam_grove 5:3f93dd1d4cb3 68 * @param oldname the name of the file to rename.
sam_grove 5:3f93dd1d4cb3 69 * @param newname the name to rename it to.
sam_grove 5:3f93dd1d4cb3 70 *
sam_grove 5:3f93dd1d4cb3 71 * @returns
sam_grove 5:3f93dd1d4cb3 72 * 0 on success,
sam_grove 5:3f93dd1d4cb3 73 * -1 on failure.
sam_grove 5:3f93dd1d4cb3 74 */
sam_grove 5:3f93dd1d4cb3 75 virtual int rename(const char *oldname, const char *newname) { return -1; };
sam_grove 5:3f93dd1d4cb3 76
sam_grove 5:3f93dd1d4cb3 77 /** Opens a directory in the filesystem and returns a DirHandle
sam_grove 5:3f93dd1d4cb3 78 * representing the directory stream.
sam_grove 5:3f93dd1d4cb3 79 *
sam_grove 5:3f93dd1d4cb3 80 * @param name The name of the directory to open.
sam_grove 5:3f93dd1d4cb3 81 *
sam_grove 5:3f93dd1d4cb3 82 * @returns
sam_grove 5:3f93dd1d4cb3 83 * A DirHandle representing the directory stream, or
sam_grove 5:3f93dd1d4cb3 84 * NULL on failure.
sam_grove 5:3f93dd1d4cb3 85 */
sam_grove 5:3f93dd1d4cb3 86 virtual DirHandle *opendir(const char *name) { return NULL; };
sam_grove 5:3f93dd1d4cb3 87
sam_grove 5:3f93dd1d4cb3 88 /** Creates a directory in the filesystem.
sam_grove 5:3f93dd1d4cb3 89 *
sam_grove 5:3f93dd1d4cb3 90 * @param name The name of the directory to create.
sam_grove 5:3f93dd1d4cb3 91 * @param mode The permissions to create the directory with.
sam_grove 5:3f93dd1d4cb3 92 *
sam_grove 5:3f93dd1d4cb3 93 * @returns
sam_grove 5:3f93dd1d4cb3 94 * 0 on success,
sam_grove 5:3f93dd1d4cb3 95 * -1 on failure.
sam_grove 5:3f93dd1d4cb3 96 */
sam_grove 5:3f93dd1d4cb3 97 virtual int mkdir(const char *name, mode_t mode) { return -1; }
sam_grove 5:3f93dd1d4cb3 98
sam_grove 5:3f93dd1d4cb3 99 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
sam_grove 5:3f93dd1d4cb3 100 };
sam_grove 5:3f93dd1d4cb3 101
sam_grove 5:3f93dd1d4cb3 102 } // namespace mbed
sam_grove 5:3f93dd1d4cb3 103
sam_grove 5:3f93dd1d4cb3 104 #endif