mcl_connectivity_common.h File Reference

Common module interface header file. More...

#include "mcl_core/mcl_assert.h"

Include dependency graph for mcl_connectivity_common.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MCL_CONNECTIVITY_EXPORT
#define	MCL_CONNECTIVITY_CODE_TO_STRING(code)   (code >= MCL_CORE_RETURN_CODE_END) ? mcl_connectivity_return_code_strings[code - MCL_CORE_RETURN_CODE_END] : MCL_CORE_CODE_TO_STRING(code)

Enumerations
enum	E_MCL_CONNECTIVITY_RETURN_CODE { MCL_FILE_CANNOT_BE_OPENED = MCL_CORE_RETURN_CODE_END, MCL_ITEM_EXCEEDS_MAX_HTTP_REQUEST_SIZE, MCL_STORE_IS_EMPTY, MCL_CONNECTIVITY_RETURN_CODE_END }

Variables
MCL_CONNECTIVITY_EXPORT const char *	mcl_connectivity_return_code_strings [MCL_CONNECTIVITY_RETURN_CODE_END-MCL_CORE_RETURN_CODE_END]

Detailed Description

Common module interface header file.

This module contains common type definitions used in various MCL Connectivity modules.

Copyright

Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file mcl_connectivity_common.h.

Macro Definition Documentation

#define MCL_CONNECTIVITY_CODE_TO_STRING

(

code

)

(code >= MCL_CORE_RETURN_CODE_END) ? mcl_connectivity_return_code_strings[code - MCL_CORE_RETURN_CODE_END] : MCL_CORE_CODE_TO_STRING(code)

Definition at line 49 of file mcl_connectivity_common.h.

Referenced by _prepare_body_for_store().

#define MCL_CONNECTIVITY_EXPORT

Definition at line 31 of file mcl_connectivity_common.h.

Enumeration Type Documentation

enum E_MCL_CONNECTIVITY_RETURN_CODE

MCL connectivity return code definitions. Every function returning a status code uses this enum values.

Enumerator
MCL_FILE_CANNOT_BE_OPENED	File can not be opened.
MCL_ITEM_EXCEEDS_MAX_HTTP_REQUEST_SIZE	Item exceeds max http payload request.
MCL_STORE_IS_EMPTY	The store trying to be exchanged has no data inside.
MCL_CONNECTIVITY_RETURN_CODE_END	End of return codes.

Definition at line 38 of file mcl_connectivity_common.h.

Variable Documentation

MCL_CONNECTIVITY_EXPORT const char* mcl_connectivity_return_code_strings[MCL_CONNECTIVITY_RETURN_CODE_END-MCL_CORE_RETURN_CODE_END]

Definition at line 11 of file connectivity_common.c.