scp_transceiver.hpp

Go to the documentation of this file.

/*
 * Copyright 2020 Robert Bosch GmbH
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <string>  // for string
 
#include <cloe/core.hpp>                     // for Json, Error
#include <cloe/utility/tcp_transceiver.hpp>  // for TcpTransceiver
 
#include "vtd_version.hpp"
#if (VTD_API_VERSION_EPOCH == 0)
  #include <scpIcd.h>
#else
  #include <VtdToolkit/scpIcd.h>
#endif
 
#include "vtd_logger.hpp"  // for scp_logger
 
namespace vtd {
 
class ScpMessage {
 public:
  virtual ~ScpMessage() = default;
  virtual std::string to_scp() const = 0;
};
 
class ScpError : public cloe::Error {
 public:
  using Error::Error;
  virtual ~ScpError() noexcept = default;
};
 
class ScpTransceiver : public cloe::utility::TcpTransceiver {
 public:
  using TcpTransceiver::TcpTransceiver;
  ~ScpTransceiver() = default;
 
  void send(const ScpMessage& msg) { write(msg.to_scp()); }
  void send(const std::string& msg) { write(msg.c_str()); }
  void send(const char* msg) { write(msg); }
 
  // unstable API:
  bool has() const {
    return this->tcp_available_data() >= static_cast<std::streamsize>(sizeof(SCP_MSG_HDR_t));
  }
 
  std::string receive();
 
  friend void to_json(cloe::Json j, const ScpTransceiver& t) {
    j = cloe::Json{
        {"connection_endpoint", t.tcp_endpoint()},
        {"connection_ok", t.tcp_is_ok()},
        {"num_errors", t.num_errors_},
        {"num_messages_sent", t.num_sent_},
        {"num_messages_received", t.num_received_},
    };
  }
 
 protected:
  void write(const std::string& msg) { write(msg.c_str()); }
  void write(const char* msg);
 
 private:
  uint64_t num_errors_{0};
  uint64_t num_sent_{0};
  uint64_t num_received_{0};
};
 
class ScpTransceiverFactory : public cloe::utility::TcpTransceiverFactory<ScpTransceiver> {
 public:
  using TcpTransceiverFactory::TcpTransceiverFactory;
  ~ScpTransceiverFactory() = default;
 
 protected:
  cloe::Logger factory_logger() const override { return scp_logger(); }
  const char* instance_name() const override { return "ScpTransceiver"; }
};
 
}  // namespace vtd