Connectivity processor module header file for connectivity module. More...

#include "mcl_core/mcl_http_client.h"
#include "connectivity_configuration.h"
#include "store.h"
#include "mapping.h"
#include "data_source_configuration.h"

Include dependency graph for connectivity_processor.h:

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

Go to the source code of this file.

Data Structures
struct	connectivity_processor_t

Functions
MCL_LOCAL mcl_error_t	connectivity_processor_initialize (connectivity_configuration_t configuration, connectivity_processor_t *processor)

MCL_LOCAL mcl_error_t	connectivity_processor_exchange (connectivity_processor_t connectivity_processor, mcl_item_t item)

MCL_LOCAL mcl_error_t	connectivity_processor_create_mapping (connectivity_processor_t connectivity_processor, mapping_t mapping)

MCL_LOCAL mcl_error_t	connectivity_processor_get_data_source_configuration (connectivity_processor_t connectivity_processor, data_source_configuration_t *configuration)

MCL_LOCAL void	connectivity_processor_destroy (connectivity_processor_t **processor)

Detailed Description

Connectivity processor module header file for connectivity module.

This module contains the functions for composing the http requests to send to MindSphere endpoints and parse the received http responses.

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

Definition in file connectivity_processor.h.

Function Documentation

MCL_LOCAL mcl_error_t connectivity_processor_create_mapping	(	connectivity_processor_t *	connectivity_processor,
		mapping_t *	mapping
	)

This function creates a data point mapping.

Parameters

[in]	connectivity_processor	Connectivity Processor handle to be used.
[in]	mapping	Mapping handle.

Returns

MCL_OK in case of success.
MCL_OUT_OF_MEMORY if there is not enough memory in the system to proceed.
MCL_COULD_NOT_RESOLVE_PROXY in case the proxy host name can not be resolved.
MCL_COULD_NOT_RESOLVE_HOST in case the remote host name can not be resolved.
MCL_SSL_HANDSHAKE_FAIL in case a problem occurs during SSL handshake.
MCL_COULD_NOT_CONNECT in case there is a connection error.
MCL_SERVER_CERTIFICATE_NOT_VERIFIED in case the server can not be verified.
MCL_IMPROPER_CERTIFICATE in case the certificate provided is in improper format and it can not be parsed.
MCL_NETWORK_SEND_FAIL in case of an error in sending data to network.
MCL_NETWORK_RECEIVE_FAIL in case of an error in receiving data from the network.
MCL_BAD_REQUEST if the server returns HTTP 400 status code.
MCL_UNAUTHORIZED if the server returns HTTP 401 status code.
MCL_FORBIDDEN if the server returns HTTP 403 status code.
MCL_TOO_MANY_REQUESTS if the server returns HTTP 429 status code.
MCL_SERVER_FAIL if the server returns HTTP 500 status code.
MCL_INVALID_PARAMETER in case mapping has one or more missing mandatory parameter.
MCL_FAIL in case of an internal error in MCL.

Definition at line 256 of file connectivity_processor.c.

