Mike Pulice / ublox_C200Test

Integrating the ublox LISA C200 modem

Fork of SprintUSBModemHTTPClientTest by Donatien Garnier

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