ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

types/WiconnectFile.h@24:e27e23297f02, 2014-09-06 (annotated)

Committer:
dan_ackme
Date:
Sat Sep 06 20:34:01 2014 -0700
Revision:
24:e27e23297f02
Parent:
17:7268f365676b 
add api to get/set module settings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 24:e27e23297f02 1 /**
dan_ackme 24:e27e23297f02 2 * ACKme WiConnect Host Library is licensed under the BSD licence:
dan_ackme 24:e27e23297f02 3 *
dan_ackme 24:e27e23297f02 4 * Copyright (c)2014 ACKme Networks.
dan_ackme 24:e27e23297f02 5 * All rights reserved.
dan_ackme 24:e27e23297f02 6 *
dan_ackme 24:e27e23297f02 7 * Redistribution and use in source and binary forms, with or without modification,
dan_ackme 24:e27e23297f02 8 * are permitted provided that the following conditions are met:
dan_ackme 24:e27e23297f02 9 *
dan_ackme 24:e27e23297f02 10 * 1. Redistributions of source code must retain the above copyright notice,
dan_ackme 24:e27e23297f02 11 * this list of conditions and the following disclaimer.
dan_ackme 24:e27e23297f02 12 * 2. Redistributions in binary form must reproduce the above copyright notice,
dan_ackme 24:e27e23297f02 13 * this list of conditions and the following disclaimer in the documentation
dan_ackme 24:e27e23297f02 14 * and/or other materials provided with the distribution.
dan_ackme 24:e27e23297f02 15 * 3. The name of the author may not be used to endorse or promote products
dan_ackme 24:e27e23297f02 16 * derived from this software without specific prior written permission.
dan_ackme 24:e27e23297f02 17 *
dan_ackme 24:e27e23297f02 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED
dan_ackme 24:e27e23297f02 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
dan_ackme 24:e27e23297f02 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
dan_ackme 24:e27e23297f02 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
dan_ackme 24:e27e23297f02 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
dan_ackme 24:e27e23297f02 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
dan_ackme 24:e27e23297f02 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
dan_ackme 24:e27e23297f02 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
dan_ackme 24:e27e23297f02 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
dan_ackme 24:e27e23297f02 27 * OF SUCH DAMAGE.
dan_ackme 17:7268f365676b 28 */
dan_ackme 17:7268f365676b 29 #pragma once
dan_ackme 17:7268f365676b 30
dan_ackme 17:7268f365676b 31
dan_ackme 17:7268f365676b 32 #include "Wiconnect.h"
dan_ackme 17:7268f365676b 33
dan_ackme 17:7268f365676b 34 namespace wiconnect
dan_ackme 17:7268f365676b 35 {
dan_ackme 17:7268f365676b 36
dan_ackme 17:7268f365676b 37
dan_ackme 17:7268f365676b 38 /**
dan_ackme 17:7268f365676b 39 * @ingroup api_file_types
dan_ackme 17:7268f365676b 40 *
dan_ackme 17:7268f365676b 41 * @brief WiConnect WiFi module file object.
dan_ackme 17:7268f365676b 42 *
dan_ackme 17:7268f365676b 43 */
dan_ackme 17:7268f365676b 44 class WiconnectFile
dan_ackme 17:7268f365676b 45 {
dan_ackme 17:7268f365676b 46 public:
dan_ackme 17:7268f365676b 47 WiconnectFile(int rxBufferLen = 0, void *rxBuffer = NULL);
dan_ackme 17:7268f365676b 48 ~WiconnectFile();
dan_ackme 17:7268f365676b 49
dan_ackme 17:7268f365676b 50 const char* getName() const;
dan_ackme 17:7268f365676b 51 uint32_t getSize() const;
dan_ackme 17:7268f365676b 52 FileType getType() const;
dan_ackme 17:7268f365676b 53 FileFlags getFlags() const;
dan_ackme 17:7268f365676b 54 uint32_t getVersion() const;
dan_ackme 17:7268f365676b 55 const char* getVersionStr(char *buffer = NULL) const;
dan_ackme 17:7268f365676b 56
dan_ackme 17:7268f365676b 57 WiconnectResult close();
dan_ackme 17:7268f365676b 58 WiconnectResult read(void* buffer, uint16_t maxLength, uint16_t *bytesRead);
dan_ackme 17:7268f365676b 59 WiconnectResult read(uint8_t **bufferPtr = NULL, uint16_t *bytesReadPtr = NULL);
dan_ackme 17:7268f365676b 60 WiconnectResult getc(uint8_t *c);
dan_ackme 17:7268f365676b 61 void clearRxBuffer();
dan_ackme 17:7268f365676b 62
dan_ackme 17:7268f365676b 63 const WiconnectFile* getNext() const;
dan_ackme 17:7268f365676b 64 const WiconnectFile* getPrevious() const;
dan_ackme 17:7268f365676b 65
dan_ackme 17:7268f365676b 66 protected:
dan_ackme 17:7268f365676b 67 WiconnectResult openForRead(uint8_t handle, const char *filename);
dan_ackme 17:7268f365676b 68 WiconnectResult initWithListing(const char *typeStr, const char *flagsStr, const char* sizeStr, const char *versionStr, const char *nameStr);
dan_ackme 17:7268f365676b 69
dan_ackme 17:7268f365676b 70 uint8_t handle;
dan_ackme 17:7268f365676b 71 bool readEnabled;
dan_ackme 17:7268f365676b 72 char name[WICONNECT_MAX_FILENAME_SIZE];
dan_ackme 17:7268f365676b 73 uint32_t size;
dan_ackme 17:7268f365676b 74 FileType type;
dan_ackme 17:7268f365676b 75 FileFlags flags;
dan_ackme 17:7268f365676b 76 uint32_t version;
dan_ackme 17:7268f365676b 77 Wiconnect *wiconnect;
dan_ackme 17:7268f365676b 78 WiconnectFile *next;
dan_ackme 17:7268f365676b 79 WiconnectFile *previous;
dan_ackme 17:7268f365676b 80
dan_ackme 17:7268f365676b 81 Buffer rxBuffer;
dan_ackme 17:7268f365676b 82
dan_ackme 17:7268f365676b 83 void* operator new(size_t size);
dan_ackme 17:7268f365676b 84 void operator delete(void*);
dan_ackme 17:7268f365676b 85
dan_ackme 17:7268f365676b 86 friend class FileInterface;
dan_ackme 17:7268f365676b 87 friend class FileList;
dan_ackme 17:7268f365676b 88 };
dan_ackme 17:7268f365676b 89
dan_ackme 17:7268f365676b 90 }