References _add_authorization_header(), _generate_correlation_id_string(), _prepare_mapping_json(), connectivity_processor_t::access_token, connectivity_processor_t::agent_id, CONTENT_TYPE_APPLICATION_JSON, content_type_values, CORRELATION_ID_BUFFER_LENGTH, connectivity_processor_t::http_client, connectivity_processor_t::mapping_url, mapping_validate(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_ERROR, MCL_FREE, mcl_http_client_send(), MCL_HTTP_POST, mcl_http_request_add_header(), mcl_http_request_destroy(), mcl_http_request_initialize(), MCL_HTTP_REQUEST_PARAMETER_BODY, MCL_HTTP_REQUEST_PARAMETER_BODY_SIZE, MCL_HTTP_REQUEST_PARAMETER_METHOD, MCL_HTTP_REQUEST_PARAMETER_URL, mcl_http_request_set_parameter(), mcl_http_response_destroy(), mcl_http_response_get_status(), MCL_HTTP_STATUS_CODE_CREATED, MCL_INFO, MCL_NULL, MCL_OK, mcl_string_util_strlen(), MCL_UNEXPECTED_RESULT_CODE, mcl_http_response_t::payload, mcl_http_response_t::payload_size, and mcl_http_response_t::status_code.

Referenced by mcl_connectivity_create_mapping().

Here is the call graph for this function:

Here is the caller graph for this function:

MCL_LOCAL void connectivity_processor_destroy ( connectivity_processor_t ** processor )

This function destroys connectivity processor data structure.

Parameters

[in] processor Connectivity processor handle to be destroyed.

MCL_LOCAL mcl_error_t connectivity_processor_exchange	(	connectivity_processor_t *	connectivity_processor,
		mcl_item_t *	item
	)

This function exchanges data with MindSphere.

Parameters

[in]	connectivity_processor	Connectivity Processor handle to be used.
[in]	item	Data to be exchanged.

Returns

MCL_OK in case of success.
MCL_OUT_OF_MEMORY if there is not enough memory in the system to proceed.
MCL_STORE_IS_EMPTY if store has no data.
MCL_COULD_NOT_RESOLVE_PROXY in case the proxy host name can not be resolved.
MCL_COULD_NOT_RESOLVE_HOST in case the remote host name can not be resolved.
MCL_SSL_HANDSHAKE_FAIL in case a problem occurs during SSL handshake.
MCL_COULD_NOT_CONNECT in case there is a connection error.
MCL_SERVER_CERTIFICATE_NOT_VERIFIED in case the server can not be verified.
MCL_IMPROPER_CERTIFICATE in case the certificate provided is in improper format and it can not be parsed.
MCL_NETWORK_SEND_FAIL in case of an error in sending data to network.
MCL_NETWORK_RECEIVE_FAIL in case of an error in receiving data from the network.
MCL_BAD_REQUEST if the server returns HTTP 400 status code.
MCL_UNAUTHORIZED if the server returns HTTP 401 status code.
MCL_FORBIDDEN if the server returns HTTP 403 status code.
MCL_REQUEST_PAYLOAD_TOO_LARGE if the server returns HTTP 413 status code.
MCL_TOO_MANY_REQUESTS if the server returns HTTP 429 status code.
MCL_SERVER_FAIL if the server returns HTTP 500 status code.
MCL_INVALID_PARAMETER in case item has one or more missing mandatory parameter.
MCL_FAIL in case of an internal error in MCL.

Definition at line 111 of file connectivity_processor.c.

References _add_http_headers_for_exchange(), _check_store_size(), _evaluate_response_for_exchange(), _generate_correlation_id_string(), _prepare_body(), _scan_store_after_exchange(), CORRELATION_ID_BUFFER_LENGTH, custom_data_validate(), data_source_configuration_validate(), event_validate(), connectivity_processor_t::exchange_url, file_validate(), connectivity_processor_t::http_client, connectivity_processor_t::max_http_payload_size, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FAIL, MCL_FALSE, MCL_FREE, mcl_http_client_send(), MCL_HTTP_POST, mcl_http_request_add_header(), mcl_http_request_destroy(), mcl_http_request_initialize(), MCL_HTTP_REQUEST_PARAMETER_BODY, MCL_HTTP_REQUEST_PARAMETER_BODY_SIZE, MCL_HTTP_REQUEST_PARAMETER_METHOD, MCL_HTTP_REQUEST_PARAMETER_URL, mcl_http_request_set_parameter(), mcl_http_response_destroy(), MCL_INVALID_PARAMETER, MCL_ITEM_PREAMBLE, MCL_ITEM_TYPE_CUSTOM_DATA, MCL_ITEM_TYPE_DATA_SOURCE_CONFIGURATION, MCL_ITEM_TYPE_EVENT, MCL_ITEM_TYPE_FILE, MCL_ITEM_TYPE_STORE, MCL_ITEM_TYPE_TIMESERIES, MCL_NULL, MCL_OK, MCL_TRUE, multipart_generate_boundary(), and timeseries_validate().

Referenced by mcl_connectivity_exchange().

Here is the call graph for this function:

Here is the caller graph for this function:

MCL_LOCAL mcl_error_t connectivity_processor_get_data_source_configuration	(	connectivity_processor_t *	connectivity_processor,
		data_source_configuration_t **	configuration
	)

This function gets data source configuration.

Parameters

[in]	connectivity_processor	Connectivity Processor handle to be used.
[out]	configuration	Data source configuration.

Returns

MCL_OK in case of success.
MCL_OUT_OF_MEMORY if there is not enough memory in the system to proceed.
MCL_COULD_NOT_RESOLVE_PROXY in case the proxy host name can not be resolved.
MCL_COULD_NOT_RESOLVE_HOST in case the remote host name can not be resolved.
MCL_SSL_HANDSHAKE_FAIL in case a problem occurs during SSL handshake.
MCL_COULD_NOT_CONNECT in case there is a connection error.
MCL_SERVER_CERTIFICATE_NOT_VERIFIED in case the server can not be verified.
MCL_IMPROPER_CERTIFICATE in case the certificate provided is in improper format and it can not be parsed.
MCL_NETWORK_SEND_FAIL in case of an error in sending data to network.
MCL_NETWORK_RECEIVE_FAIL in case of an error in receiving data from the network.
MCL_BAD_REQUEST if the server returns HTTP 400 status code.
MCL_UNAUTHORIZED if the server returns HTTP 401 status code.
MCL_FORBIDDEN if the server returns HTTP 403 status code.
MCL_TOO_MANY_REQUESTS if the server returns HTTP 429 status code.
MCL_SERVER_FAIL if the server returns HTTP 500 status code.
MCL_INVALID_PARAMETER in case mapping has one or more missing mandatory parameter.
MCL_FAIL in case of an internal error in MCL.

Definition at line 371 of file connectivity_processor.c.

References _add_authorization_header(), connectivity_processor_t::access_token, connectivity_processor_t::agent_id, CONTENT_TYPE_APPLICATION_JSON, content_type_values, connectivity_processor_t::hostname, connectivity_processor_t::http_client, json_parse_item(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, mcl_http_client_send(), MCL_HTTP_GET, mcl_http_request_add_header(), mcl_http_request_destroy(), mcl_http_request_initialize(), MCL_HTTP_REQUEST_PARAMETER_METHOD, MCL_HTTP_REQUEST_PARAMETER_URL, mcl_http_request_set_parameter(), mcl_http_response_destroy(), mcl_http_response_get_status(), MCL_HTTP_STATUS_CODE_SUCCESS, MCL_MALLOC, MCL_NULL, MCL_NULL_CHAR_SIZE, MCL_OK, MCL_OUT_OF_MEMORY, mcl_string_util_memcpy(), mcl_string_util_strlen(), mcl_http_response_t::payload, mcl_http_response_t::payload_size, and mcl_http_response_t::status_code.

Referenced by mcl_connectivity_get_data_source_configuration().

Here is the call graph for this function:

Here is the caller graph for this function:

MCL_LOCAL mcl_error_t connectivity_processor_initialize	(	connectivity_configuration_t *	configuration,
		connectivity_processor_t **	processor
	)

This function creates and initializes a data struct of connectivity_processor_t.

Parameters

[in]	configuration	The configuration parameters.
[out]	processor	The newly initialized connectivity processor.

Returns

MCL_OK in case of success.
MCL_OUT_OF_MEMORY if there is not enough memory in the system to proceed.

Data Structures

Functions

Detailed Description

Function Documentation