gz/transport/log/Message.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * 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 GZ_TRANSPORT_LOG_MESSAGE_HH_
#define GZ_TRANSPORT_LOG_MESSAGE_HH_
 
#include <chrono>
#include <memory>
#include <string>
 
#include <gz/transport/config.hh>
#include <gz/transport/log/Export.hh>
 
namespace ignition::transport::log
{
  // Inline bracket to help doxygen filtering.
  inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
  //
  class MessagePrivate;
 
  class IGNITION_TRANSPORT_LOG_VISIBLE Message
  {
    public: Message();
 
    public: Message(
        const std::chrono::nanoseconds &_timeRecv,
        const void *_data, std::size_t _dataLen,
        const char *_type, std::size_t _typeLen,
        const char *_topic, std::size_t _topicLen);
 
    public: Message(Message && _other) = delete;
 
    public: Message(const Message & _other) = delete;
 
    public: ~Message();
 
    public: std::string Data() const;
 
    public: std::string Type() const;
 
    public: std::string Topic() const;
 
    public: const std::chrono::nanoseconds &TimeReceived() const;
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    private: std::unique_ptr<MessagePrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
  };
  }
}
#endif