ibuilder.hpp

Go to the documentation of this file.

/*
 * Copyright 2025 Jinwoo Sung
 *
 * 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.
 */
 
#pragma once
 
#include <functional>
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
#include "unilink/base/visibility.hpp"
#include "unilink/framer/iframer.hpp"
#include "unilink/framer/line_framer.hpp"
#include "unilink/framer/packet_framer.hpp"
#include "unilink/memory/safe_span.hpp"
#include "unilink/wrapper/context.hpp"
 
namespace unilink {
namespace builder {
 
template <typename T, typename Derived>
class BuilderInterface {
 public:
  virtual ~BuilderInterface() = default;
  BuilderInterface() = default;
  BuilderInterface(const BuilderInterface&) = default;
  BuilderInterface(BuilderInterface&&) = default;
  BuilderInterface& operator=(const BuilderInterface&) = default;
  BuilderInterface& operator=(BuilderInterface&&) = default;
 
  virtual std::unique_ptr<T> build() = 0;
 
  virtual Derived& auto_manage(bool auto_manage = true) = 0;
 
  virtual Derived& on_data(std::function<void(const wrapper::MessageContext&)> handler) = 0;
 
  template <typename U, typename F>
  Derived& on_data(U* obj, F method) {
    return on_data([obj, method](const wrapper::MessageContext& ctx) { (obj->*method)(ctx); });
  }
 
  virtual Derived& on_connect(std::function<void(const wrapper::ConnectionContext&)> handler) = 0;
 
  template <typename U, typename F>
  Derived& on_connect(U* obj, F method) {
    return on_connect([obj, method](const wrapper::ConnectionContext& ctx) { (obj->*method)(ctx); });
  }
 
  virtual Derived& on_disconnect(std::function<void(const wrapper::ConnectionContext&)> handler) = 0;
 
  template <typename U, typename F>
  Derived& on_disconnect(U* obj, F method) {
    return on_disconnect([obj, method](const wrapper::ConnectionContext& ctx) { (obj->*method)(ctx); });
  }
 
  virtual Derived& on_error(std::function<void(const wrapper::ErrorContext&)> handler) = 0;
 
  template <typename U, typename F>
  Derived& on_error(U* obj, F method) {
    return on_error([obj, method](const wrapper::ErrorContext& ctx) { (obj->*method)(ctx); });
  }
 
  // Framing Support (remains focused on raw data for now, can be evolved)
 
  Derived& use_line_framer(std::string_view delimiter = "\n", bool include_delimiter = false,
                           size_t max_length = 65536) {
    framer_ = std::make_unique<framer::LineFramer>(delimiter, include_delimiter, max_length);
    return static_cast<Derived&>(*this);
  }
 
  Derived& use_packet_framer(const std::vector<uint8_t>& start_pattern, const std::vector<uint8_t>& end_pattern,
                             size_t max_length) {
    framer_ = std::make_unique<framer::PacketFramer>(start_pattern, end_pattern, max_length);
    return static_cast<Derived&>(*this);
  }
 
  Derived& on_message(std::function<void(memory::ConstByteSpan)> handler) {
    on_message_ = std::move(handler);
    return static_cast<Derived&>(*this);
  }
 
  template <typename U, typename F>
  Derived& on_message(U* obj, F method) {
    return on_message([obj, method](memory::ConstByteSpan msg) { (obj->*method)(msg); });
  }
 
 protected:
  std::unique_ptr<framer::IFramer> framer_;
  std::function<void(memory::ConstByteSpan)> on_message_;
};
 
}  // namespace builder
}  // namespace unilink