cloudwatch_sdk_metrics.h File Reference

The declarations in this header file correspond to the definitions in cloudwatch_sdk_metrics.cpp. More...

#include "cdi_core_api.h"

Go to the source code of this file.

Data Structures
struct	CloudWatchCounterBasedDeltas
	Counter based statistics data that contain deltas since the last set was generated. More...
struct	CloudWatchTransferStats
	A structure that is used to hold statistics gathering configuration data that is specific to CloudWatch. More...
struct	MetricsGathererConfigData
	A structure that is used to hold statistics gathering configuration data for instantiating a metrics gathering client handler. More...

Typedefs
typedef struct CloudWatchSdkMetrics	CloudWatchSdkMetrics
	Forward reference of structure to create pointers later.
typedef struct CloudWatchSdkMetrics *	CloudWatchSdkMetricsHandle
	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	CloudWatchSdkMetricsCreate (const CdiCloudWatchConfigData *config_ptr, CloudWatchSdkMetricsHandle *ret_handle_ptr)
CdiReturnStatus	CloudWatchSdkMetricsDestroy (CloudWatchSdkMetricsHandle handle)
CdiReturnStatus	MetricsGathererCreate (const MetricsGathererConfigData *config_ptr, CloudWatchSdkMetricsHandle *ret_handle_ptr)
CdiReturnStatus	MetricsGathererDestroy (CloudWatchSdkMetricsHandle handle)
CdiReturnStatus	MetricsSend (CloudWatchSdkMetricsHandle handle, const CloudWatchTransferStats *transfer_stats_ptr)

Detailed Description

The declarations in this header file correspond to the definitions in cloudwatch_sdk_metrics.cpp.

Function Documentation

CloudWatchSdkMetricsCreate()

CdiReturnStatus CloudWatchSdkMetricsCreate	(	const CdiCloudWatchConfigData *	config_ptr,
		CloudWatchSdkMetricsHandle *	ret_handle_ptr )

Create an instance of CloudWatch SDK metrics and open a connection.

Parameters

config_ptr	Pointer to configuration data.
ret_handle_ptr	Address where to write returned CloudWatch wrapper handle.

Returns

A value from the CdiReturnStatus enumeration.

CloudWatchSdkMetricsDestroy()

CdiReturnStatus CloudWatchSdkMetricsDestroy

(

CloudWatchSdkMetricsHandle

handle

)

Free all resources related to the specified CloudWatch SDK metrics instance.

Parameters

handle

Handle of CloudWatch SDK metrics instance.

Returns

A value from the CdiReturnStatus enumeration.

MetricsGathererCreate()

CdiReturnStatus MetricsGathererCreate	(	const MetricsGathererConfigData *	config_ptr,
		CloudWatchSdkMetricsHandle *	ret_handle_ptr )

Create a CDI metrics gathering system client and open a connection to the service.

Parameters

config_ptr	Pointer to configuration data.
ret_handle_ptr	Address where to write returned handle.

Returns

A value from the CdiReturnStatus enumeration.

MetricsGathererDestroy()

CdiReturnStatus MetricsGathererDestroy

(

CloudWatchSdkMetricsHandle

handle

)

Free all resources related to the specified CloudWatch SDK metrics instance.

Parameters

handle

Handle of CDI metrics gathering service client instance.

Returns

A value from the CdiReturnStatus enumeration.

MetricsSend()

CdiReturnStatus MetricsSend	(	CloudWatchSdkMetricsHandle	handle,
		const CloudWatchTransferStats *	transfer_stats_ptr )

Send transfer statistics using the specified pubishing client instance.

Parameters

handle	The handle of the CloudWatch SDK metrics instance to send statistics to.
transfer_stats_ptr	Pointer to stats to send.

Returns

A value from the CdiReturnStatus enumeration.