/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
#ifndef plBufferedSocketReader_h_inc
#define plBufferedSocketReader_h_inc

#include "plRingBuffer.h"

class plTcpSocket;


class plBufferedSocketReader : protected plRingBuffer
{
public:
    enum ReadResult
    {
        kSuccessNoData          = 0,
        kSuccessWithData        = 1,
        kFailedReadError        =-1,
        kFailedSocketClosed     =-2,
        kFailedNoBufferSpace    =-3,
    };

public:
    plBufferedSocketReader(int size=8192);
    int ReadBlock(char * buf, int buflen, plTcpSocket & sck);
    int ReadString(char * buf, int buflen, char * termChars, plTcpSocket & sck);
    int ReadStringInPlace(char ** buf, char * termChars, plTcpSocket & sck);
    void Reset(); 

protected:
    int ReadFrom(plTcpSocket & sck);
    bool GetBlock(char * buf, int buflen);
    bool GetString(char * buf, int buflen, char * termChars);
    bool GetStringInPlace(char ** buf, char * termChars);
};


#endif // plBufferedSocketReader_h_inc