AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::Queues::Sqs::SQSQueue Class Reference

#include <SQSQueue.h>

+ Inheritance diagram for Aws::Queues::Sqs::SQSQueue:

Public Member Functions

void SetQueueArnSuccessEventHandler (const QueueArnSuccessEventHandler &messageHandler)
 
void SetQueueArnSuccessEventHandler (QueueArnSuccessEventHandler &&messageHandler)
 
void SetQueueArnFailedEventHandler (const QueueArnFailedEventHandler &messageHandler)
 
void SetQueueArnFailedEventHandler (QueueArnFailedEventHandler &&messageHandler)
 
void SetQueueAttributeSuccessEventHandler (const QueueAttributeSuccessEventHandler &messageHandler)
 
void SetQueueAttributeSuccessEventHandler (QueueAttributeSuccessEventHandler &&messageHandler)
 
void SetQueueAttributeFailedEventHandler (const QueueAttributeFailedEventHandler &messageHandler)
 
void SetQueueAttributeFailedEventHandler (QueueAttributeFailedEventHandler &&messageHandler)
 
const QueueArnSuccessEventHandler & GetQueueArnSuccessEventHandler () const
 
const QueueArnFailedEventHandler & GetQueueArnFailedEventHandler () const
 
const QueueAttributeSuccessEventHandler & GetQueueAttributeSuccessEventHandler () const
 
const QueueAttributeFailedEventHandler & GetQueueAttributeFailedEventHandler () const
 
 SQSQueue (const std::shared_ptr< SQS::SQSClient > &client, const char *queueName, unsigned visibilityTimeout, unsigned pollingFrequencyMs=10000)
 
Aws::SQS::Model::Message Top () const override
 
void Delete (const Aws::SQS::Model::Message &) override
 
void Push (const Aws::SQS::Model::Message &) override
 
void RequestArn ()
 
void EnsureQueueIsInitialized ()
 
bool IsInitialized () const
 
const Aws::StringGetQueueUrl () const
 
- Public Member Functions inherited from Aws::Queues::Queue< Aws::SQS::Model::Message >
 Queue (unsigned pollingFrequency)
 
virtual ~Queue ()
 
virtual Aws::SQS::Model::Message Top () const=0
 
void StartPolling ()
 
void StopPolling ()
 
void SetMessageReceivedEventHandler (const MessageReceivedEventHandler &messageHandler)
 
void SetMessageReceivedEventHandler (MessageReceivedEventHandler &&messageHandler)
 
void SetMessageDeleteFailedEventHandler (const MessageDeleteFailedEventHandler &messageHandler)
 
void SetMessageDeleteFailedEventHandler (MessageDeleteFailedEventHandler &&messageHandler)
 
void SetMessageDeleteSuccessEventHandler (const MessageDeleteSuccessEventHandler &messageHandler)
 
void SetMessageDeleteSuccessEventHandler (MessageDeleteSuccessEventHandler &&messageHandler)
 
void SetMessageSendFailedEventHandler (const MessageSendFailedEventHandler &messageHandler)
 
void SetMessageSendFailedEventHandler (MessageSendFailedEventHandler &&messageHandler)
 
void SetMessageSendSuccessEventHandler (const MessageSendSuccessEventHandler &messageHandler)
 
void SetMessageSendSuccessEventHandler (MessageSendSuccessEventHandler &&messageHandler)
 
const MessageReceivedEventHandler & GetMessageReceivedEventHandler () const
 
const MessageDeleteFailedEventHandler & GetMessageDeleteFailedEventHandler () const
 
const MessageDeleteSuccessEventHandler & GetMessageDeleteSuccessEventHandler () const
 
const MessageSendFailedEventHandler & GetMessageSendFailedEventHandler () const
 
const MessageSendSuccessEventHandler & GetMessageSendSuccessEventHandler () const
 

Additional Inherited Members

- Protected Attributes inherited from Aws::Queues::Queue< Aws::SQS::Model::Message >
std::atomic< bool > m_continue
 

Detailed Description

SQS implementation of the Queue interface. See Queue documentation for more details.

Definition at line 32 of file SQSQueue.h.

Constructor & Destructor Documentation

◆ SQSQueue()

Aws::Queues::Sqs::SQSQueue::SQSQueue ( const std::shared_ptr< SQS::SQSClient > &  client,
const char *  queueName,
unsigned  visibilityTimeout,
unsigned  pollingFrequencyMs = 10000 
)

Queue name is the name of the queue that the client should poll, push, and/or delete messages on. Call EnsureQueueIsInitialized to create the queue if it does not exist. You can call GetQueueUrl after IsInitialized() returns true to get your actual Queue URL.

Member Function Documentation

◆ Delete()

void Aws::Queues::Sqs::SQSQueue::Delete ( const Aws::SQS::Model::Message )
overridevirtual

