MCL Connectivity interface header file. More...

#include "mcl_core/mcl_core.h"
#include "mcl_connectivity/mcl_store.h"
#include "mcl_connectivity/mcl_event.h"
#include "mcl_connectivity/mcl_data_source_configuration.h"
#include "mcl_connectivity/mcl_timeseries.h"
#include "mcl_connectivity/mcl_file.h"
#include "mcl_connectivity/mcl_custom_data.h"
#include "mcl_connectivity/mcl_connectivity_configuration.h"
#include "mcl_connectivity/mcl_mapping.h"

Include dependency graph for mcl_connectivity.h:

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

Go to the source code of this file.

Typedefs
typedef struct mcl_connectivity_t	mcl_connectivity_t

Functions
MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_connectivity_initialize (mcl_connectivity_configuration_t configuration, mcl_connectivity_t *connectivity)

MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_connectivity_exchange (mcl_connectivity_t connectivity, void item)

MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_connectivity_create_mapping (mcl_connectivity_t connectivity, mcl_mapping_t mapping)

MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_connectivity_get_data_source_configuration (mcl_connectivity_t connectivity, mcl_data_source_configuration_t *configuration)

MCL_CONNECTIVITY_EXPORT void	mcl_connectivity_destroy (mcl_connectivity_t **connectivity)

Detailed Description

MCL Connectivity interface header file.

This module presents MindConnect Library Connectivity capabilities.

Make sure MCL_CONNECTIVITY build option is set to ON when building MCL.

Agents have to initialize an instance of MCL connectivity component using mcl_connectivity_initialize function to exploit connectivity component features.

Data can be uploaded to MindSphere using mcl_connectivity_exchange function.

Agents can create mappings between their data points defined in their data source configuration and assets using mcl_connectivity_create_mapping function.

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

Definition in file mcl_connectivity.h.

Typedef Documentation

typedef struct mcl_connectivity_t mcl_connectivity_t

This is the main handle for connectivity component.

Definition at line 42 of file mcl_connectivity.h.

Function Documentation

MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_connectivity_create_mapping	(	mcl_connectivity_t *	connectivity,
		mcl_mapping_t *	mapping
	)

This function creates a data point mapping. connectivity has to be initialized before using this function.

Parameters

[in]	connectivity	Main handle for connectivity component.
[in]	mapping	Mapping to be created.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL in case any input parameter is NULL.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
MCL_NOT_ONBOARDED if the agent is not onboarded using core passed to connectivity.
MCL_NO_ACCESS_TOKEN_EXISTS if core passed to connectivity does not have an access token.
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 90 of file connectivity.c.

References connectivity_processor_create_mapping(), MCL_ASSERT_NOT_NULL, mcl_core_get_last_access_token(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, MCL_FUNCTION_LEAVE_LABEL, and MCL_OK.

Here is the call graph for this function:

MCL_CONNECTIVITY_EXPORT void mcl_connectivity_destroy ( mcl_connectivity_t ** connectivity )

This function destroys the mcl_connectivity_t object and frees any memory allocated.

Parameters

[in] connectivity Preinitialized mcl_connectivity_t object to destroy.

Definition at line 145 of file connectivity.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, and MCL_NULL.

Referenced by mcl_connectivity_initialize().

Here is the caller graph for this function:

MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_connectivity_exchange	(	mcl_connectivity_t *	connectivity,
		void *	item
	)

This function exchanges data in item to MindSphere. Item can be either mcl_store_t which contains multiple data types or single data type such as mcl_event_t, mcl_data_source_configuration_t, mcl_timeseries_t, mcl_file_t and mcl_custom_data_t. connectivity has to be initialized before using this function.

Parameters

[in]	connectivity	Main handle for connectivity component.
[in]	item	The data to be uploaded to MindSphere.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL in case any input parameter is NULL.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
MCL_NOT_ONBOARDED if the agent is not onboarded using core passed to connectivity.
MCL_NO_ACCESS_TOKEN_EXISTS if core passed to connectivity does not have an access token.
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 63 of file connectivity.c.

References connectivity_processor_exchange(), MCL_ASSERT_NOT_NULL, mcl_core_get_last_access_token(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, MCL_FUNCTION_LEAVE_LABEL, and MCL_OK.

Here is the call graph for this function:

MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_connectivity_get_data_source_configuration	(	mcl_connectivity_t *	connectivity,
		mcl_data_source_configuration_t **	configuration
	)

This function gets data source configuration from MindSphere. connectivity has to be initialized before using this function.

Parameters

[in]	connectivity	Main handle for connectivity component.
[out]	configuration	Data source configuration.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL in case any input parameter is NULL.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
MCL_NOT_ONBOARDED if the agent is not onboarded using core passed to connectivity.
MCL_NO_ACCESS_TOKEN_EXISTS if core passed to connectivity does not have an access token.
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 117 of file connectivity.c.

References connectivity_processor_get_data_source_configuration(), MCL_ASSERT_NOT_NULL, mcl_core_get_last_access_token(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, MCL_FUNCTION_LEAVE_LABEL, MCL_NULL, and MCL_OK.

Here is the call graph for this function:

MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_connectivity_initialize	(	mcl_connectivity_configuration_t *	configuration,
		mcl_connectivity_t **	connectivity
	)

This function creates and initializes an object of type mcl_connectivity_t. Memory is allocated for the connectivity object and configuration is referenced by the connectivity object.

Parameters

[in]	configuration	Preinitialized mcl_connectivity_configuration_t object.
[out]	connectivity	Connectivity handle which is going to be initialized.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL in case core or connectivity is null.
MCL_INVALID_PARAMETER in case one of mandatory fields of configuration is not set.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
MCL_FAIL in case of an internal error in MCL.

Definition at line 13 of file connectivity.c.

References connectivity_configuration_validate(), MCL_ASSERT_NOT_NULL, mcl_connectivity_destroy(), mcl_core_get_client_id(), mcl_core_get_host_name(), mcl_core_get_http_client(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_NEW, MCL_NULL, MCL_OK, and MCL_OUT_OF_MEMORY.

Here is the call graph for this function:

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation