diff options
Diffstat (limited to 'kopete/protocols/groupwise/libgroupwise/responseprotocol.h')
-rw-r--r-- | kopete/protocols/groupwise/libgroupwise/responseprotocol.h | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/kopete/protocols/groupwise/libgroupwise/responseprotocol.h b/kopete/protocols/groupwise/libgroupwise/responseprotocol.h new file mode 100644 index 00000000..5957ad19 --- /dev/null +++ b/kopete/protocols/groupwise/libgroupwise/responseprotocol.h @@ -0,0 +1,76 @@ +/* + Kopete Groupwise Protocol + responseprotocol.h - Protocol used for reading incoming GroupWise Responses + + Copyright (c) 2004 SUSE Linux AG http://www.suse.com + + Kopete (c) 2002-2004 by the Kopete developers <[email protected]> + + ************************************************************************* + * * + * This library is free software; you can redistribute it and/or * + * modify it under the terms of the GNU Lesser General Public * + * License as published by the Free Software Foundation; either * + * version 2 of the License, or (at your option) any later version. * + * * + ************************************************************************* +*/ + +#ifndef RESPONSEPROTOCOL_H +#define RESPONSEPROTOCOL_H + +#include "gwerror.h" +#include "gwfield.h" + +#include "inputprotocolbase.h" + +/** +Handles the parsing of incoming Response messages + +@author Kopete Developers +*/ +class ResponseProtocol : public InputProtocolBase +{ +Q_OBJECT +public: + /** + * Describes the current state of the protocol + */ + enum State { NeedMore, Available, ServerError, ServerRedirect, ReadingEvent, NoData }; + + /** + * Describes the parsing of the last received packet + */ + enum PacketState { FieldsRead, ProtocolError }; + + ResponseProtocol(QObject* parent, const char* name); + ~ResponseProtocol(); + /** + * Attempt to parse the supplied data into an @ref Response object. + * The exact state of the parse attempt can be read using @ref state. + * @param rawData The unparsed data. + * @param bytes An integer used to return the number of bytes read. + * @return A pointer to an Response object if successfull, otherwise 0. The caller is responsible for deleting this object. + */ + Transfer * parse( const QByteArray &, uint & bytes ); +protected: + /** + * read a line ending in \r\n, including the \r\n + */ + bool readGroupWiseLine( QCString & ); + /** + * Read in a response + */ + bool readResponse(); + /** + * Parse received fields and store in m_collatingFields + */ + bool readFields( int fieldCount, Field::FieldList * list = 0 ); +private: + // fields from a packet being parsed, before it has been completely received + //QValueStack<Field::FieldList> m_collatingFields; + Field::FieldList m_collatingFields; + int m_packetState; // represents the state of the parsing of the last incoming data received +}; + +#endif |