Milen Pavlov / XRange_mbed_src

Mbed SDK for XRange SX1272 LoRa module

Dependents:   XRangePingPong XRange-LoRaWAN-lmic-app lora-transceiver

SX1272 LoRa RF module

https://www.netblocks.eu/xrange-sx1272-lora-datasheet/

api/DirHandle.h@336:1e18a06a987b, 2015-01-15 (annotated)

Committer:
dudmuck
Date:
Thu Jan 15 02:25:40 2015 +0000
Revision:
336:1e18a06a987b
updated to rev443 of official mbed-src

Who changed what in which revision?

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