mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-07-03 03:01:44 +00:00
8f1f64ffb6
Also update copyright to include "and other WPILib contributors" and clarify license referral language to not be restricted to FIRST teams.
60 lines
1.5 KiB
C++
60 lines
1.5 KiB
C++
// 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.
|
|
|
|
#ifndef WPIUTIL_WPI_PORTFORWARDER_H_
|
|
#define WPIUTIL_WPI_PORTFORWARDER_H_
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
|
|
#include "wpi/Twine.h"
|
|
|
|
namespace wpi {
|
|
|
|
/**
|
|
* Forward ports to another host. This is primarily useful for accessing
|
|
* Ethernet-connected devices from a computer tethered to the RoboRIO USB port.
|
|
*/
|
|
class PortForwarder {
|
|
public:
|
|
PortForwarder(const PortForwarder&) = delete;
|
|
PortForwarder& operator=(const PortForwarder&) = delete;
|
|
|
|
/**
|
|
* Get an instance of the PortForwarder class.
|
|
*
|
|
* This is a singleton to guarantee that there is only a single instance
|
|
* regardless of how many times GetInstance is called.
|
|
*/
|
|
static PortForwarder& GetInstance();
|
|
|
|
/**
|
|
* Forward a local TCP port to a remote host and port.
|
|
* Note that local ports less than 1024 won't work as a normal user.
|
|
*
|
|
* @param port local port number
|
|
* @param remoteHost remote IP address / DNS name
|
|
* @param remotePort remote port number
|
|
*/
|
|
void Add(unsigned int port, const Twine& remoteHost, unsigned int remotePort);
|
|
|
|
/**
|
|
* Stop TCP forwarding on a port.
|
|
*
|
|
* @param port local port number
|
|
*/
|
|
void Remove(unsigned int port);
|
|
|
|
private:
|
|
PortForwarder();
|
|
|
|
struct Impl;
|
|
std::unique_ptr<Impl> m_impl;
|
|
};
|
|
|
|
} // namespace wpi
|
|
|
|
#endif // WPIUTIL_WPI_PORTFORWARDER_H_
|