GhmMessageList.h

00001 /**
00002  * ACKme WiConnect Host Library is licensed under the BSD licence: 
00003  * 
00004  * Copyright (c)2014 ACKme Networks.
00005  * All rights reserved. 
00006  * 
00007  * Redistribution and use in source and binary forms, with or without modification, 
00008  * are permitted provided that the following conditions are met: 
00009  * 
00010  * 1. Redistributions of source code must retain the above copyright notice, 
00011  * this list of conditions and the following disclaimer. 
00012  * 2. Redistributions in binary form must reproduce the above copyright notice, 
00013  * this list of conditions and the following disclaimer in the documentation 
00014  * and/or other materials provided with the distribution. 
00015  * 3. The name of the author may not be used to endorse or promote products 
00016  * derived from this software without specific prior written permission. 
00017  * 
00018  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED 
00019  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00020  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00021  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00022  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00023  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00026  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00027  * OF SUCH DAMAGE.
00028  */
00029 #pragma once
00030 
00031 #include "api/WiconnectTypes.h"
00032 #include "GhmMessage.h"
00033 
00034 
00035 
00036 namespace wiconnect
00037 {
00038 
00039 
00040 /**
00041  * @ingroup api_ghm_types
00042  *
00043  * @brief List of goHACK.me messages.
00044  *
00045  */
00046 class GhmMessageList
00047 {
00048 public:
00049     GhmMessageList(int bufferLen = 0, void *buffer = NULL);
00050     ~GhmMessageList();
00051 
00052     void reset(void);
00053     const GhmMessage* getListHead() const;
00054     int getCount() const;
00055     const GhmMessage* getResult(int i) const;
00056     const GhmMessage* operator [](int i) const;
00057 
00058 protected:
00059     GhmMessage *listHead, *listTail;
00060     uint8_t *buffer;
00061     uint8_t *bufferPtr;
00062     uint16_t bufferLen;
00063     uint16_t bufferRemaining;
00064     int count;
00065 
00066     WiconnectResult add(const char *msgId, const char* timestamp, const char *length);
00067 
00068 
00069     friend class GhmInterface;
00070 };
00071 
00072 
00073 }