lib/cpp11api/ts-cpp11.h

/** @file
 @section license License

 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.
 */

#ifndef TS_CPP11_H_
#define TS_CPP11_H_

#ifndef __GXX_EXPERIMENTAL_CXX0X__
#error The C++ Apache Traffic Server API wrapper requires C++11 support.
#endif

#include <functional>
#include <string>
#include <vector>
#include "ts-cpp11-headers.h"

namespace ats {
namespace api {
typedef std::vector<std::string> StringVector;

enum class HookType {
  HOOK_PRE_REMAP = 100,
  HOOK_POST_REMAP,
  HOOK_READ_RESPONSE_HEADERS,
  HOOK_READ_REQUEST_HEADERS,
  HOOK_SEND_RESPONSE_HEADERS,
  HOOK_TRANSACTION_START,
  HOOK_TRANSACTION_END
};

enum class NextState {
  HTTP_CONTINUE = 200, HTTP_ERROR, HTTP_DONT_CONTINUE
};

class Transaction;

/*
 * This is the type our global hook callbacks will take
 */
typedef std::function<NextState(Transaction &)> GlobalHookCallback;

/*
 * Create a new hook
 */
void CreateGlobalHook(HookType, GlobalHookCallback);
void CreateTransactionHook(Transaction &, HookType, GlobalHookCallback);

std::string GetRequestUrl(Transaction &);
std::string GetPristineRequestUrl(Transaction &);
std::string GetRequestUrlPath(Transaction &);
std::string GetPristineRequestUrlPath(Transaction &);
void SetRequestUrlPath(Transaction &, const std::string &);
std::string GetRequestUrlQuery(Transaction &);
std::string GetPristineRequestUrlQuery(Transaction &);
void SetRequestUrlQuery(Transaction &, const std::string &);
std::string GetRequestUrlHost(Transaction &);
std::string GetPristineRequestUrlHost(Transaction &);
void SetRequestUrlHost(Transaction &, const std::string &);
std::string GetRequestUrlScheme(Transaction &);
std::string GetPristineRequestUrlScheme(Transaction &);
void SetRequestUrlScheme(Transaction &, const std::string &);
unsigned int GetRequestUrlPort(Transaction &);
unsigned int GetPristineRequestUrlPort(Transaction &);
void SetRequestUrlPort(Transaction &, unsigned int);
std::string GetClientIP(Transaction &);
unsigned int GetClientPort(Transaction &);
std::string GetServerIncomingIP(Transaction &);
unsigned int GetServerIncomingPort(Transaction &);
std::string GetRequestMethod(Transaction &t);
void SetRequestMethod(Transaction &t, const std::string &);
int GetServerResponseStatusCode(Transaction &t);
bool IsInternalRequest(Transaction &);
void* GetTransactionIdentifier(Transaction &);
void ReenableTransaction(Transaction &, NextState);

/* headers */
// TODO: Switch these out to deal with shared_ptrs to a HeaderVector
namespace headers {
HeaderVector GetClientRequestHeaders(Transaction &);
HeaderVector GetClientResponseHeaders(Transaction &);
HeaderVector GetServerResponseHeaders(Transaction &);
Header GetClientRequestHeader(Transaction &, const std::string &);
Header GetClientResponseHeader(Transaction &, const std::string &);
Header GetServerResponseHeader(Transaction &, const std::string &);
void DeleteClientRequestHeader(Transaction &, const std::string &);
void DeleteClientResponseHeader(Transaction &, const std::string &);
void DeleteServerResponseHeader(Transaction &, const std::string &);
void SetClientRequestHeader(Transaction &, const std::string &, const std::vector<std::string> &);
void SetClientResponseHeader(Transaction &, const std::string &, const std::vector<std::string> &);
void SetServerResponseHeader(Transaction &, const std::string &, const std::vector<std::string> &);
void SetClientRequestHeader(Transaction &, const std::string &, const std::string &);
void SetClientResponseHeader(Transaction &, const std::string &, const std::string &);
void SetServerResponseHeader(Transaction &, const std::string &, const std::string &);
void AppendClientRequestHeader(Transaction &, const std::string &, const std::vector<std::string> &);
void AppendClientResponseHeader(Transaction &, const std::string &, const std::vector<std::string> &);
void AppendServerResponseHeader(Transaction &, const std::string &, const std::vector<std::string> &);
void AppendClientRequestHeader(Transaction &, const std::string &, const std::string &);
void AppendClientResponseHeader(Transaction &, const std::string &, const std::string &);
void AppendServerResponseHeader(Transaction &, const std::string &, const std::string &);
} /* headers */

} /* api */
} /* ats */

/*
 * Every plugin must have a simple entry point
 */
void PluginRegister(const ats::api::StringVector &);

#endif /* TS_CPP11_H_ */