Sirikata
space/src/NetworkQueueWrapper.hpp
Go to the documentation of this file.
00001 /*  Sirikata
00002  *  NetworkQueueWrapper.hpp
00003  *
00004  *  Copyright (c) 2010, Daniel Reiter Horn
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions are
00009  *  met:
00010  *  * Redistributions of source code must retain the above copyright
00011  *    notice, this list of conditions and the following disclaimer.
00012  *  * Redistributions in binary form must reproduce the above copyright
00013  *    notice, this list of conditions and the following disclaimer in
00014  *    the documentation and/or other materials provided with the
00015  *    distribution.
00016  *  * Neither the name of Sirikata nor the names of its contributors may
00017  *    be used to endorse or promote products derived from this software
00018  *    without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00021  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00022  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00023  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00024  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00026  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031  */
00032 
00033 #ifndef _NETWORK_QUEUE_WRAPPER
00034 #define _NETWORK_QUEUE_WRAPPER
00035 
00036 #include <sirikata/space/SpaceNetwork.hpp>
00037 #include <sirikata/space/ServerMessage.hpp>
00038 #include <sirikata/core/trace/Trace.hpp>
00039 
00040 namespace Sirikata {
00041 class NetworkQueueWrapper {
00042     Context* mContext;
00043     SpaceNetwork::ReceiveStream* mReceiveStream;
00044     Message* mFront;
00045     Trace::MessagePath mPathTag;
00046     typedef Network::Chunk Chunk;
00047 
00048     Message* parse(Chunk* c) {
00049         Message* msg = Message::deserialize(*c);
00050 
00051         if (msg == NULL) {
00052             // FIXME if this happens we're probably going to never remove the chunk from the network...
00053             SILOG(net,warning,"Couldn't parse message.");
00054             return NULL;
00055         }
00056 
00057         if (msg->source_server() != mReceiveStream->id()) {
00058             // FIXME if this happens we're probably going to never remove the chunk from the network...
00059             SILOG(net,warning,"Message source doesn't match connection's ID");
00060             delete msg;
00061             return NULL;
00062         }
00063 
00064         TIMESTAMP_PAYLOAD(msg, mPathTag);
00065 
00066         return msg;
00067     }
00068 public:
00069     typedef Message* ElementType;
00070 
00071     NetworkQueueWrapper(Context* ctx, SpaceNetwork::ReceiveStream* rstrm, Trace::MessagePath tag)
00072      : mContext(ctx),
00073        mReceiveStream(rstrm),
00074        mFront(NULL),
00075        mPathTag(tag)
00076     {}
00077 
00078     ~NetworkQueueWrapper(){}
00079 
00080     QueueEnum::PushResult push(const Message *msg){
00081         return QueueEnum::PushExceededMaximumSize;
00082     }
00083 
00084     Message* front() {
00085         if (mFront == NULL) {
00086             Chunk* c = mReceiveStream->front();
00087             if (c != NULL)
00088                 mFront = parse(c);
00089         }
00090 
00091         return mFront;
00092     }
00093 
00094     Message* pop(){
00095         Chunk* c = mReceiveStream->pop();
00096 
00097         if (c == NULL) {
00098             assert(mFront == NULL);
00099             return NULL;
00100         }
00101 
00102         Message* result = NULL;
00103         if (mFront != NULL) {
00104             result = mFront;
00105             mFront = NULL;
00106         }
00107         else {
00108             result = parse(c);
00109         }
00110 
00111         delete c;
00112         return result;
00113     }
00114 
00115     bool empty() const {
00116         return mFront == NULL && mReceiveStream->front() == NULL;
00117     }
00118 };
00119 }
00120 
00121 #endif