public/lib/netemul/network/ethertap_client.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef LIB_NETEMUL_NETWORK_ETHERTAP_CLIENT_H_
#define LIB_NETEMUL_NETWORK_ETHERTAP_CLIENT_H_

#include <lib/async/dispatcher.h>
#include <lib/fit/function.h>
#include <lib/zx/socket.h>
#include <stdlib.h>
#include <zircon/types.h>
#include <memory>
#include <string>
#include <vector>
#include "ethertap_types.h"

namespace netemul {

class EthertapConfig {
 public:
  std::string name = "etap";
  uint32_t options = 0;
  uint32_t features = 0;
  uint32_t mtu = 1500;
  Mac mac;

  explicit EthertapConfig(std::string tap_name) : name(std::move(tap_name)) {
    mac.RandomLocalUnicast(name);
  }
  explicit EthertapConfig(const Mac& mac) : mac(mac) {}
};

// Helper class to create and operate Ethertap Devices.
// Existence of the tap device is tied to object lifecycle (RAII), so if you
// intend to connect to the ethernet device you must keep the EthertapClient
// instance in scope.
class EthertapClient {
 public:
  using PacketCallback = fit::function<void(const void* buf, size_t len)>;
  using PeerClosedCallback = fit::function<void()>;
  virtual ~EthertapClient() = default;

  // Toggles ethertap link up signal.
  virtual void SetLinkUp(bool linkUp) = 0;
  // sends data packet.
  virtual zx_status_t Send(const void* data, size_t len, size_t* sent) = 0;
  // PacketCallback will be called whenever the tap device receives a packet.
  virtual void SetPacketCallback(PacketCallback cb) = 0;
  // PeerClosedCallback will be called if the client loses connection with the
  // tap device.
  virtual void SetPeerClosedCallback(PeerClosedCallback cb) = 0;
  // Closes connection locally with ethertap (no peer closed cb).
  virtual void Close() = 0;

  virtual zx_status_t Send(const void* data, size_t len) {
    return Send(data, len, nullptr);
  }

  virtual const zx::socket& socket() = 0;

  // Creates an EthertapClient with given configuration.
  // A null reference will be returned if the client can't be created.
  static std::unique_ptr<EthertapClient> Create(
      const EthertapConfig& config, async_dispatcher_t* dispatcher = nullptr);
};

}  // namespace netemul

#endif  // LIB_NETEMUL_NETWORK_ETHERTAP_CLIENT_H_