AWS SDK for C++  1.9.161
AWS SDK for C++
Public Member Functions | List of all members
Aws::Monitoring::MonitoringInterface Class Referenceabstract

#include <MonitoringInterface.h>

+ Inheritance diagram for Aws::Monitoring::MonitoringInterface:

Public Member Functions

virtual ~MonitoringInterface ()=default
 
virtual void * OnRequestStarted (const Aws::String &serviceName, const Aws::String &requestName, const std::shared_ptr< const Aws::Http::HttpRequest > &request) const =0
 This function lets you do preparation work when a http attempt(request) starts. It returns a pointer to an implementation defined context which will be passed down with the other facilities that completes the request's lifetime. This context can be used to track the lifetime of the request and record metrics specific to this particular request. You are responsible for deleteing the context during your OnFinish call. More...
 
virtual void OnRequestSucceeded (const Aws::String &serviceName, const Aws::String &requestName, const std::shared_ptr< const Aws::Http::HttpRequest > &request, const Aws::Client::HttpResponseOutcome &outcome, const CoreMetricsCollection &metricsFromCore, void *context) const =0
 Once a Http attempt finished and received "Succeeded" response, this function will be called. More...
 
virtual void OnRequestFailed (const Aws::String &serviceName, const Aws::String &requestName, const std::shared_ptr< const Aws::Http::HttpRequest > &request, const Aws::Client::HttpResponseOutcome &outcome, const CoreMetricsCollection &metricsFromCore, void *context) const =0
 Once a Http request finished and received "Failed" response, this function will be called. More...
 
virtual void OnRequestRetry (const Aws::String &serviceName, const Aws::String &requestName, const std::shared_ptr< const Aws::Http::HttpRequest > &request, void *context) const =0
 Once an API call retried the attempt and send the request again, this function will be called. More...
 
virtual void OnFinish (const Aws::String &serviceName, const Aws::String &requestName, const std::shared_ptr< const Aws::Http::HttpRequest > &request, void *context) const =0
 This function will always be called by the SDK to signal the implementer that this request is done. The implementer can safely delete the context. More...
 

Detailed Description

Monitoring interface definition for SDK metrics collection.

Definition at line 21 of file MonitoringInterface.h.

Constructor & Destructor Documentation

◆ ~MonitoringInterface()

virtual Aws::Monitoring::MonitoringInterface::~MonitoringInterface ( )
virtualdefault

Member Function Documentation

◆ OnFinish()

virtual void Aws::Monitoring::MonitoringInterface::OnFinish ( const Aws::String serviceName,
const Aws::String requestName,
const std::shared_ptr< const Aws::Http::HttpRequest > &  request,
void *  context 
) const
pure virtual

This function will always be called by the SDK to signal the implementer that this request is done. The implementer can safely delete the context.

Parameters
serviceName,theservice client who initiate this http attempt. like "s3", "ec2", etc.
requestName,theoperation or API name of this http attempt, like "GetObject" in s3.
request,theactual Http Request.
contextparameter pointed to the same place returned by OnRequestStarted() function.
Returns
void.

Implemented in Aws::Monitoring::DefaultMonitoring.

◆ OnRequestFailed()

virtual void Aws::Monitoring::MonitoringInterface::OnRequestFailed ( const Aws::String serviceName,
const Aws::String requestName,
const std::shared_ptr< const Aws::Http::HttpRequest > &  request,
const Aws::Client::HttpResponseOutcome outcome,
const CoreMetricsCollection metricsFromCore,
void *  context 
) const
pure virtual

Once a Http request finished and received "Failed" response, this function will be called.

Parameters
serviceName,theservice client who initiate this http attempt. like "s3", "ec2", etc.
requestName,theoperation or API name of this http attempt, like "GetObject" in s3.
request,theactual Http Request.
outcome,theoutcome of the http attempt, you can access httpResponse and original httpRequest from it.
metricsFromCore,metricscollected from core, such as detailed latencies during http connection.
contextparameter pointed to the same place returned by OnRequestStarted() function.
Returns
void.

Implemented in Aws::Monitoring::DefaultMonitoring.

◆ OnRequestRetry()

virtual void Aws::Monitoring::MonitoringInterface::OnRequestRetry ( const Aws::String serviceName,
const Aws::String requestName,
const std::shared_ptr< const Aws::Http::HttpRequest > &  request,
void *  context 
) const
pure virtual

Once an API call retried the attempt and send the request again, this function will be called.

Parameters
serviceName,theservice client who initiate this http attempt. like "s3", "ec2", etc.
requestName,theoperation or API name of this http attempt, like "GetObject" in s3.
request,theactual Http Request.
contextparameter pointed to the same place returned by OnRequestStarted() function.
Returns
void.

Implemented in Aws::Monitoring::DefaultMonitoring.

◆ OnRequestStarted()

virtual void* Aws::Monitoring::MonitoringInterface::OnRequestStarted ( const Aws::String serviceName,
const Aws::String requestName,
const std::shared_ptr< const Aws::Http::HttpRequest > &  request 
) const
pure virtual

This function lets you do preparation work when a http attempt(request) starts. It returns a pointer to an implementation defined context which will be passed down with the other facilities that completes the request's lifetime. This context can be used to track the lifetime of the request and record metrics specific to this particular request. You are responsible for deleteing the context during your OnFinish call.

Parameters
serviceName,theservice client who initiates this http attempt. like "s3", "ec2", etc.
requestName,theoperation or API name of this http attempt, like "GetObject" in s3.
request,theactual Http Request.
Returns
implementation depends memory address of context.

Implemented in Aws::Monitoring::DefaultMonitoring.

◆ OnRequestSucceeded()

virtual void Aws::Monitoring::MonitoringInterface::OnRequestSucceeded ( const Aws::String serviceName,
const Aws::String requestName,
const std::shared_ptr< const Aws::Http::HttpRequest > &  request,
const Aws::Client::HttpResponseOutcome outcome,
const CoreMetricsCollection metricsFromCore,
void *  context 
) const
pure virtual

Once a Http attempt finished and received "Succeeded" response, this function will be called.

Parameters
serviceName,theservice client who initiate this http attempt. like "s3", "ec2", etc.
requestName,theoperation or API name of this http attempt, like "GetObject" in s3.
request,theactual Http Request.
outcome,theoutcome of the http attempt, you can access httpResponse and original httpRequest from it.
metricsFromCore,metricscollected from core, such as detailed latencies during http connection.
contextparameter pointed to the same place returned by OnRequestStarted() function.
Returns
void.

Implemented in Aws::Monitoring::DefaultMonitoring.


The documentation for this class was generated from the following file: