bmqa_sessionevent.h

Go to the documentation of this file.

// Copyright 2014-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.
 
// bmqa_sessionevent.h                                                -*-C++-*-
#ifndef INCLUDED_BMQA_SESSIONEVENT
#define INCLUDED_BMQA_SESSIONEVENT
 
 
// BMQ
 
#include <bmqa_queueid.h>
#include <bmqt_correlationid.h>
#include <bmqt_sessioneventtype.h>
 
// BDE
#include <bsl_memory.h>
#include <bsl_string.h>
 
namespace BloombergLP {
 
// FORWARD DECLARATION
namespace bmqimp {
class Event;
}
 
namespace bmqa {
 
// ==================
// class SessionEvent
// ==================
 
class SessionEvent {
  private:
    // FRIENDS
    friend bool operator==(const SessionEvent& lhs, const SessionEvent& rhs);
    friend bool operator!=(const SessionEvent& lhs, const SessionEvent& rhs);
 
  private:
    // DATA
    bsl::shared_ptr<bmqimp::Event> d_impl_sp;  // pimpl
 
  public:
    // CREATORS
 
    SessionEvent();
 
    SessionEvent(const SessionEvent& other);
 
    // MANIPULATORS
 
    SessionEvent& operator=(const SessionEvent& rhs);
 
    // ACCESSORS
 
    bmqt::SessionEventType::Enum type() const;
 
    const bmqt::CorrelationId& correlationId() const;
 
    QueueId queueId() const;
 
    int statusCode() const;
 
    const bsl::string& errorDescription() const;
 
    bsl::ostream&
    print(bsl::ostream& stream, int level = 0, int spacesPerLevel = 4) const;
};
 
// FREE OPERATORS
 
bool operator==(const SessionEvent& lhs, const SessionEvent& rhs);
 
bool operator!=(const SessionEvent& lhs, const SessionEvent& rhs);
 
bsl::ostream& operator<<(bsl::ostream& stream, const SessionEvent& rhs);
 
}  // close package namespace
 
// ============================================================================
//                             INLINE DEFINITIONS
// ============================================================================
 
// ------------------
// class SessionEvent
// ------------------
 
inline bsl::ostream& bmqa::operator<<(bsl::ostream&             stream,
                                      const bmqa::SessionEvent& rhs)
{
    return rhs.print(stream, 0, -1);
}
 
}  // close enterprise namespace
 
#endif