rmqa_messageguard.h

// Copyright 2020-2023 Bloomberg Finance L.P.
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef INCLUDED_RMQA_MESSAGEGUARD
#define INCLUDED_RMQA_MESSAGEGUARD
 
#include <rmqp_messageguard.h>
#include <rmqt_consumerack.h>
#include <rmqt_envelope.h>
#include <rmqt_message.h>
 
#include <bsls_keyword.h>
 
#include <bsl_functional.h>
#include <bsl_memory.h>
#include <bsl_ostream.h>
#include <bslma_managedptr.h>
 
namespace BloombergLP {
namespace rmqp {
class Consumer;
}
namespace rmqa {
 
 
class MessageGuard : public rmqp::MessageGuard {
  public:
    class Factory {
      public:
        virtual bslma::ManagedPtr<rmqa::MessageGuard>
        create(const rmqt::Message& message,
               const rmqt::Envelope& envelope,
               const MessageGuardCallback& ackCallback,
               rmqp::Consumer* consumer) const;
 
        virtual ~Factory();
    };
 
    MessageGuard(const rmqt::Message& message,
                 const rmqt::Envelope& envelope,
                 const MessageGuardCallback& ackCallback,
                 rmqp::Consumer* consumer);
 
    MessageGuard(const MessageGuard& obj);
 
    ~MessageGuard() BSLS_KEYWORD_OVERRIDE;
 
    const rmqt::Message& message() const BSLS_KEYWORD_OVERRIDE;
 
    const rmqt::Envelope& envelope() const BSLS_KEYWORD_OVERRIDE;
 
    void ack() BSLS_KEYWORD_OVERRIDE;
 
    void nack(bool requeue = true) BSLS_KEYWORD_OVERRIDE;
 
    virtual rmqp::Consumer* consumer() const BSLS_KEYWORD_OVERRIDE;
 
    rmqp::TransferrableMessageGuard transferOwnership() BSLS_KEYWORD_OVERRIDE;
 
  protected:
    enum State { READY, TRANSFERRED, RESOLVED };
 
    State state() const { return d_state; }
 
  private:
    mutable State d_state;
 
    rmqt::Message d_message;
    rmqt::Envelope d_envelope;
    MessageGuardCallback d_ackCallback;
    rmqp::Consumer* d_consumer;
 
  private:
    void resolve(rmqt::ConsumerAck::Type ackOption);
 
    MessageGuard& operator=(const MessageGuard& other);
 
    friend bsl::ostream& operator<<(bsl::ostream& os, const MessageGuard& mg);
}; // class MessageGuard
 
bsl::ostream& operator<<(bsl::ostream& os, const MessageGuard& mg);
 
} // namespace rmqa
} // namespace BloombergLP
 
#endif // ! INCLUDED_RMQA_MESSAGEGUARD