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/FileHandle.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_FILEHANDLE_H
dudmuck 336:1e18a06a987b 17 #define MBED_FILEHANDLE_H
dudmuck 336:1e18a06a987b 18
dudmuck 336:1e18a06a987b 19 typedef int FILEHANDLE;
dudmuck 336:1e18a06a987b 20
dudmuck 336:1e18a06a987b 21 #include <stdio.h>
dudmuck 336:1e18a06a987b 22
dudmuck 336:1e18a06a987b 23 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
dudmuck 336:1e18a06a987b 24 typedef int ssize_t;
dudmuck 336:1e18a06a987b 25 typedef long off_t;
dudmuck 336:1e18a06a987b 26
dudmuck 336:1e18a06a987b 27 #else
dudmuck 336:1e18a06a987b 28 # include <sys/types.h>
dudmuck 336:1e18a06a987b 29 #endif
dudmuck 336:1e18a06a987b 30
dudmuck 336:1e18a06a987b 31 namespace mbed {
dudmuck 336:1e18a06a987b 32
dudmuck 336:1e18a06a987b 33 /** An OO equivalent of the internal FILEHANDLE variable
dudmuck 336:1e18a06a987b 34 * and associated _sys_* functions.
dudmuck 336:1e18a06a987b 35 *
dudmuck 336:1e18a06a987b 36 * FileHandle is an abstract class, needing at least sys_write and
dudmuck 336:1e18a06a987b 37 * sys_read to be implmented for a simple interactive device.
dudmuck 336:1e18a06a987b 38 *
dudmuck 336:1e18a06a987b 39 * No one ever directly tals to/instanciates a FileHandle - it gets
dudmuck 336:1e18a06a987b 40 * created by FileSystem, and wrapped up by stdio.
dudmuck 336:1e18a06a987b 41 */
dudmuck 336:1e18a06a987b 42 class FileHandle {
dudmuck 336:1e18a06a987b 43
dudmuck 336:1e18a06a987b 44 public:
dudmuck 336:1e18a06a987b 45 /** Write the contents of a buffer to the file
dudmuck 336:1e18a06a987b 46 *
dudmuck 336:1e18a06a987b 47 * @param buffer the buffer to write from
dudmuck 336:1e18a06a987b 48 * @param length the number of characters to write
dudmuck 336:1e18a06a987b 49 *
dudmuck 336:1e18a06a987b 50 * @returns
dudmuck 336:1e18a06a987b 51 * The number of characters written (possibly 0) on success, -1 on error.
dudmuck 336:1e18a06a987b 52 */
dudmuck 336:1e18a06a987b 53 virtual ssize_t write(const void* buffer, size_t length) = 0;
dudmuck 336:1e18a06a987b 54
dudmuck 336:1e18a06a987b 55 /** Close the file
dudmuck 336:1e18a06a987b 56 *
dudmuck 336:1e18a06a987b 57 * @returns
dudmuck 336:1e18a06a987b 58 * Zero on success, -1 on error.
dudmuck 336:1e18a06a987b 59 */
dudmuck 336:1e18a06a987b 60 virtual int close() = 0;
dudmuck 336:1e18a06a987b 61
dudmuck 336:1e18a06a987b 62 /** Function read
dudmuck 336:1e18a06a987b 63 * Reads the contents of the file into a buffer
dudmuck 336:1e18a06a987b 64 *
dudmuck 336:1e18a06a987b 65 * @param buffer the buffer to read in to
dudmuck 336:1e18a06a987b 66 * @param length the number of characters to read
dudmuck 336:1e18a06a987b 67 *
dudmuck 336:1e18a06a987b 68 * @returns
dudmuck 336:1e18a06a987b 69 * The number of characters read (zero at end of file) on success, -1 on error.
dudmuck 336:1e18a06a987b 70 */
dudmuck 336:1e18a06a987b 71 virtual ssize_t read(void* buffer, size_t length) = 0;
dudmuck 336:1e18a06a987b 72
dudmuck 336:1e18a06a987b 73 /** Check if the handle is for a interactive terminal device.
dudmuck 336:1e18a06a987b 74 * If so, line buffered behaviour is used by default
dudmuck 336:1e18a06a987b 75 *
dudmuck 336:1e18a06a987b 76 * @returns
dudmuck 336:1e18a06a987b 77 * 1 if it is a terminal,
dudmuck 336:1e18a06a987b 78 * 0 otherwise
dudmuck 336:1e18a06a987b 79 */
dudmuck 336:1e18a06a987b 80 virtual int isatty() = 0;
dudmuck 336:1e18a06a987b 81
dudmuck 336:1e18a06a987b 82 /** Move the file position to a given offset from a given location.
dudmuck 336:1e18a06a987b 83 *
dudmuck 336:1e18a06a987b 84 * @param offset The offset from whence to move to
dudmuck 336:1e18a06a987b 85 * @param whence SEEK_SET for the start of the file, SEEK_CUR for the
dudmuck 336:1e18a06a987b 86 * current file position, or SEEK_END for the end of the file.
dudmuck 336:1e18a06a987b 87 *
dudmuck 336:1e18a06a987b 88 * @returns
dudmuck 336:1e18a06a987b 89 * new file position on success,
dudmuck 336:1e18a06a987b 90 * -1 on failure or unsupported
dudmuck 336:1e18a06a987b 91 */
dudmuck 336:1e18a06a987b 92 virtual off_t lseek(off_t offset, int whence) = 0;
dudmuck 336:1e18a06a987b 93
dudmuck 336:1e18a06a987b 94 /** Flush any buffers associated with the FileHandle, ensuring it
dudmuck 336:1e18a06a987b 95 * is up to date on disk
dudmuck 336:1e18a06a987b 96 *
dudmuck 336:1e18a06a987b 97 * @returns
dudmuck 336:1e18a06a987b 98 * 0 on success or un-needed,
dudmuck 336:1e18a06a987b 99 * -1 on error
dudmuck 336:1e18a06a987b 100 */
dudmuck 336:1e18a06a987b 101 virtual int fsync() = 0;
dudmuck 336:1e18a06a987b 102
dudmuck 336:1e18a06a987b 103 virtual off_t flen() {
dudmuck 336:1e18a06a987b 104 /* remember our current position */
dudmuck 336:1e18a06a987b 105 off_t pos = lseek(0, SEEK_CUR);
dudmuck 336:1e18a06a987b 106 if(pos == -1) return -1;
dudmuck 336:1e18a06a987b 107 /* seek to the end to get the file length */
dudmuck 336:1e18a06a987b 108 off_t res = lseek(0, SEEK_END);
dudmuck 336:1e18a06a987b 109 /* return to our old position */
dudmuck 336:1e18a06a987b 110 lseek(pos, SEEK_SET);
dudmuck 336:1e18a06a987b 111 return res;
dudmuck 336:1e18a06a987b 112 }
dudmuck 336:1e18a06a987b 113
dudmuck 336:1e18a06a987b 114 virtual ~FileHandle();
dudmuck 336:1e18a06a987b 115 };
dudmuck 336:1e18a06a987b 116
dudmuck 336:1e18a06a987b 117 } // namespace mbed
dudmuck 336:1e18a06a987b 118
dudmuck 336:1e18a06a987b 119 #endif