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

api/types/WiconnectFile.h@39:a963f69cb2de, 2015-02-23 (annotated)

Committer:
dan_ackme
Date:
Mon Feb 23 20:30:18 2015 -0800
Revision:
39:a963f69cb2de
Parent:
29:b6af04b77a56 
added httpAcceptWebsocket API

Who changed what in which revision?

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