Does not block. Register for notifications of success or failure with the appropriate handlers.

Implements Aws::Queues::Queue< Aws::SQS::Model::Message >.

◆ EnsureQueueIsInitialized()

void Aws::Queues::Sqs::SQSQueue::EnsureQueueIsInitialized ( )

At the very least, this gets your queue url. If the queue does not exist, this will create it.

◆ GetQueueArnFailedEventHandler()

const QueueArnFailedEventHandler& Aws::Queues::Sqs::SQSQueue::GetQueueArnFailedEventHandler ( ) const
inline

Definition at line 67 of file SQSQueue.h.

◆ GetQueueArnSuccessEventHandler()

const QueueArnSuccessEventHandler& Aws::Queues::Sqs::SQSQueue::GetQueueArnSuccessEventHandler ( ) const
inline

Definition at line 66 of file SQSQueue.h.

◆ GetQueueAttributeFailedEventHandler()

const QueueAttributeFailedEventHandler& Aws::Queues::Sqs::SQSQueue::GetQueueAttributeFailedEventHandler ( ) const
inline

Definition at line 70 of file SQSQueue.h.

◆ GetQueueAttributeSuccessEventHandler()

const QueueAttributeSuccessEventHandler& Aws::Queues::Sqs::SQSQueue::GetQueueAttributeSuccessEventHandler ( ) const
inline

Definition at line 69 of file SQSQueue.h.

◆ GetQueueUrl()

const Aws::String& Aws::Queues::Sqs::SQSQueue::GetQueueUrl ( ) const
inline

Definition at line 105 of file SQSQueue.h.

◆ IsInitialized()

bool Aws::Queues::Sqs::SQSQueue::IsInitialized ( ) const
inline

Definition at line 104 of file SQSQueue.h.

◆ Push()

void Aws::Queues::Sqs::SQSQueue::Push ( const Aws::SQS::Model::Message )
overridevirtual

Does not block. Register for notifications of success or failure with the appropriate handlers.

Implements Aws::Queues::Queue< Aws::SQS::Model::Message >.

◆ RequestArn()

void Aws::Queues::Sqs::SQSQueue::RequestArn ( )

Does not block. Register for notifications of success or failure with the appropriate handlers.

◆ SetQueueArnFailedEventHandler() [1/2]

void Aws::Queues::Sqs::SQSQueue::SetQueueArnFailedEventHandler ( const QueueArnFailedEventHandler &  messageHandler)
inline

Notification that getting a queue arn was successful.

Definition at line 51 of file SQSQueue.h.

◆ SetQueueArnFailedEventHandler() [2/2]

void Aws::Queues::Sqs::SQSQueue::SetQueueArnFailedEventHandler ( QueueArnFailedEventHandler &&  messageHandler)
inline

Definition at line 52 of file SQSQueue.h.

◆ SetQueueArnSuccessEventHandler() [1/2]

void Aws::Queues::Sqs::SQSQueue::SetQueueArnSuccessEventHandler ( const QueueArnSuccessEventHandler &  messageHandler)
inline

Notification that getting a queue arn was successful.

Definition at line 45 of file SQSQueue.h.

◆ SetQueueArnSuccessEventHandler() [2/2]

void Aws::Queues::Sqs::SQSQueue::SetQueueArnSuccessEventHandler ( QueueArnSuccessEventHandler &&  messageHandler)
inline

Definition at line 46 of file SQSQueue.h.

◆ SetQueueAttributeFailedEventHandler() [1/2]

void Aws::Queues::Sqs::SQSQueue::SetQueueAttributeFailedEventHandler ( const QueueAttributeFailedEventHandler &  messageHandler)
inline

Notification that getting a queue attribute failed.

Definition at line 63 of file SQSQueue.h.

◆ SetQueueAttributeFailedEventHandler() [2/2]

void Aws::Queues::Sqs::SQSQueue::SetQueueAttributeFailedEventHandler ( QueueAttributeFailedEventHandler &&  messageHandler)
inline

Definition at line 64 of file SQSQueue.h.

◆ SetQueueAttributeSuccessEventHandler() [1/2]

void Aws::Queues::Sqs::SQSQueue::SetQueueAttributeSuccessEventHandler ( const QueueAttributeSuccessEventHandler &  messageHandler)
inline

Notification that getting a queue attribute was successful.

Definition at line 57 of file SQSQueue.h.

◆ SetQueueAttributeSuccessEventHandler() [2/2]

void Aws::Queues::Sqs::SQSQueue::SetQueueAttributeSuccessEventHandler ( QueueAttributeSuccessEventHandler &&  messageHandler)
inline

Definition at line 58 of file SQSQueue.h.

◆ Top()

Aws::SQS::Model::Message Aws::Queues::Sqs::SQSQueue::Top ( ) const
override

Will continue polling until a message is received or StopPolling is called.


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