bmqa_messageiterator.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_messageiterator.h                                             -*-C++-*-
#ifndef INCLUDED_BMQA_MESSAGEITERATOR
#define INCLUDED_BMQA_MESSAGEITERATOR
 
 
// BMQ
 
#include <bmqa_message.h>
 
// BDE
#include <ball_log.h>
 
namespace BloombergLP {
 
// FORWARD DECLARATION
namespace bmqimp {
class Event;
}
 
namespace bmqa {
 
// ==========================
// struct MessageIteratorImpl
// ==========================
 
struct MessageIteratorImpl {
    // PUBLIC DATA
 
    bmqimp::Event* d_event_p;
 
    bmqa::Message d_message;
 
    int d_messageIndex;
};
 
// =====================
// class MessageIterator
// =====================
 
class MessageIterator {
  private:
    // CLASS-SCOPE CATEGORY
    BALL_LOG_SET_CLASS_CATEGORY("BMQA.MESSAGEITERATOR");
 
  private:
    // DATA
    MessageIteratorImpl d_impl;  // Implementation. Abstracted in its own
                                 // struct and private so that we can do some
                                 // magic to manipulate it without exposing any
                                 // accessors/manipulators (this is wanted
                                 // since this class is a public class).
 
  public:
    // CREATORS
 
    MessageIterator();
 
    // MANIPULATORS
 
    bool nextMessage();
 
    // ACCESSORS
 
    const Message& message() const;
};
 
}  // close package namespace
}  // close enterprise namespace
 
#endif