proxygen::ScopedHTTPServer Class Reference

#include <ScopedHTTPServer.h>

Public Member Functions
int	getPort () const
std::vector< HTTPServer::IPConfig >	getAddresses () const
	~ScopedHTTPServer ()

Static Public Member Functions
template<typename HandlerType >
static std::unique_ptr< ScopedHTTPServer >	start (HandlerType handler, int port=0, int numThreads=4, std::unique_ptr< wangle::SSLContextConfig > sslCfg=nullptr)
static std::unique_ptr< ScopedHTTPServer >	start (HTTPServer::IPConfig cfg, HTTPServerOptions options)

Private Member Functions
	ScopedHTTPServer (std::thread thread, std::unique_ptr< HTTPServer > server)

Private Attributes
std::thread	thread_
std::unique_ptr< HTTPServer >	server_

Detailed Description

A basic server that can be used for testing http clients. Since most such servers are short lived, this server takes care of starting and stopping automatically.

Definition at line 88 of file ScopedHTTPServer.h.

Constructor & Destructor Documentation

proxygen::ScopedHTTPServer::~ScopedHTTPServer ( )

inline

Definition at line 124 of file ScopedHTTPServer.h.

                      {
    server_->stop();
    thread_.join();
  }

proxygen::ScopedHTTPServer::ScopedHTTPServer ( std::thread  thread, std::unique_ptr< HTTPServer >  server  )

inlineprivate

Definition at line 130 of file ScopedHTTPServer.h.

      : thread_(std::move(thread)),
        server_(std::move(server)) {
  }

Member Function Documentation

std::vector<HTTPServer::IPConfig> proxygen::ScopedHTTPServer::getAddresses ( ) const

inline

Get the addresses for the server.

Definition at line 118 of file ScopedHTTPServer.h.

                                                     {
    auto addresses = server_->addresses();
    CHECK(!addresses.empty());
    return addresses;
  }

int proxygen::ScopedHTTPServer::getPort ( ) const

inline

Get the port the server is listening on. This is helpful if the port was randomly chosen.

Definition at line 111 of file ScopedHTTPServer.h.

                      {
    return getAddresses()[0].address.getPort();
  }

template<typename HandlerType >

std::unique_ptr< ScopedHTTPServer > proxygen::ScopedHTTPServer::start ( HandlerType  handler, int  port = 0, int  numThreads = 4, std::unique_ptr< wangle::SSLContextConfig >  sslCfg = nullptr  )

inlinestatic

Start a server listening on the requested port. If port is 0, it will choose a random port.

Definition at line 141 of file ScopedHTTPServer.h.

References f, handler(), folly::gen::move, and start.

                                                  {

  std::unique_ptr<RequestHandlerFactory> f =
      std::make_unique<ScopedHandlerFactory<HandlerType>>(handler);
  return start(std::move(f), port, numThreads, std::move(sslCfg));
}

std::unique_ptr< ScopedHTTPServer > proxygen::ScopedHTTPServer::start ( HTTPServer::IPConfig  cfg, HTTPServerOptions  options  )

inlinestatic

Start a server listening with the requested IPConfig and server opts

Definition at line 179 of file ScopedHTTPServer.h.

References folly::gen::move, folly::setThreadName(), and folly::pushmi::detail::t.

                               {

  std::vector<HTTPServer::IPConfig> IPs = { std::move(cfg) };

  auto server = std::make_unique<HTTPServer>(std::move(options));
  server->bind(IPs);

  // Start the server
  std::exception_ptr eptr;
  auto barrier = std::make_shared<boost::barrier>(2);

  std::thread t = std::thread([&, barrier] () {
    server->start(
      [&, barrier] () {
        folly::setThreadName("http-acceptor");
        barrier->wait();
      },
      [&, barrier] (std::exception_ptr ex) {
        eptr = ex;
        barrier->wait();
      });
    });

  // Wait for server to start
  barrier->wait();
  if (eptr) {
    t.join();

    std::rethrow_exception(eptr);
  }

  return std::unique_ptr<ScopedHTTPServer>(
      new ScopedHTTPServer(std::move(t), std::move(server)));
}

Member Data Documentation

std::unique_ptr<HTTPServer> proxygen::ScopedHTTPServer::server_

private

Definition at line 137 of file ScopedHTTPServer.h.

std::thread proxygen::ScopedHTTPServer::thread_

private

Definition at line 136 of file ScopedHTTPServer.h.

---

The documentation for this class was generated from the following file:

• proxygen/httpserver/ScopedHTTPServer.h