Sirikata
libcore/plugins/tcpsst/ASIOReadBuffer.hpp
Go to the documentation of this file.
00001 /*  Sirikata Network Utilities
00002  *  ASIOReadBuffer.hpp
00003  *
00004  *  Copyright (c) 2009, 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 #include "MultiplexedSocket.hpp"
00034 #include <sirikata/core/network/IOStrand.hpp>
00035 
00036 namespace Sirikata {
00037 namespace Network {
00038 class ASIOReadBuffer;
00039 struct ASIOReadBufferUtil;
00045 ASIOReadBuffer* MakeASIOReadBuffer(const MultiplexedSocketPtr &parentSocket,unsigned int whichSocket, const MemoryReference &strayBytesAfterHeader, TCPStream::StreamType streamType);
00046 class ASIOReadBuffer {
00047     friend ASIOReadBuffer* MakeASIOReadBuffer(const MultiplexedSocketPtr &parentSocket,unsigned int whichSocket, const MemoryReference &strayBytesAfterHeader, TCPStream::StreamType streamType);
00048 public:
00049     enum {
00053         sBufferLength=64*1024,
00059         sLowWaterMark=sBufferLength
00060     };
00061 private:
00062     friend struct ASIOReadBufferUtil;
00063     enum ReceivedResponse {
00064         StreamNotPaused,
00065         PausedStream
00066     };
00067     enum ReadStatus{
00068         PAUSED_FIXED_BUFFER=0x0,
00069         READING_FIXED_BUFFER=0x1,
00070         PAUSED_NEW_CHUNK=0x2,
00071         READING_NEW_CHUNK=0x3,
00072     }mReadStatus;
00074     uint8 mBuffer[sBufferLength];
00076     unsigned int mFixedBufferPos;
00077     unsigned int mChunkBufferPos;
00079     std::vector<uint8> mPartialStreamId;
00080     bool mFirstFrame; 
00081     bool mLastFrame; 
00082 
00084     unsigned int mWhichBuffer;
00086     Chunk mNewChunk;
00087     Chunk *mCachedRejectedChunk;
00089     Stream::StreamID mNewChunkID;
00091     uint8 mDataMask[4];
00093     TCPStream::StreamType mStreamType;
00095     std::tr1::weak_ptr<MultiplexedSocket> mParentSocket;
00096     typedef boost::system::error_code ErrorCode;
00097     std::tr1::function<void(const ErrorCode&,std::size_t)> mAsioReadIntoFixedBuffer;
00098     std::tr1::function<void(const ErrorCode&,std::size_t)> mAsioReadIntoChunk;
00099 
00100     void bindFunctions(IOStrand* strand);
00105     void processError(MultiplexedSocket*parentSocket, const ErrorCode &error);
00116     ReceivedResponse processFullChunk(const MultiplexedSocketPtr &parentSocket,
00117         unsigned int whichSocket,
00118         const Stream::StreamID& sid,
00119         Chunk&newChunk,
00120         const Stream::PauseReceiveCallback& pauseReceive);
00121 
00127     void readIntoFixedBuffer(const MultiplexedSocketPtr &parentSocket);
00132     void readIntoChunk(const MultiplexedSocketPtr &parentSocket);
00133 
00143     void processPartialChunk(uint8* dataBuffer, uint32 packetLength, uint32 &bufferReceived, Chunk&retval);
00144 
00151     void translateFixedBuffer(const MultiplexedSocketPtr &thus);
00152 
00160     void asioReadIntoChunk(const ErrorCode&error,std::size_t bytes_read);
00161 
00167     void asioReadIntoFixedBuffer(const ErrorCode&error,std::size_t bytes_read);
00168 
00169     ASIOReadBuffer(const MultiplexedSocketPtr &parentSocket,unsigned int whichSocket, TCPStream::StreamType streamType);
00171     ASIOReadBuffer(const ASIOReadBuffer&);
00172 public:
00179     void ioReactorThreadResumeRead(MultiplexedSocketPtr&thus);
00180     ~ASIOReadBuffer();
00181 };
00182 
00183 
00184 
00185 } // namespace Network
00186 } // namespace Sirikata