y_vts.c

Go to the documentation of this file.

/*
 * Ylib Loadrunner function library.
 * Copyright (C) 2009-2010 Raymond de Jongh <ferretproof@gmail.com> | <rdjongh@ymor.nl>
 * Copyright (C) 2010,2014 Floris Kraak <randakar@gmail.com> | <fkraak@ymor.nl>
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */ 

#ifndef _Y_VTS_FUNC_C_
#define _Y_VTS_FUNC_C_

/* \brief Standardised error reporting for all VTS functions.

\author Floris Kraak
*/
void y_vts_report_error(char* message)
{
    lr_error_message("****** VTS ERROR: %s", message);
}

int y_vts_process_returncode(int returncode)
{
    char* errortext;
    
    // Encode the above information in a simple lookup table.
    switch(returncode)
    {
        case VTCERR_OK:
            //errortext = "INFO: VTS command succeeded.";
            //lr_log_message(errortext);
            return returncode;
            break; // <-- never reached, but kept for readability.

        case VTCERR_INVALID_CONNECTION_INFO:
            errortext = "The corresponding handle does not exist or the connection information is corrupted. Disconnect and reconnect.";
            break;

        case VTCERR_FAILED_TO_RESOLVE_ADDR:
            errortext = "Failed to resolve server address.";
            break;

        case VTCERR_FAILED_TO_CREATE_SOCKET:
            errortext = "Failed to create socket.";
            break;

        case VTCERR_FAILED_TO_CONNECT:
            errortext = "Failed to connect. Check the server name, port number, network connectivity, and whether server is on line."; // LR 11.52 simply calls lr_abort() if this happens.
            break;
            
        case VTCERR_INVALID_API_CALL: 
            errortext = "Failed to get the API entry.";
            break;

        case VTCERR_INCOMPLETE_REQUEST:
            errortext = "Communications packet from client is invalid.";
            break;

        case VTCERR_FAILED_TO_RECV_RESPONSE:
            errortext = "No response received from server.";
            break;

        case VTCERR_INCOMPLETE_RESPONSE:
            errortext = "Response from server is incomplete.";
            break;

        case VTCERR_RESPONSE_ARGS_UNMATCH:
            errortext = "Unexpected count of arguments in server response.";
            break;

        case VTCERR_INVALID_ARGUMENT:
            errortext = "Invalid argument.";
            break;

        case VTCERR_HANDLE_NOT_EXIST:
            errortext = "Connection handle does not exist.";
            break;

        case VTCERR_INNER_JSON_CONVERT:
            errortext = "Cannot parse server (JSON) response.";
            break;

        case VTCERR_INNER_UTF8_CONVERT:
            errortext = "Cannot convert between UTF8 and Locale.";
            break;

        case VTCERR_COL_FORMAT_ERROR:
            errortext = "Invalid or empty column name.";
            break;

        case VTCERR_COL_VALUE_NO_MATCH:
            errortext = "Column names list and messages list do not have the same number of values. Check delimiters.";
            break;

        case VTCERR_EVAL_STRING:
            errortext = "Error evaluating parameter value.";
            break;

        case VTCERR_DATA_NOT_EXIST:
            errortext = "There is no data at the specified column and row.";
            break;

        // These operation base errors may not exist in LR 11.52. The documentation no longer mentions them.            
        case VTCERR_OPERATION_ERROR_BASE:
            errortext = "Received error code VTCERR_OPERATION_ERROR_BASE.";
            break;

        case VTCERR_SERVER_IS_BUSY:
            errortext = "Server is busy. Go away.";
            break;

        case VTCERR_CLIENT_REQUEST_ERROR:
            errortext = "Client request error.";
            break;

        default:
            errortext = "Unknown VTC error code.";
            break;
    }

    // Report the error to the user. (The "All OK" case jumped out of this function earlier ..)
    y_vts_report_error(errortext);
    // At this point it might be an idea to call lr_abort() or lr_exit(LR_EXIT_VUSER, LR_FAIL)
    
    return returncode;
}

// --------------------------------------------------------------------------------------------------
#endif // _Y_VTS_FUNC_C_