| /** |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| */ |
| |
| /** |
| * @file InterceptPlugin.h |
| */ |
| |
| #pragma once |
| |
| #include <string> |
| #include "tscpp/api/Transaction.h" |
| #include "tscpp/api/TransactionPlugin.h" |
| |
| namespace atscppapi |
| { |
| /** |
| * Allows a plugin to act as a server and return the response. This |
| * plugin can be created in read request headers hook (pre or post |
| * remap). |
| */ |
| class InterceptPlugin : public TransactionPlugin |
| { |
| protected: |
| /** |
| * The available types of intercepts. |
| */ |
| enum Type { |
| SERVER_INTERCEPT = 0, /**< Plugin will act as origin */ |
| TRANSACTION_INTERCEPT /**< Plugin will act as cache and origin (on cache miss) */ |
| }; |
| |
| /** a plugin must implement this interface, it cannot be constructed directly */ |
| InterceptPlugin(Transaction &transaction, Type type); |
| |
| public: |
| enum RequestDataType { |
| REQUEST_HEADER = 0, |
| REQUEST_BODY, |
| }; |
| |
| /** |
| * A method that you must implement when writing an InterceptPlugin, this method will be |
| * invoked whenever client request data is read. |
| */ |
| virtual void consume(const std::string &data, RequestDataType type) = 0; |
| |
| /** |
| * A method that you must implement when writing an InterceptPlugin, this method |
| * will be invoked when the client request is deemed complete. |
| */ |
| virtual void handleInputComplete() = 0; |
| |
| /** Should be called only after request header has completely been consumed */ |
| Headers &getRequestHeaders(); |
| |
| /** |
| * The returned TSSslConnection would be nullptr if the connection is not a TLS connection |
| * or Intercept plugin is not ready. |
| */ |
| TSSslConnection getSslConnection(); |
| |
| ~InterceptPlugin() override; |
| |
| struct State; /** Internal use only */ |
| |
| protected: |
| /** |
| * This method is how an InterceptPlugin will send output back to |
| * the client. |
| */ |
| bool produce(const void *data, int data_size); |
| |
| bool |
| produce(const std::string &data) |
| { |
| return produce(data.data(), data.size()); |
| } |
| |
| bool setOutputComplete(); |
| |
| private: |
| State *state_; |
| |
| bool doRead(); |
| void handleEvent(int, void *); |
| |
| friend class utils::internal; |
| }; |
| |
| } // namespace atscppapi |