protocol.h

/*
    Copyright (c) 2014 by Elvis Angelaccio

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
*/

#ifndef PROTOCOL_H
#define PROTOCOL_H

#include <string>
#include <stdexcept>

namespace net
{   

    typedef enum 
    {
        UNSPECIFIED_COMMAND, 
        INSERT, 
        REMOVE, 
        GET, 
        SEARCH, 
        SPECLIST
        
    } Command;

    typedef enum 
    {
        OK, 
        WRONG_AUTH, 
        INCOMPLETE_SET, 
        NO_SUCH_SPEC, 
        TOO_MUCH_DATA,
        NO_SUCH_SET, 
        WRONG_TYPE,
        UNKNOWN_NAME,
        UNKNOWN_FIELD,
        GENERIC_ERROR=99,
        UNSPECIFIED_CODE
        
    } ResponseCode;


    /* Commands strings */
    const std::string INSERT_CMD = "INSERT";
    const std::string REMOVE_CMD = "REMOVE";
    const std::string GET_CMD = "GET";
    const std::string SEARCH_CMD = "SEARCH";
    const std::string SPECLIST_CMD = "SPECLIST";
    
    /* Return codes strings */
    const std::string OK_CODE =  "0";
    const std::string WRONG_AUTH_CODE = "1";
    const std::string INCOMPLETE_SET_CODE = "2";
    const std::string NO_SUCH_SPEC_CODE = "3";
    const std::string TOO_MUCH_DATA_CODE = "4";
    const std::string NO_SUCH_SET_CODE = "5";
    const std::string WRONG_TYPE_CODE = "6";
    const std::string UNKNOWN_NAME_CODE = "7";
    const std::string UNKNOWN_FIELD_CODE = "8";
    const std::string GENERIC_ERROR_CODE = "99";
        
    /* Return codes messages */
    const std::string OK_MSG =  "OK";
    const std::string WRONG_AUTH_MSG = "Wrong authentication";
    const std::string INCOMPLETE_SET_MSG = "Incomplete set";
    const std::string NO_SUCH_SPEC_MSG = "No such specifier";
    const std::string TOO_MUCH_DATA_MSG = "Too much data";
    const std::string NO_SUCH_SET_MSG = "No such set";
    const std::string WRONG_TYPE_MSG = "Wrong type";
    const std::string UNKNOWN_NAME_MSG = "Unknown name";
    const std::string UNKNOWN_FIELD_MSG = "Unknown field";
    const std::string GENERIC_ERROR_MSG = "Generic error";  
    
    /* Syntax strings */
    
    const std::string FILE_ACK = "ACK";     
    const std::string DSS_MARKER = "DSS";
    const std::string SD_MARKER = "SD";
    const std::string DI_MARKER = "DI";
    const std::string DIFILES_MARKER = "DIFILES";
    const std::string FOUND_MARKER = "FOUND";

    const std::string SN_SPECIAL_KEY = "SequenceNumber"; 
    class ProtocolSyntaxError : public std::runtime_error
    {
        public:
            ProtocolSyntaxError(const std::string& msg) : std::runtime_error(msg) {}
    };
}


#endif