~ubuntu-branches/ubuntu/lucid/codelite/lucid

#ifndef __clindexerprotocol__

#define __clindexerprotocol__

 

#include "named_pipe.h"

#include "cl_indexer_reply.h"

#include "cl_indexer_request.h"

 

 

class clIndexerProtocol {

 

public:

        clIndexerProtocol();

        ~clIndexerProtocol();

 

        /**

         * @brief send request to the server.

         * @param conn connection to use. The connection should already be connected

         * @param req request to send

         * @return true on success, false otherwise

         */

        static bool SendRequest  (clNamedPipe *conn, clIndexerRequest &req  );

        /**

         * @brief convert reply to binary and send it to the caller using named pipe.

         * @param conn [input] named pipe to use

         * @param reply [input] reply to send

         * @return true on success, false otherwise

         */

        static bool SendReply    (clNamedPipe *conn, clIndexerReply   &reply);

        /**

         * @brief read request from the named pipe. If any error occured, return false and abort the connection

         * @param conn [input] named pipe to use for reading the request

         * @param req [output] holds the received request. Should be used only if this function

         *        returns true

         * @return true on success, false otherwise

         */

        static bool ReadRequest  (clNamedPipe *conn, clIndexerRequest &req  );

        /**

         * @brief read reply from the server.

         * @param conn connection to use

         * @param reply [output]

         * @return true on success, false otherwise

         */

        static bool ReadReply    (clNamedPipe *conn, clIndexerReply   &reply);

 

};

#endif // __clindexerprotocol__