ResponseHandler.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2015-present, Facebook, Inc.
 *  All rights reserved.
 *
 *  This source code is licensed under the BSD-style license found in the
 *  LICENSE file in the root directory of this source tree. An additional grant
 *  of patent rights can be found in the PATENTS file in the same directory.
 *
 */
#pragma once

#include <proxygen/lib/http/session/HTTPTransaction.h>

namespace proxygen {

class ExMessageHandler;
class RequestHandler;
class PushHandler;

class ResponseHandler {
 public:
  explicit ResponseHandler(RequestHandler* upstream)
      : upstream_(CHECK_NOTNULL(upstream)) {
  }

  virtual ~ResponseHandler() {}

  virtual void sendHeaders(HTTPMessage& msg) noexcept = 0;

  virtual void sendChunkHeader(size_t len) noexcept = 0;

  virtual void sendBody(std::unique_ptr<folly::IOBuf> body) noexcept = 0;

  virtual void sendChunkTerminator() noexcept = 0;

  virtual void sendEOM() noexcept = 0;

  virtual void sendAbort() noexcept = 0;

  virtual void refreshTimeout() noexcept = 0;

  virtual void pauseIngress() noexcept = 0;

  virtual void resumeIngress() noexcept = 0;

  virtual ResponseHandler* newPushedResponse(
    PushHandler* pushHandler) noexcept = 0;

  virtual ResponseHandler* newExMessage(ExMessageHandler* /*exHandler*/,
                                        bool /*unidirectional*/ = false)
      noexcept {
    LOG(FATAL) << "newExMessage not supported";
  }

  // Accessors for Transport/Connection information
  virtual const wangle::TransportInfo& getSetupTransportInfo() const
      noexcept = 0;

  virtual void getCurrentTransportInfo(wangle::TransportInfo* tinfo) const = 0;

  HTTPTransaction* getTransaction() const noexcept {
    return txn_;
  }

 protected:
  RequestHandler* upstream_{nullptr};
  HTTPTransaction* txn_{nullptr};
};

}