Poll.hpp

Go to the documentation of this file.

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
 
#pragma once
 
#include <functional>
#include <memory>
 
#include <uv.h>
 
#include "wpi/net/uv/Handle.hpp"
#include "wpi/util/Signal.h"
 
namespace wpi::net::uv {
 
class Loop;
 
/**
 * Poll handle.
 */
class Poll final : public HandleImpl<Poll, uv_poll_t> {
  struct private_init {};
 
 public:
  explicit Poll(const private_init&) {}
  ~Poll() noexcept override = default;
 
  /**
   * Create a poll handle using a file descriptor.
   *
   * @param loop Loop object where this handle runs.
   * @param fd File descriptor.
   */
  static std::shared_ptr<Poll> Create(Loop& loop, int fd);
 
  /**
   * Create a poll handle using a file descriptor.
   *
   * @param loop Loop object where this handle runs.
   * @param fd File descriptor.
   */
  static std::shared_ptr<Poll> Create(const std::shared_ptr<Loop>& loop,
                                      int fd) {
    return Create(*loop, fd);
  }
 
  /**
   * Create a poll handle using a socket descriptor.
   *
   * @param loop Loop object where this handle runs.
   * @param sock Socket descriptor.
   */
  static std::shared_ptr<Poll> CreateSocket(Loop& loop, uv_os_sock_t sock);
 
  /**
   * Create a poll handle using a socket descriptor.
   *
   * @param loop Loop object where this handle runs.
   * @param sock Socket descriptor.
   */
  static std::shared_ptr<Poll> CreateSocket(const std::shared_ptr<Loop>& loop,
                                            uv_os_sock_t sock) {
    return CreateSocket(*loop, sock);
  }
 
  /**
   * Reuse this handle.  This closes the handle, and after the close completes,
   * reinitializes it (identically to Create) and calls the provided callback.
   * Unlike Close(), it does NOT emit the closed signal, however, IsClosing()
   * will return true until the callback is called.  This does nothing if
   * IsClosing() is true (e.g. if Close() was called).
   *
   * @param fd File descriptor
   * @param callback Callback
   */
  void Reuse(int fd, std::function<void()> callback);
 
  /**
   * Reuse this handle.  This closes the handle, and after the close completes,
   * reinitializes it (identically to CreateSocket) and calls the provided
   * callback.  Unlike Close(), it does NOT emit the closed signal, however,
   * IsClosing() will return true until the callback is called.  This does
   * nothing if IsClosing() is true (e.g. if Close() was called).
   *
   * @param sock Socket descriptor.
   * @param callback Callback
   */
  void ReuseSocket(uv_os_sock_t sock, std::function<void()> callback);
 
  /**
   * Start polling the file descriptor.
   *
   * @param events Bitmask of events (UV_READABLE, UV_WRITEABLE, UV_PRIORITIZED,
   *               and UV_DISCONNECT).
   */
  void Start(int events);
 
  /**
   * Stop polling the file descriptor.
   */
  void Stop() { Invoke(&uv_poll_stop, GetRaw()); }
 
  /**
   * Signal generated when a poll event occurs.
   */
  wpi::util::sig::Signal<int> pollEvent;
 
 private:
  struct ReuseData {
    std::function<void()> callback;
    bool isSocket;
    int fd;
    uv_os_sock_t sock;
  };
  std::unique_ptr<ReuseData> m_reuseData;
};
 
}  // namespace wpi::net::uv