GhmMessage.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 
00032 
00033 #include "api/WiconnectTypes.h"
00034 #include "api/StringUtil.h"
00035 
00036 
00037 namespace wiconnect
00038 {
00039 
00040 /**
00041  * @ingroup api_ghm_types
00042  *
00043  * @brief Contains single entry from goHACK.me message listing
00044  *
00045  */
00046 class GhmMessage
00047 {
00048 public:
00049     const char* getMessageId(char *buffer = NULL) const;
00050     const char* getTimestamp(char *buffer = NULL) const;
00051     uint16_t    getLength() const;
00052 
00053     const GhmMessage* getNext() const;
00054     const GhmMessage* getPrevious() const;
00055 
00056 protected:
00057     GhmMessage();
00058 
00059     WiconnectResult init(const char *msgIdStr, const char* timestampStr, const char *lengthStr);
00060     GhmMessage *next;
00061     GhmMessage *previous;
00062     char messageId[37];
00063     char timestamp[14];
00064     uint16_t length;
00065 
00066 #ifdef WICONNECT_ENABLE_MALLOC
00067     void* operator new(size_t size);
00068     void operator delete(void*);
00069 #endif
00070 
00071     friend class GhmMessageList;
00072 };
00073 
00074 
00075 
00076 
00077 
00078 
00079 }