cloudwatch.h File Reference

The declarations in this header file correspond to the definitions in cloudwatch.c. More...

#include "configuration.h"
#include "cdi_core_api.h"
#include "private.h"

Go to the source code of this file.

Typedefs
typedef struct CloudWatchState	CloudWatchState
	Forward reference of structure to create pointers later.
typedef struct CloudWatchState *	CloudWatchHandle
	Type used as the handle (pointer to an opaque structure) for managing statistics for a connection. Each handle represents a single data flow.

Functions
CdiReturnStatus	CloudWatchCreate (CdiConnectionState *con_state_ptr, CloudWatchSdkMetricsHandle cw_sdk_handle, CloudWatchHandle *return_handle_ptr)
CdiReturnStatus	CloudWatchDestroy (CloudWatchHandle handle)
CdiReturnStatus	CloudWatchConfigure (CloudWatchHandle handle, const CdiStatsConfigData *stats_config_ptr)
void	CloudWatchStatisticsMessage (CloudWatchHandle handle, int stats_count, const CdiTransferStats *transfer_stats_array)

Detailed Description

The declarations in this header file correspond to the definitions in cloudwatch.c.

Function Documentation

CloudWatchConfigure()

CdiReturnStatus CloudWatchConfigure	(	CloudWatchHandle	handle,
		const CdiStatsConfigData *	stats_config_ptr )

Configure transfer statistics.

Parameters

handle	The handle of the connection to set statistics configuration.
stats_config_ptr	Pointer to stats configuration data.

Returns

A value from the CdiReturnStatus enumeration.

CloudWatchCreate()

CdiReturnStatus CloudWatchCreate	(	CdiConnectionState *	con_state_ptr,
		CloudWatchSdkMetricsHandle	cw_sdk_handle,
		CloudWatchHandle *	return_handle_ptr )

Create an instance of the statistics component for the specified connection.

Parameters

con_state_ptr	Pointer to connection state data.
cw_sdk_handle	CloudWatch SDK instance handle
return_handle_ptr	Address where to write returned statistics handle.

Returns

A value from the CdiReturnStatus enumeration.

CloudWatchDestroy()

CdiReturnStatus CloudWatchDestroy

(

CloudWatchHandle

handle

)

Free all resources related to the specified statistics component.

Parameters

handle

Handle of statistics component.

Returns

A value from the CdiReturnStatus enumeration.

CloudWatchStatisticsMessage()

void CloudWatchStatisticsMessage	(	CloudWatchHandle	handle,
		int	stats_count,
		const CdiTransferStats *	transfer_stats_array )

Process a message that contains new statistics to post to CloudWatch.

Parameters

handle	Handle of statistics component.
stats_count	Number of array items in transfer_stats_array.
transfer_stats_array	Pointer to start of transfer stats array.