pt_api_error_codes.h

Go to the documentation of this file.

/*
 * ----------------------------------------------------------------------------
 * Copyright 2018 ARM Ltd.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ----------------------------------------------------------------------------
 */

#ifndef PT_API_ERROR_CODES_H_
#define PT_API_ERROR_CODES_H_

typedef enum {

    /*
     * Generic error codes
     */

    PT_API_SUCCESS = 0,

    PT_API_UNKNOWN_ERROR = -1,

    /*
     * Error codes related to server state
     */

    PT_API_INTERNAL_ERROR = -30000,

    PT_API_PROTOCOL_TRANSLATOR_NOT_REGISTERED = -30001,

    PT_API_PROTOCOL_TRANSLATOR_ALREADY_REGISTERED = -30002,

    PT_API_PROTOCOL_TRANSLATOR_NAME_RESERVED = -30003,

    PT_API_REGISTERED_ENDPOINT_LIMIT_REACHED = -30004,

    PT_API_ENDPOINT_ALREADY_REGISTERED = -30005,

    PT_API_EDGE_CORE_SHUTTING_DOWN = -30006,

    PT_API_REQUEST_TIMEOUT = -30007,

    PT_API_REMOTE_DISCONNECTED = -30008,

    /*
     * Error codes related to client state.
     */

    PT_API_PROTOCOL_TRANSLATOR_CLIENT_WRITE_ERROR = -30100,

    PT_API_ILLEGAL_VALUE = -30101,

    PT_API_RESOURCE_NOT_FOUND = -30102,

    PT_API_INVALID_JSON_STRUCTURE = -30103,

    PT_API_RESOURCE_NOT_READABLE = -30104,

    PT_API_RESOURCE_NOT_WRITABLE = -30105,

    PT_API_WRITE_TO_PROTOCOL_TRANSLATOR_FAILED = -30106,

    PT_API_CERTIFICATE_RENEWAL_BUSY = -30107,

    PT_API_CERTIFICATE_RENEWAL_ERROR = -30108,

    PT_API_CERTIFICATE_RENEWAL_INVALID_PARAMETERS = -30109,

    PT_API_CERTIFICATE_RENEWAL_MEMORY_ALLOCATION_FAILURE = -30110

} pt_api_result_code_e;

const char *pt_api_get_error_message(pt_api_result_code_e code);

#endif /* PT_API_ERROR_CODES_H_ */