iothub_message.h

Go to the documentation of this file.

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
#ifndef IOTHUB_MESSAGE_H
#define IOTHUB_MESSAGE_H
 
#include "azure_macro_utils/macro_utils.h"
#include "azure_c_shared_utility/map.h"
#include "umock_c/umock_c_prod.h"
 
#ifdef __cplusplus
#include <cstddef>
extern "C"
{
#else
#include <stddef.h>
#endif
 
typedef enum { IOTHUB_MESSAGE_OK, IOTHUB_MESSAGE_INVALID_ARG, IOTHUB_MESSAGE_INVALID_TYPE, IOTHUB_MESSAGE_ERROR, IOTHUB_MESSAGE_BECAUSE_DESTROY } IOTHUB_MESSAGE_RESULT;
typedef enum { IOTHUBMESSAGE_BYTEARRAY, IOTHUBMESSAGE_STRING, IOTHUBMESSAGE_UNKNOWN } IOTHUBMESSAGE_CONTENT_TYPE;
typedef struct IOTHUB_MESSAGE_HANDLE_DATA_TAG* IOTHUB_MESSAGE_HANDLE;
 
typedef struct IOTHUB_MESSAGE_DIAGNOSTIC_PROPERTY_DATA_TAG
{
    char* diagnosticId;
    char* diagnosticCreationTimeUtc;
}IOTHUB_MESSAGE_DIAGNOSTIC_PROPERTY_DATA, *IOTHUB_MESSAGE_DIAGNOSTIC_PROPERTY_DATA_HANDLE;
 
static const char DIAG_CREATION_TIME_UTC_PROPERTY_NAME[] = "diag_creation_time_utc";
 
 IOTHUB_MESSAGE_HANDLE IoTHubMessage_CreateFromByteArray( const unsigned char* byteArray, size_t size);
 IOTHUB_MESSAGE_HANDLE IoTHubMessage_CreateFromString( const char* source);
 IOTHUB_MESSAGE_HANDLE IoTHubMessage_Clone( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_GetByteArray( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const unsigned char** buffer, size_t* size);
 const char* IoTHubMessage_GetString( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUBMESSAGE_CONTENT_TYPE IoTHubMessage_GetContentType( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetContentTypeSystemProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* contentType);
 const char* IoTHubMessage_GetContentTypeSystemProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetContentEncodingSystemProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* contentEncoding);
 const char* IoTHubMessage_GetContentEncodingSystemProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 MAP_HANDLE IoTHubMessage_Properties( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* key, const char* value);
 const char* IoTHubMessage_GetProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* key);
 const char* IoTHubMessage_GetMessageId( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetMessageId( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* messageId);
 const char* IoTHubMessage_GetCorrelationId( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetCorrelationId( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* correlationId);
 const IOTHUB_MESSAGE_DIAGNOSTIC_PROPERTY_DATA* IoTHubMessage_GetDiagnosticPropertyData( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetDiagnosticPropertyData( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const IOTHUB_MESSAGE_DIAGNOSTIC_PROPERTY_DATA* diagnosticData);
 const char* IoTHubMessage_GetOutputName( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetOutputName( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* outputName);
 
 const char* IoTHubMessage_GetInputName( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetInputName( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* inputName);
 const char* IoTHubMessage_GetConnectionModuleId( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetConnectionModuleId( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* connectionModuleId);
 const char* IoTHubMessage_GetConnectionDeviceId( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetMessageCreationTimeUtcSystemProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* messageCreationTimeUtc);
 const char* IoTHubMessage_GetMessageCreationTimeUtcSystemProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetMessageUserIdSystemProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* userId);
 const char* IoTHubMessage_GetMessageUserIdSystemProperty( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetConnectionDeviceId( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* connectionDeviceId);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetAsSecurityMessage( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 bool IoTHubMessage_IsSecurityMessage( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 IOTHUB_MESSAGE_RESULT IoTHubMessage_SetComponentName( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle, const char* componentName);
 const char* IoTHubMessage_GetComponentName( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 void IoTHubMessage_Destroy( IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
#ifdef __cplusplus
}
#endif
 
#endif /* IOTHUB_MESSAGE_H */