51Degrees Common C/C++  4.1

A shared functionality library that is used by 51Degrees products
Search

status.h

1 /* *********************************************************************
2  * This Source Code Form is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
4  * Caversham, Reading, Berkshire, United Kingdom RG4 7BY
5  *
6  * This Source Code Form is subject to the terms of the Mozilla Public
7  * License, v. 2.0.
8  *
9  * If a copy of the MPL was not distributed with this file, You can obtain
10  * one at http://mozilla.org/MPL/2.0/.
11  *
12  * This Source Code Form is "Incompatible With Secondary Licenses", as
13  * defined by the Mozilla Public License, v. 2.0.
14  * ********************************************************************* */
15 
16 #ifndef FIFTYONE_DEGREES_INIT_H_INCLUDED
17 #define FIFTYONE_DEGREES_INIT_H_INCLUDED
18 
64 #include <stdint.h>
65 #include <string.h>
66 #include <stdio.h>
67 
68 #ifdef __cplusplus
69 #define EXTERNAL extern "C"
70 #else
71 #define EXTERNAL
72 #endif
73 
75 typedef enum e_fiftyone_degrees_status_code {
76  FIFTYONE_DEGREES_STATUS_SUCCESS,
77  FIFTYONE_DEGREES_STATUS_INSUFFICIENT_MEMORY,
78  FIFTYONE_DEGREES_STATUS_CORRUPT_DATA,
79  FIFTYONE_DEGREES_STATUS_INCORRECT_VERSION,
81  FIFTYONE_DEGREES_STATUS_FILE_NOT_FOUND,
83  FIFTYONE_DEGREES_STATUS_FILE_BUSY,
84  FIFTYONE_DEGREES_STATUS_FILE_FAILURE,
85  FIFTYONE_DEGREES_STATUS_NOT_SET,
87  FIFTYONE_DEGREES_STATUS_POINTER_OUT_OF_BOUNDS,
90  FIFTYONE_DEGREES_STATUS_NULL_POINTER,
91  FIFTYONE_DEGREES_STATUS_TOO_MANY_OPEN_FILES,
92  FIFTYONE_DEGREES_STATUS_REQ_PROP_NOT_PRESENT,
94  FIFTYONE_DEGREES_STATUS_PROFILE_EMPTY,
96  FIFTYONE_DEGREES_STATUS_COLLECTION_FAILURE,
100  FIFTYONE_DEGREES_STATUS_FILE_COPY_ERROR,
102  FIFTYONE_DEGREES_STATUS_FILE_WRITE_ERROR,
104  FIFTYONE_DEGREES_STATUS_FILE_PERMISSION_DENIED,
105  FIFTYONE_DEGREES_STATUS_FILE_PATH_TOO_LONG,
108  FIFTYONE_DEGREES_STATUS_ENCODING_ERROR,
110  FIFTYONE_DEGREES_STATUS_INVALID_COLLECTION_CONFIG,
115  FIFTYONE_DEGREES_STATUS_INVALID_CONFIG,
116  FIFTYONE_DEGREES_STATUS_INSUFFICIENT_HANDLES,
120  FIFTYONE_DEGREES_STATUS_COLLECTION_INDEX_OUT_OF_RANGE,
122  FIFTYONE_DEGREES_STATUS_COLLECTION_OFFSET_OUT_OF_RANGE,
124  FIFTYONE_DEGREES_STATUS_COLLECTION_FILE_SEEK_FAIL,
125  FIFTYONE_DEGREES_STATUS_COLLECTION_FILE_READ_FAIL
126 } fiftyoneDegreesStatusCode;
127 
137 EXTERNAL const char* fiftyoneDegreesStatusGetMessage(
138  fiftyoneDegreesStatusCode status,
139  const char *fileName);
140 
145 #endif
FIFTYONE_DEGREES_STATUS_FILE_FAILURE
Unknown file error.
Definition: status.h:84
FIFTYONE_DEGREES_STATUS_CORRUPT_DATA
Data structure not readable.
Definition: status.h:78
FIFTYONE_DEGREES_STATUS_FILE_WRITE_ERROR
The data file could not be created.
Definition: status.h:102
FIFTYONE_DEGREES_STATUS_FILE_PERMISSION_DENIED
File permission denied.
Definition: status.h:104
FIFTYONE_DEGREES_STATUS_INVALID_COLLECTION_CONFIG
The configuration provided to create a collection could not be used to create a valid collection.
Definition: status.h:110
fiftyoneDegreesStatusCode
fiftyoneDegreesStatusCode
Status returned from the initialisation of a resource.
Definition: status.h:75
FIFTYONE_DEGREES_STATUS_REQ_PROP_NOT_PRESENT
None of the required properties could be found.
Definition: status.h:92
FIFTYONE_DEGREES_STATUS_COLLECTION_OFFSET_OUT_OF_RANGE
Offset out of range.
Definition: status.h:122
FIFTYONE_DEGREES_STATUS_INSUFFICIENT_HANDLES
There were not enough handles available to retrieve data from the source.
Definition: status.h:116
FIFTYONE_DEGREES_STATUS_POINTER_OUT_OF_BOUNDS
Working pointer exceeded the amount of memory containing the data.
Definition: status.h:87
FIFTYONE_DEGREES_STATUS_COLLECTION_INDEX_OUT_OF_RANGE
Index out of range.
Definition: status.h:120
FIFTYONE_DEGREES_STATUS_COLLECTION_FILE_READ_FAIL
Read failure.
Definition: status.h:125
FIFTYONE_DEGREES_STATUS_INSUFFICIENT_MEMORY
Lack of memory.
Definition: status.h:77
FIFTYONE_DEGREES_STATUS_FILE_BUSY
The data file was busy.
Definition: status.h:83
FIFTYONE_DEGREES_STATUS_NOT_SET
Should never be returned to the caller.
Definition: status.h:85
FIFTYONE_DEGREES_STATUS_INCORRECT_VERSION
Data not the required version.
Definition: status.h:79
FIFTYONE_DEGREES_STATUS_PROFILE_EMPTY
The profile id represents an empty profile.
Definition: status.h:94
FIFTYONE_DEGREES_STATUS_FILE_PATH_TOO_LONG
The file path is longer than the available memory available to store it.
Definition: status.h:105
FIFTYONE_DEGREES_STATUS_COLLECTION_FILE_SEEK_FAIL
Seek failure.
Definition: status.h:124
FIFTYONE_DEGREES_STATUS_FILE_NOT_FOUND
The data file couldn't be found.
Definition: status.h:81
FIFTYONE_DEGREES_STATUS_COLLECTION_FAILURE
There was an error getting an item from a collection due to too many concurrent operations.
Definition: status.h:96
FIFTYONE_DEGREES_STATUS_INVALID_CONFIG
An invalid config was provided.
Definition: status.h:115
FIFTYONE_DEGREES_STATUS_NULL_POINTER
A key pointer was not set.
Definition: status.h:90
FIFTYONE_DEGREES_STATUS_SUCCESS
All okay.
Definition: status.h:76
FIFTYONE_DEGREES_STATUS_TOO_MANY_OPEN_FILES
Too many files are open.
Definition: status.h:91
fiftyoneDegreesStatusGetMessage
EXTERNAL const char * fiftyoneDegreesStatusGetMessage(fiftyoneDegreesStatusCode status, const char *fileName)
Returns an English error message for the status code allocating memory needed to store the message.
Definition: status.c:99
FIFTYONE_DEGREES_STATUS_ENCODING_ERROR
There was an error encoding characters of a string.
Definition: status.h:108
FIFTYONE_DEGREES_STATUS_FILE_COPY_ERROR
The data file could not be copied.
Definition: status.h:100

Generated by doxygen 1.8.15