diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..7c264a5e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contribute +- Fork the project. +- Make your feature addition or bug fix. +- Add tests for it. This is important so I don't break it in a future version + unintentionally. +- Commit, do not mess with version +- If you add functionality, document it in the README +- Send me a pull request. Bonus points for topic branches. + +## How to run tests + +Since most of the tests are actually integration tests you will need to have a +working docker setup to make the full test suite pass. gtest build requires python 2 :( + +1. build vendorized gtest: `./utils/build_gtest.sh` +1. build restclient-cpp: `./autogen.sh && ./configure && make check` +1. ensure you have cpplint available `pip install cpplint` +1. run the unit test suite: `make ci` + +## Help wanted +Given that I'm not in a position to maintain compatibility with all the different +platforms, contributions around these are especially appreciated. I try to label +issues accordingly. Some examples are: +- [windows support](https://github.com/mrtazz/restclient-cpp/labels/windows) +- [debian build problems](https://github.com/mrtazz/restclient-cpp/labels/debian) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..b6cd9d74 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +### Expected behaviour + +### Actual behaviour +### Environment and debugging details + +- compiler and version +- operating system +- version of restclient-cpp +- how did you install restclient-cpp? (via packages, git, tarball) +- libcurl version and compile flags +- full error output of your build as an inline codeblock or gist + +(some of these things might not apply but the more you can provide the easier +it will be to fix this bug. Thanks!) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..f4d4e3fd --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +## Checklist +Not all of these might apply to your change but the more you are able to check +the easier it will be to get your contribution merged. + +- [ ] CI passes +- [ ] Description of proposed change +- [ ] Documentation (README, code doc blocks, etc) is updated +- [ ] Existing issue is referenced if there is one +- [ ] Unit tests for the proposed change diff --git a/.github/workflows/analysis.yaml b/.github/workflows/analysis.yaml new file mode 100644 index 00000000..aa23de7b --- /dev/null +++ b/.github/workflows/analysis.yaml @@ -0,0 +1,51 @@ +name: analysis + +on: + workflow_dispatch: + pull_request: + types: [opened, synchronize] + + +jobs: + cpplint: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: install dependencies + run: | + pip install cpplint + sudo apt-get update + sudo apt-get install -qq valgrind libcurl4-openssl-dev + + - name: build + run: | + ./autogen.sh + ./configure --enable-coverage + + - name: run cpplint + run: make lint + + valgrind: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: install dependencies + run: | + pip install cpplint + sudo apt-get update + sudo apt-get install -qq valgrind libcurl4-openssl-dev + + - name: build googletest + run: ./utils/build_gtest.sh + + - name: build + run: | + ./autogen.sh + ./configure --enable-coverage + + - name: run valgrind + run: make valgrind diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml new file mode 100644 index 00000000..5aed7305 --- /dev/null +++ b/.github/workflows/tests.yaml @@ -0,0 +1,32 @@ +name: test + +on: + workflow_dispatch: + pull_request: + types: [opened, synchronize] + + +jobs: + unit: + name: unit + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: install dependencies + run: | + pip install cpplint + sudo apt-get update + sudo apt-get install -qq valgrind libcurl4-openssl-dev + + - name: build googletest + run: ./utils/build_gtest.sh + + - name: build + run: | + ./autogen.sh + ./configure --enable-coverage + + - name: run tests + run: make test diff --git a/.gitignore b/.gitignore index fbbb1ef1..2465c5a5 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,11 @@ config* *aclocal.m4 *Makefile *Makefile.in -vendor/gtest-1.7.0/scripts/gtest-config +vendor/* +test-program +.libs + +restclient-cpp.pc *autom4te.cache *aclocal.m4 @@ -21,3 +25,18 @@ vendor/gtest-1.7.0/scripts/gtest-config *.dirstamp *ltmain.sh m4 + +# coverage related files +*gcda +*gcno +html +coverage.info + +# packaging +*.rpm +*.deb +usr + +# generated files +include/restclient-cpp/version.h +arm-poky-linux-gnueabi-libtool diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..79ab4b5f --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "docs/_layouts"] + path = docs/_layouts + url = https://github.com/mrtazz/jekyll-layouts.git diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index b790b6d9..00000000 --- a/.travis.yml +++ /dev/null @@ -1,6 +0,0 @@ -language: cpp -# command to install dependencies -script: ./autogen.sh && ./configure && make check && ./test-program -before_script: - - sudo apt-get install libcurl4-openssl-dev build-essential - - ./utils/build_gtest.sh diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b45b9bf..e6dcb4db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,128 @@ # Changelog +## v0.5.3 (2nd January 2025) +- add unit test actions workflow (mrtazz) +- Fix missing cstdint include (williamspatrick) +- init Connection::curlErrorBuf[] at compile (montdidier) +- Added Mingw Instructions (CypherpunkSamurai) +- [docs] use correct json mime type in example (aknoerig) +- Allow SSL peer verification to be disabled. (edwinpjacques) +- write callback and termination API (edwinpjacques) +- These two lines allow the scope of the property for the public (Vi1i) +- User/shawkins/improve curl errors (Spencatro) +- Add vcpkg installation instructions (PhoebeHui) +- update linux package builds (mrtazz) + +## v0.5.2 (12th February 2020) +- add a pkg-config setup +- Use the standard CMake-flag BUILD_SHARED_LIBS. (tastytea) +- Add CURL and Threads as dependency in CMake config. (tastytea) +- Replace hardcoded installation directories with GNUInstallDirs. (tastytea) +- Set minimum CMake version to 3.12.0 (tastytea) +- Added default compile type to CMakeLists.txt (Jorge Marizan) +- Added configurable compile type to CMakeLists.txt (Jorge Marizan) +- use lambda over ptr_fun (Cynthia Coan) +- mac os x uses glibtoolize not libtoolize (Cynthia Coan) +- Use std::make_unique when C++14 is available (Heikki Hellgren) +- fix git version problems during yocto build (Giuseppe Ursino) +- fix autogen to work with yocto (Giuseppe Ursino) +- fix relative path issues (Giuseppe Ursino) +- Added support for Unix sockets. (Dennis Jenkins) +- update CI dist to xenial (Daniel Schauenberg) + +## v0.5.1 (6th May 2019) +- add initial cmake build +- switch httpbin tests over to https + +## v0.5.0 (31st October 2018) + +### Features +* Add PATCH and OPTIONS methods (#106) (drodil) +* Add support for limiting the number of redirects (Bas van Kervel) +* Added web proxy tunneling support. (amzoughi) +* add client cert & key support (Fan Zhang) +* add HEAD method (limhyungseok) +* no-signal capability (Chris Kruger) + +### Improvements and fixes +* Remove duplicate FollowRedirects function (#109) (drodil) +* Changed content type to application/json (Hajder Rabiee) +* fix link to CONTRIBUTING guidelines (Daniel Schauenberg) +* update distro repositories to push packages to (Daniel Schauenberg) +* fix isspace is not a member of std with Visual Studio 2017 (Yoann Long) +* add CODE_OF_CONDUCT.md (Daniel Schauenberg) +* fix linter error for redundant blank line (Daniel Schauenberg) +* remove unneeded curl include in restclient.h (Daniel Schauenberg) +* Make SetProxy behave like curl's CURLOPT_PROXY (Daniel Schauenberg) +* change prefixed address for proxy to HTTP (Daniel Schauenberg) +* add unit test for http2 connection (Daniel Schauenberg) +* move docker setup into Makefile (Daniel Schauenberg) +* update CONTRIBUTING docs with proxy server details (Daniel Schauenberg) +* add proxy server as docker service (Daniel Schauenberg) +* default to 10s timeout in unit tests (Daniel Schauenberg) +* update docs for HTTPS user certificate feature (Daniel Schauenberg) +* add .github folder with issue/PR templates (Daniel Schauenberg) +* move CI to run on travis trusty beta (Daniel Schauenberg) +* Small optimizations (Martin Gerhardy) +* Fix -Wpedantic warning (Daniel Perez) +* fix README examples for conn->post, conn->put (Daniel Schauenberg) +* add OSX install instructions to README (Daniel Schauenberg) + +## v0.4.4 (13th May 2016) +- bump version because v0.4.3 was mistagged + +## v0.4.3 (13th May 2016) +- only release packages from gcc builds (Daniel Schauenberg) + +## v0.4.2 (13th May 2016) +- add an ldconfig script to package builds (Daniel Schauenberg) +- Add option to set the Certificate Authority (CA) Info option. (tgoetze) +- add clang to the travis build matrix (Daniel Schauenberg) +- README: Update Advanced Example (Marc Zych) +- Connection: Initialize timeout and followRedirects (Marc Zych) + +## v0.4.1 (2nd February 2016) +- fix package build to include new header files from refactoring + +## v0.4.0 (2nd February 2016) + +### Features +**This is a major backwards-incompatible API refactor please read carefully** + +- split out into a simple and an advanced API + - simple API via static methods + - advanced usage via a connection object +- support for custom user agent strings +- support for connection pooling and keep-alive +- support for following redirects +- support for getting request metrics from the Connection object + +### Improvements and fixes +- increased test coverage +- addition of valgrind and lint runs on CI +- fixed some memory leaks +- improved documentation coverage + + +## v0.3.0 (10th January 2016) + +### Features +- added support for connection timeouts (Islam Yasar) +- Allow for setting additional HTTP headers (Karol Samborski) + +### Improvements and Bug fixes +- improve general documentation and add docs for auth (Daniel Schauenberg) +- remove calls to curl_global_cleanup (Daniel Schauenberg) +- add unit test for basic auth (Daniel Schauenberg) +- switch unit tests to use [http://httpbin.org]() (Daniel Schauenberg) +- move two include instructions (Jos) +- added reporting for test coverage (Daniel Schauenberg) +- cleanup version gen to be driven by git tags (Daniel Schauenberg) +- clean up build and support building on FreeBSD (Daniel Schauenberg) +- automate package deployment to packagecloud (Daniel Schauenberg) +- add automatic doc build & deploy (Daniel Schauenberg) +- Ensure the built shared library does not have dynamic references to libgtest (Thomas Goetze) + ## v0.2.0 (19th April 2015) - support basic auth - Add header's to response object diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 00000000..50db3f9c --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,177 @@ + +cmake_minimum_required(VERSION 3.12.0) + +project(restclient-cpp + VERSION 0.5.3 + DESCRIPTION "REST client for C++" + HOMEPAGE_URL "http://code.mrtazz.com/restclient-cpp" +) +set(restclient-cpp_VENDOR "d@unwiredcouch.com") +set(PROJECT_VENDOR "${restclient-cpp_VENDOR}") + +message(STATUS "Configured for: ${CMAKE_BUILD_TYPE}") +add_custom_target(BeginMessage ALL + ${CMAKE_COMMAND} -E cmake_echo_color --white "Compiling for: $" + COMMENT "Compile Info" ) + +set(CMAKE_DEBUG_POSTFIX d) + +set(CMAKE_CXX_STANDARD 11) + +list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/modules") + + +if(POLICY CMP0074) + cmake_policy(SET CMP0074 NEW) +endif() + +include(CheckIncludeFiles) + +find_package(GTest) +if(GTEST_FOUND) +set(Gtest_FOUND TRUE) +endif() +if(GTest_FOUND) +include(GoogleTest) +endif() + +find_package(Threads REQUIRED) +find_package(CURL REQUIRED) +find_package(jsoncpp) + +option(BUILD_SHARED_LIBS "Build shared library." YES) +if(COMPILE_TYPE STREQUAL "SHARED") + set(BUILD_SHARED_LIBS YES) +endif() + +add_library(restclient-cpp + source/restclient.cc + source/connection.cc + source/helpers.cc +) +set_property(TARGET restclient-cpp PROPERTY SOVERSION 2.1.1) + +target_compile_features(restclient-cpp PUBLIC cxx_std_11) + +list(APPEND restclient-cpp_PUBLIC_HEADERS + include/restclient-cpp/restclient.h + "${CMAKE_CURRENT_BINARY_DIR}/include/restclient-cpp/version.h" + include/restclient-cpp/connection.h + include/restclient-cpp/helpers.h +) +# target_sources(restclient-cpp PRIVATE ${restclient-cpp_PUBLIC_HEADERS}) +set_property(TARGET restclient-cpp PROPERTY + PUBLIC_HEADER ${restclient-cpp_PUBLIC_HEADERS}) +target_include_directories(restclient-cpp + PRIVATE include + PUBLIC $ + PUBLIC $ +) + +if(NOT EXISTS "${CMAKE_CURRENT_BINARY_DIR}/version.h.in") +file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/version.h.in" [=[ +#ifndef INCLUDE_RESTCLIENT_CPP_VERSION_H_ +#define INCLUDE_RESTCLIENT_CPP_VERSION_H_ +#define RESTCLIENT_VERSION "@restclient-cpp_VERSION@" +#endif // INCLUDE_RESTCLIENT_CPP_VERSION_H_ +]=]) +endif() +configure_file("${CMAKE_CURRENT_BINARY_DIR}/version.h.in" + "${CMAKE_CURRENT_BINARY_DIR}/include/restclient-cpp/version.h") +target_include_directories(restclient-cpp PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/include") + +target_link_libraries(restclient-cpp + PUBLIC CURL::libcurl + PUBLIC Threads::Threads +) + +include(GNUInstallDirs) +set(INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_INCLUDEDIR}/restclient-cpp" ) +set(CONFIG_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/restclient-cpp" ) +set(RUNTIME_INSTALL_DIR "${CMAKE_INSTALL_BINDIR}" ) +set(LIB_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}" ) +set(DATA_INSTALL_DIR "${CMAKE_INSTALL_DATADIR}/restclient-cpp" ) + +install(TARGETS restclient-cpp EXPORT restclient-cppTargets + PUBLIC_HEADER DESTINATION ${INCLUDE_INSTALL_DIR} + RUNTIME DESTINATION ${RUNTIME_INSTALL_DIR} + LIBRARY DESTINATION ${LIB_INSTALL_DIR} + ARCHIVE DESTINATION ${LIB_INSTALL_DIR} + RESOURCE DESTINATION ${DATA_INSTALL_DIR} +) + +include(CMakePackageConfigHelpers) +file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake.in" + "@PACKAGE_INIT@\n" + "include(CMakeFindDependencyMacro)\n" + "find_dependency(CURL REQUIRED)\n" + "find_dependency(Threads REQUIRED)\n" + "include(\${CMAKE_CURRENT_LIST_DIR}/\@PROJECT_NAME\@Targets.cmake)\n") +configure_package_config_file( + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake.in + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake + INSTALL_DESTINATION + ${CMAKE_INSTALL_PREFIX}/${CONFIG_INSTALL_DIR} + PATH_VARS + INCLUDE_INSTALL_DIR + CONFIG_INSTALL_DIR + RUNTIME_INSTALL_DIR + LIB_INSTALL_DIR + DATA_INSTALL_DIR +) + +write_basic_package_version_file( + "${CMAKE_CURRENT_BINARY_DIR}/restclient-cppConfigVersion.cmake" + COMPATIBILITY + SameMajorVersion +) + +# export targets for find_package config mode +install(EXPORT restclient-cppTargets DESTINATION ${CONFIG_INSTALL_DIR}) + +install( + FILES + ${CMAKE_CURRENT_BINARY_DIR}/restclient-cppConfig.cmake + ${CMAKE_CURRENT_BINARY_DIR}/restclient-cppConfigVersion.cmake + DESTINATION + ${CMAKE_INSTALL_PREFIX}/${CONFIG_INSTALL_DIR} +) + +if(Gtest_FOUND AND jsoncpp_FOUND) + +enable_testing() + + +add_executable(test-program + vendor/jsoncpp-0.10.5/dist/jsoncpp.cpp + test/tests.cpp + test/test_restclient.cc + test/test_connection.cc + test/test_helpers.cc +) +target_include_directories(test-program + PRIVATE include + PRIVATE vendor/jsoncpp-0.10.5/dist + PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/include") + +target_link_libraries(test-program + PUBLIC restclient-cpp + PUBLIC GTest::GTest +) +gtest_discover_tests(test-program + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} + EXTRA_ARGS -VV +) + +endif() + + +# TODO: Setup ctest here for valgrind and CI + +# TODO: Setup cpack here for automatic packaging. +# Note most of the work is already done above due to use of properties and install commands. + +include(FeatureSummary) +feature_summary(WHAT ALL) + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..b7df4e3b --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at coc@unwiredcouch.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 376c4355..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,7 +0,0 @@ -# Contribute -- Fork the project. -- Make your feature addition or bug fix. -- Add tests for it. This is important so I don't break it in a future version - unintentionally. -- Commit, do not mess with version -- Send me a pull request. Bonus points for topic branches. diff --git a/Makefile.am b/Makefile.am index cb52323a..d00c7463 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,13 +1,65 @@ ACLOCAL_AMFLAGS=-I m4 -CPPFLAGS=-Iinclude -Ivendor/gtest-1.7.0/include +CPPFLAGS=-I${top_srcdir}/include check_PROGRAMS = test-program -pkginclude_HEADERS = include/restclient-cpp/restclient.h include/restclient-cpp/meta.h +pkginclude_HEADERS = include/restclient-cpp/restclient.h include/restclient-cpp/version.h include/restclient-cpp/connection.h include/restclient-cpp/helpers.h +BUILT_SOURCES = include/restclient-cpp/version.h -test_program_SOURCES = test/test_restclient_delete.cpp test/test_restclient_get.cpp test/test_restclient_post.cpp test/test_restclient_put.cpp test/tests.cpp +test_program_SOURCES = vendor/jsoncpp-0.10.5/dist/jsoncpp.cpp test/tests.cpp test/test_helpers.cc test/test_restclient.cc test/test_connection.cc test_program_LDADD = .libs/librestclient-cpp.a -test_program_LDFLAGS=-Lvendor/gtest-1.7.0/lib/.libs -lgtest +test_program_LDFLAGS=-Lvendor/googletest-1.14.0/lib -lgtest +test_program_CPPFLAGS=-std=c++14 -Iinclude -Ivendor/googletest-1.14.0/googletest/include -Ivendor/jsoncpp-0.10.5/dist lib_LTLIBRARIES=librestclient-cpp.la -librestclient_cpp_la_SOURCES=source/restclient.cpp -librestclient_cpp_la_CXXFLAGS=-fPIC -librestclient_cpp_la_LDFLAGS=-version-info 1:0:1 +librestclient_cpp_la_SOURCES=source/restclient.cc source/connection.cc source/helpers.cc +librestclient_cpp_la_CXXFLAGS=-fPIC -std=c++14 +librestclient_cpp_la_LDFLAGS=-version-info 2:1:1 + +dist_doc_DATA = README.md + +.PHONY: test check clean-coverage-files coverage-html include/restclient-cpp/version.h lint ci docker-services clean-docker-services + +include/restclient-cpp/version.h: + m4 -I ${top_srcdir}/m4 -DM4_RESTCLIENT_VERSION=$(PACKAGE_VERSION) version.h.m4 > ${top_srcdir}/$@ + + + +test: check docker-services + ./test-program + +valgrind: check docker-services + valgrind --leak-check=full --error-exitcode=1 ./test-program + +# Filter reasons: +# legal/copyright: it's just maintenance overhead to have license headers +# in all files +# whitespace/indent_namespace: it makes code less readable if indentations +# in namespaces are not allowed +lint: + cpplint --filter="-legal/copyright,-whitespace/indent_namespace" --root=$(CURDIR) include/restclient-cpp/*.h source/*.cc + +docker-services: + [ -n "$$(docker ps --quiet --filter name=restclient-cpp-httpbin)" ] || \ + docker run --detach -p 8998:80 --name restclient-cpp-httpbin kennethreitz/httpbin + [ -n "$$(docker ps --quiet --filter name=restclient-cpp-squid)" ] || \ + docker run --detach -p 3128:3128 --name restclient-cpp-squid \ + --volume "$(CURDIR)/test/squid.conf:/etc/squid/squid.conf:ro" sameersbn/squid:3.5.27-2 + docker ps --all --filter 'name=^restclient-cpp-' + +clean-docker-services: + docker rm --force restclient-cpp-httpbin 2>/dev/null || true + docker rm --force restclient-cpp-squid 2>/dev/null || true + +clean-local: + find . -name "*.gcda" -print0 | xargs -0 rm + +coverage.info: test + lcov --compat-libtool --capture --directory source --output-file coverage.info + lcov --compat-libtool --remove coverage.info "/usr*" -o coverage.info + +coverage-html: coverage.info + genhtml -t "restclient-cpp coverage report" --legend --show-details coverage.info --output-directory html + +# include other make targets in the main Makefile +include $(srcdir)/Makefile.packaging.mk +include $(srcdir)/Makefile.docs.mk + diff --git a/Makefile.docs.mk b/Makefile.docs.mk new file mode 100644 index 00000000..28202dd9 --- /dev/null +++ b/Makefile.docs.mk @@ -0,0 +1,27 @@ +# Make tasks to create and deploy documentation +.PHONY: docs clean-docs deploy-docs doxygen update-docs-from-readme jekyll-layouts + +GAUGES_CODE="539c6c8de32bb442640005f3" + +jekyll-layouts: + git submodule update --init + +doxygen: + doxygen doxygen.config + +update-docs-from-readme: jekyll-layouts + install -d docs + echo "gaugesid: $(GAUGES_CODE)" > docs/_config.yml + echo "projecturl: $(PROJECT_URL)" >> docs/_config.yml + echo "basesite: http://www.unwiredcouch.com" >> docs/_config.yml + echo "markdown: kramdown" >> docs/_config.yml + echo "---" > docs/index.md + echo "layout: project" >> docs/index.md + echo "title: $(NAME)" >> docs/index.md + echo "---" >> docs/index.md + cat README.md >> docs/index.md + +docs: doxygen update-docs-from-readme + +clean-docs: + rm -rf ./docs diff --git a/Makefile.packaging.mk b/Makefile.packaging.mk new file mode 100644 index 00000000..d7ac6f26 --- /dev/null +++ b/Makefile.packaging.mk @@ -0,0 +1,31 @@ +# make tasks to create and publish packages +.PHONY: rpm deb packages deploy-packages + +local-install: + $(MAKE) install PREFIX=usr DESTDIR="$(CURDIR)" + +NAME=restclient-cpp +VERSION = $(shell git describe --tags --always --dirty) +BUILDER = $(shell echo "`git config user.name` <`git config user.email`>") +PKG_RELEASE ?= 1 +PROJECT_URL="https://github.com/mrtazz/$(NAME)" +FPM_FLAGS= --name $(NAME) --version $(VERSION) --iteration $(PKG_RELEASE) \ + --epoch 1 --license MIT --maintainer "$(BUILDER)" --url $(PROJECT_URL) \ + --vendor mrtazz --description "C++ client for making HTTP/REST requests" \ + --after-install utils/runldconfig.sh --after-remove utils/runldconfig.sh \ + --depends curl usr + +rpm: + fpm -t rpm -s dir $(FPM_FLAGS) + +deb: + fpm -t deb -s dir $(FPM_FLAGS) + +packages: local-install rpm deb + +deploy-packages: packages + package_cloud push mrtazz/$(NAME)/el/7 *.rpm + package_cloud push mrtazz/$(NAME)/debian/stretch *.deb + package_cloud push mrtazz/$(NAME)/debian/buster *.deb + package_cloud push mrtazz/$(NAME)/ubuntu/xenial *.deb + package_cloud push mrtazz/$(NAME)/ubuntu/bionic *.deb diff --git a/README.md b/README.md index 19517871..1d4dc0a6 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,358 @@ -# REST client for C++ [![Build Status](https://travis-ci.org/mrtazz/restclient-cpp.svg?branch=master)](https://travis-ci.org/mrtazz/restclient-cpp) +# REST client for C++ +![build status](https://github.com/mrtazz/restclient-cpp/actions/workflows/tests.yaml/badge.svg) +[![Coverage Status](https://coveralls.io/repos/mrtazz/restclient-cpp/badge.svg?branch=master&service=github)](https://coveralls.io/github/mrtazz/restclient-cpp?branch=master) +[![Packagecloud](https://img.shields.io/badge/packagecloud-available-brightgreen.svg)](https://packagecloud.io/mrtazz/restclient-cpp) +[![doxygen](https://img.shields.io/badge/doxygen-reference-blue.svg)](http://code.mrtazz.com/restclient-cpp/ref/) +[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) + ## About -This is a simple REST client for C++. It wraps libcurl for HTTP requests. +This is a simple REST client for C++. It wraps [libcurl][] for HTTP requests. ## Usage -I tried to keep usage close to the [ruby rest-client][]. So the basic usage is: +restclient-cpp provides two ways of interacting with REST endpoints. There is +a simple one, which doesn't need you to configure an object to interact with +an API. However the simple way doesn't provide a lot of configuration options +either. So if you need more than just a simple HTTP call, you will probably +want to check out the advanced usage. + +### Simple Usage +The simple API is just some static methods modeled after the most common HTTP +verbs: + +```cpp +#include "restclient-cpp/restclient.h" + +RestClient::Response r = RestClient::get("http://url.com") +RestClient::Response r = RestClient::post("http://url.com/post", "application/json", "{\"foo\": \"bla\"}") +RestClient::Response r = RestClient::put("http://url.com/put", "application/json", "{\"foo\": \"bla\"}") +RestClient::Response r = RestClient::patch("http://url.com/patch", "application/json", "{\"foo\": \"bla\"}") +RestClient::Response r = RestClient::del("http://url.com/delete") +RestClient::Response r = RestClient::head("http://url.com") +RestClient::Response r = RestClient::options("http://url.com") +``` + +The response is of type [RestClient::Response][restclient_response] and has +three attributes: + +```cpp +RestClient::Response.code // HTTP response code +RestClient::Response.body // HTTP response body +RestClient::Response.headers // HTTP response headers +``` + +### Advanced Usage +However if you want more sophisticated features like connection reuse, +timeouts or authentication, there is also a different, more configurable way. + +```cpp +#include "restclient-cpp/connection.h" +#include "restclient-cpp/restclient.h" + +// initialize RestClient +RestClient::init(); + +// get a connection object +RestClient::Connection* conn = new RestClient::Connection("http://url.com"); + +// configure basic auth +conn->SetBasicAuth("WarMachine68", "WARMACHINEROX"); + +// set connection timeout to 5s +conn->SetTimeout(5); + +// set custom user agent +// (this will result in the UA "foo/cool restclient-cpp/VERSION") +conn->SetUserAgent("foo/cool"); + +// enable following of redirects (default is off) +conn->FollowRedirects(true); +// and limit the number of redirects (default is -1, unlimited) +conn->FollowRedirects(true, 3); + +// set headers +RestClient::HeaderFields headers; +headers["Accept"] = "application/json"; +conn->SetHeaders(headers) + +// append additional headers +conn->AppendHeader("X-MY-HEADER", "foo") + +// if using a non-standard Certificate Authority (CA) trust file +conn->SetCAInfoFilePath("/etc/custom-ca.crt") + +RestClient::Response r = conn->get("/get") +RestClient::Response r = conn->head("/get") +RestClient::Response r = conn->del("/delete") +RestClient::Response r = conn->options("/options") + +// set different content header for POST, PUT and PATCH +conn->AppendHeader("Content-Type", "application/json") +RestClient::Response r = conn->post("/post", "{\"foo\": \"bla\"}") +RestClient::Response r = conn->put("/put", "application/json", "{\"foo\": \"bla\"}") +RestClient::Response r = conn->patch("/patch", "text/plain", "foobar") + +// deinit RestClient. After calling this you have to call RestClient::init() +// again before you can use it +RestClient::disable(); +``` + +The responses are again of type [RestClient::Response][restclient_response] +and have three attributes: + +```cpp +RestClient::Response.code // HTTP response code +RestClient::Response.body // HTTP response body +RestClient::Response.headers // HTTP response headers +``` + +The connection object also provides a simple way to get some diagnostics and +metrics information via `conn->GetInfo()`. The result is a +`RestClient::Connection::Info` struct and looks like this: + +```cpp +typedef struct { + std::string base_url; + RestClients::HeaderFields headers; + int timeout; + struct { + std::string username; + std::string password; + } basicAuth; + + std::string certPath; + std::string certType; + std::string keyPath; + std::string keyPassword; + std::string customUserAgent; + std::string uriProxy; + struct { + // total time of the last request in seconds Total time of previous + // transfer. See CURLINFO_TOTAL_TIME + int totalTime; + // time spent in DNS lookup in seconds Time from start until name + // resolving completed. See CURLINFO_NAMELOOKUP_TIME + int nameLookupTime; + // time it took until Time from start until remote host or proxy + // completed. See CURLINFO_CONNECT_TIME + int connectTime; + // Time from start until SSL/SSH handshake completed. See + // CURLINFO_APPCONNECT_TIME + int appConnectTime; + // Time from start until just before the transfer begins. See + // CURLINFO_PRETRANSFER_TIME + int preTransferTime; + // Time from start until just when the first byte is received. See + // CURLINFO_STARTTRANSFER_TIME + int startTransferTime; + // Time taken for all redirect steps before the final transfer. See + // CURLINFO_REDIRECT_TIME + int redirectTime; + // number of redirects followed. See CURLINFO_REDIRECT_COUNT + int redirectCount; + } lastRequest; +} Info; +``` + +#### Persistent connections/Keep-Alive +The connection object stores the curl easy handle in an instance variable and +uses that for the lifetime of the object. This means curl will [automatically +reuse connections][curl_keepalive] made with that handle. - RestClient::method(url, content-type, params); +### Progress callback -Examples: +Two wrapper functions are provided to setup the progress callback for uploads/downloads. - #include "restclient.h" +Calling `conn->SetFileProgressCallback(callback)` with a callback parameter matching the prototype `int progress_callback(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow)` will setup the progress callback. - RestClient::response r = RestClient::get("http://url.com") - RestClient::response r = RestClient::post("http://url.com/post", "text/json", "{\"foo\": \"bla\"}") - RestClient::response r = RestClient::put("http://url.com/put", "text/json", "{\"foo\": \"bla\"}") - RestClient::response r = RestClient::del("http://url.com/delete") +Calling `conn->SetFileProgressCallbackData(data)` is optional. This will set the data pointer which is the first parameter fed back to the progress callback - `clientp`. If this isn't set then `clientp` will default to the connection object `conn`. -The response is of type RestClient::response and has three attributes: +```cpp +// set CURLOPT_NOPROGRESS +// set CURLOPT_PROGRESSFUNCTION +conn->SetFileProgressCallback(progressFunc); +// set CURLOPT_PROGRESSDATA +conn->SetFileProgressCallbackData(data); +``` + +### Write callback + +A write callback function can be provided for processing data as it's received from a GET call (for instance the [Kubernetes Watch API](https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes)). + +Calling `conn->SetWriteFunction(callback)` with a function parameter matching the prototype `size_t write_function(void *data, size_t size, size_t nmemb, void *userdata)int progress_callback(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow)` will setup the write function. + +Here is an example of a write callback function, processing result data line by line. + +```cpp +auto writeCallback = [](void *data, size_t size, size_t nmemb, void *userdata) -> size_t +{ + size_t bytes = size * nmemb; + try + { + // Add to the buffer + auto res = reinterpret_cast(userdata); + res->body.append(static_cast(data), bytes); + // If the last character is not a new line, wait for the rest. + if ('\n' != *(res->body.end() - 1)) + { + return bytes; + } + // Process data one line at a time. + std::stringstream stream(res->body); + std::string line; + while (std::getline(stream, line)) + { + // Do something with the line here... + } + // Done processing the line + res->body.clear(); + } + catch(std::exception e) + { + // Log caught exception here + return 0; + } + return bytes; +}; +``` + +## Error handling +When restclient-cpp encounters an error, generally the error (or "status") code is returned in the `Response` (see +[Response struct in restclient.h](https://github.com/mrtazz/restclient-cpp/blob/master/include/restclient-cpp/restclient.h)). This error code can be either +an [HTTP error code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status), or if a lower-level cURL error was encountered, it may be +a [CURLCode](https://curl.haxx.se/libcurl/c/libcurl-errors.html). Currently, libcurl only defines 92 error codes, which means +there is no overlap between cURL error codes and HTTP response codes (which start at 1xx). However, if in the future, libcurl defines more than 99 +error codes, meaning that cURL errors overlap with the HTTP 1xx class of responses, restclient-cpp will return a -1 if the CURLCode is 100 or higher. +In this case, callers can use `GetInfo().lastRequest.curlCode` to inspect the actual cURL error. - RestClient::response.code // HTTP response code - RestClient::response.body // HTTP response body - RestClient::response.headers // HTTP response headers +## Thread Safety +restclient-cpp leans heavily on libcurl as it aims to provide a thin wrapper +around it. This means it adheres to the basic level of thread safety [provided +by libcurl][curl_threadsafety]. The `RestClient::init()` and +`RestClient::disable()` methods basically correspond to `curl_global_init` and +`curl_global_cleanup` and thus need to be called right at the beginning of +your program and before shutdown respectively. These set up the environment +and are **not thread-safe**. After that you can create connection objects in +your threads. Do not share connection objects across threads as this would +mean accessing curl handles from multiple threads at the same time which is +not allowed. +The connection level method SetNoSignal can be set to skip all signal handling. This is important in multi-threaded applications as DNS resolution timeouts use signals. The signal handlers quite readily get executed on other threads. Note that with this option DNS resolution timeouts do not work. If you have crashes in your multi-threaded executable that appear to be in DNS resolution, this is probably why. + +In order to provide an easy to use API, the simple usage via the static +methods implicitly calls the curl global functions and is therefore also **not +thread-safe**. + +## HTTPS User Certificate + +Simple wrapper functions are provided to allow clients to authenticate using certificates. +Under the hood these wrappers set cURL options, e.g. `CURLOPT_SSLCERT`, using `curl_easy_setopt`. +Note: currently `libcurl` compiled with `gnutls` (e.g. `libcurl4-gnutls-dev` on +ubuntu) is buggy in that it returns a wrong error code when these options are set to invalid values. + +```cpp +// set CURLOPT_SSLCERT +conn->SetCertPath(certPath); +// set CURLOPT_SSLCERTTYPE +conn->SetCertType(type); +// set CURLOPT_SSLKEY +conn->SetKeyPath(keyPath); +// set CURLOPT_KEYPASSWD +conn->SetKeyPassword(keyPassword); +``` + +## HTTP Proxy Tunneling Support + +An HTTP Proxy can be set to use for the upcoming request. +To specify a port number, append :[port] to the end of the host name. If not specified, `libcurl` will default to using port 1080 for proxies. The proxy string may be prefixed with `http://` or `https://`. If no HTTP(S) scheme is specified, the address provided to `libcurl` will be prefixed with `http://` to specify an HTTP proxy. A proxy host string can embedded user + password. +The operation will be tunneled through the proxy as curl option `CURLOPT_HTTPPROXYTUNNEL` is enabled by default. +A numerical IPv6 address must be written within [brackets]. + +```cpp +// set CURLOPT_PROXY +conn->SetProxy("https://37.187.100.23:3128"); +/* or you can set it without the protocol scheme and +http:// will be prefixed by default */ +conn->SetProxy("37.187.100.23:3128"); +/* the following request will be tunneled through the proxy */ +RestClient::Response res = conn->get("/get"); +``` + +## Unix Socket Support + +- https://docs.docker.com/develop/sdk/examples/ +- $ curl --unix-socket /var/run/docker.sock http:/v1.24/containers/json + +Note that the URL used with a unix socket has only ONE leading forward slash. + +```cpp +RestClient::Connection* conn = new RestClient::Connection("http:/v1.30"); +conn->SetUnixSocketPath("/var/run/docker.sock"); +RestClient::HeaderFields headers; +headers["Accept"] = "application/json; charset=UTF-8"; +headers["Expect"] = ""; +conn->SetHeaders(headers); +auto resp = conn->get("/images/json"); +``` ## Dependencies - [libcurl][] -- [gtest][] for development ## Installation There are some packages available for Linux on [packagecloud][packagecloud]. -Otherwise you can do the regular autotools dance: +And for OSX you can get it from the mrtazz/oss homebrew tap: +```bash +brew tap mrtazz/oss +brew install restclient-cpp ``` + +Otherwise you can do the regular autotools dance: + +```bash ./autogen.sh ./configure make install ``` +Alternatively, you can build and install restclient-cpp using [vcpkg](https://github.com/microsoft/vcpkg/) dependency manager: + +```bash +git clone https://github.com/Microsoft/vcpkg.git +cd vcpkg +./bootstrap-vcpkg.sh +./vcpkg integrate install +./vcpkg install restclient-cpp +``` -## Development -- [Issues][] -- [Tracker][] +The restclient-cpp port in vcpkg is kept up to date by Microsoft team members and community contributors. +If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository. + +Another option is to use Mingw64 and CMake to compile on Windows. This requires you to have [Mingw64](https://www.mingw-w64.org/) installed with [CMake](https://cmake.org/download/) and [libCurl](https://curl.se/windows/) (MSYS2 would also work fine). + +```bash +# Make sure cmake, mingw32-make and g++ are in PATH +# Clone the repo +git clone https://github.com/mrtazz/restclient-cpp && cd restclient-cpp +# Build library +mkdir build && cd build +# Run cmake +cmake -DCMAKE_CXX_COMPILER=g++ -DCMAKE_CC_COMPILER=gcc -DCMAKE_MAKE_PROGRAM=mingw32-make -G "MinGW Makefiles" .. +# Builds the dll.a lib and dll file +mingw32-make +``` ## Contribute -- Fork the project. -- Make your feature addition or bug fix. -- Add tests for it. This is important so I don't break it in a future version - unintentionally. -- Commit, do not mess with version -- Send me a pull request. Bonus points for topic branches. +All contributions are highly appreciated. This includes filing issues, +updating documentation and writing code. Please take a look at the +[contributing guidelines][contributing] before so your contribution can be +merged as fast as possible. [libcurl]: http://curl.haxx.se/libcurl/ -[ruby rest-client]: http://github.com/archiloque/rest-client [gtest]: http://code.google.com/p/googletest/ -[Issues]: https://github.com/mrtazz/restclient-cpp/issues -[Tracker]: https://www.pivotaltracker.com/projects/255177/stories [packagecloud]: https://packagecloud.io/mrtazz/restclient-cpp +[contributing]: https://github.com/mrtazz/restclient-cpp/blob/master/.github/CONTRIBUTING.md +[curl_keepalive]: http://curl.haxx.se/docs/faq.html#What_about_Keep_Alive_or_persist +[curl_threadsafety]: http://curl.haxx.se/libcurl/c/threadsafe.html +[restclient_response]: http://code.mrtazz.com/restclient-cpp/ref/struct_rest_client_1_1_response.html diff --git a/autogen.sh b/autogen.sh index 3f026c45..478db09b 100755 --- a/autogen.sh +++ b/autogen.sh @@ -1,2 +1,18 @@ -#!/bin/sh -autoreconf --force --install +#! /bin/sh +[ -e config.cache ] && rm -f config.cache + +echo -n "testing for glibtoolize ... " +if glibtoolize --version >/dev/null 2>&1; then + LIBTOOLIZE=glibtoolize + echo "using glibtoolize" +else + LIBTOOLIZE=libtoolize + echo "using libtoolize" +fi +$LIBTOOLIZE --automake +aclocal ${OECORE_ACLOCAL_OPTS} +autoconf +autoheader +automake -a +./configure $@ +exit diff --git a/configure.ac b/configure.ac index 9807fde3..32a77183 100644 --- a/configure.ac +++ b/configure.ac @@ -1,11 +1,7 @@ -# -*- Autoconf -*- -# Process this file with autoconf to produce a configure script. - AC_PREREQ([2.52]) -AC_INIT([restclient-cpp], [0.1.2], [d@unwiredcouch.com]) -AM_INIT_AUTOMAKE([0.1.2 foreign subdir-objects]) +AC_INIT([restclient-cpp], [0.5.3], [d@unwiredcouch.com]) +AM_INIT_AUTOMAKE([foreign subdir-objects]) LT_INIT -AC_CONFIG_SRCDIR([include/restclient-cpp/meta.h]) AC_CONFIG_HEADERS([config.h]) AC_CONFIG_MACRO_DIR([m4]) @@ -15,25 +11,20 @@ AC_PROG_CC AC_PROG_INSTALL # check for headers -AC_CHECK_HEADERS([curl/curl.h], - [restclient_cpp_curl_headers_found=yes; break;]) - -AS_IF([test "x$restclient_cpp_curl_headers_found" != "xyes"], - [AC_MSG_ERROR([Unable to find the curl headers])]) +AC_CHECK_HEADERS([curl/curl.h]) # Checks for libraries. # FIXME: Replace `main' with a function in `-lcurl': AC_CHECK_LIB([curl], [main]) -# FIXME: Replace `main' with a function in `-lgtest': -AC_CHECK_LIB([gtest], [main]) - -# Checks for header files. # Checks for typedefs, structures, and compiler characteristics. AC_C_INLINE AC_TYPE_SIZE_T -# Checks for library functions. +AC_CONFIG_FILES([Makefile restclient-cpp.pc]) + +# enable code coverage with ./configure --enable-coverage +AC_ARG_ENABLE(coverage, + AC_HELP_STRING([--enable-coverage],[Enable code coverage]), [CXXFLAGS=" -O0 -g -ftest-coverage -fprofile-arcs"]) -AC_CONFIG_FILES([Makefile]) AC_OUTPUT diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 00000000..e31df3e4 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,4 @@ +gaugesid: 539c6c8de32bb442640005f3 +projecturl: https://github.com/mrtazz/restclient-cpp +basesite: http://www.unwiredcouch.com +markdown: kramdown diff --git a/docs/_layouts b/docs/_layouts new file mode 160000 index 00000000..45dd7d4a --- /dev/null +++ b/docs/_layouts @@ -0,0 +1 @@ +Subproject commit 45dd7d4a5c2686eb9997d5658fd455d09d3a5e4a diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..7e91ccbf --- /dev/null +++ b/docs/index.md @@ -0,0 +1,224 @@ +--- +layout: project +title: restclient-cpp +--- +# REST client for C++ +[![Build Status](https://travis-ci.org/mrtazz/restclient-cpp.svg?branch=master)](https://travis-ci.org/mrtazz/restclient-cpp) +[![Coverage Status](https://coveralls.io/repos/mrtazz/restclient-cpp/badge.svg?branch=master&service=github)](https://coveralls.io/github/mrtazz/restclient-cpp?branch=master) +[![Packagecloud](https://img.shields.io/badge/packagecloud-available-brightgreen.svg)](https://packagecloud.io/mrtazz/restclient-cpp) +[![doxygen](https://img.shields.io/badge/doxygen-reference-blue.svg)](http://code.mrtazz.com/restclient-cpp/ref/) +[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) + + +## About +This is a simple REST client for C++. It wraps [libcurl][] for HTTP requests. + +## Usage +restclient-cpp provides two ways of interacting with REST endpoints. There is +a simple one, which doesn't need you to configure an object to interact with +an API. However the simple way doesn't provide a lot of configuration options +either. So if you need more than just a simple HTTP call, you will probably +want to check out the advanced usage. + +### Simple Usage +The simple API is just some static methods modeled after the most common HTTP +verbs: + +```cpp +#include "restclient-cpp/restclient.h" + +RestClient::Response r = RestClient::get("http://url.com") +RestClient::Response r = RestClient::post("http://url.com/post", "text/json", "{\"foo\": \"bla\"}") +RestClient::Response r = RestClient::put("http://url.com/put", "text/json", "{\"foo\": \"bla\"}") +RestClient::Response r = RestClient::del("http://url.com/delete") +RestClient::Response r = RestClient::head("http://url.com") +``` + +The response is of type [RestClient::Response][restclient_response] and has +three attributes: + +```cpp +RestClient::Response.code // HTTP response code +RestClient::Response.body // HTTP response body +RestClient::Response.headers // HTTP response headers +``` + +### Advanced Usage +However if you want more sophisticated features like connection reuse, +timeouts or authentication, there is also a different, more configurable way. + +```cpp +#include "restclient-cpp/connection.h" +#include "restclient-cpp/restclient.h" + +// initialize RestClient +RestClient::init(); + +// get a connection object +RestClient::Connection* conn = new RestClient::Connection("http://url.com"); + +// configure basic auth +conn->SetBasicAuth("WarMachine68", "WARMACHINEROX"); + +// set connection timeout to 5s +conn->SetTimeout(5); + +// set custom user agent +// (this will result in the UA "foo/cool restclient-cpp/VERSION") +conn->SetUserAgent("foo/cool"); + +// enable following of redirects (default is off) +conn->FollowRedirects(true); + +// set headers +RestClient::HeaderFields headers; +headers["Accept"] = "application/json"; +conn->SetHeaders(headers) + +// append additional headers +conn->AppendHeader("X-MY-HEADER", "foo") + +// if using a non-standard Certificate Authority (CA) trust file +conn->SetCAInfoFilePath("/etc/custom-ca.crt") + +RestClient::Response r = conn->get("/get") +RestClient::Response r = conn->head("/get") +RestClient::Response r = conn->del("/delete") + +// set different content header for POST and PUT +conn->AppendHeader("Content-Type", "application/json") +RestClient::Response r = conn->post("/post", "{\"foo\": \"bla\"}") +RestClient::Response r = conn->put("/put", "application/json", "{\"foo\": \"bla\"}") + +// deinit RestClient. After calling this you have to call RestClient::init() +// again before you can use it +RestClient::disable(); +``` + +The responses are again of type [RestClient::Response][restclient_response] +and have three attributes: + +```cpp +RestClient::Response.code // HTTP response code +RestClient::Response.body // HTTP response body +RestClient::Response.headers // HTTP response headers +``` + +The connection object also provides a simple way to get some diagnostics and +metrics information via `conn->GetInfo()`. The result is a +`RestClient::Connection::Info` struct and looks like this: + +```cpp +typedef struct { + std::string base_url; + RestClients::HeaderFields headers; + int timeout; + struct { + std::string username; + std::string password; + } basicAuth; + + std::string certPath; + std::string certType; + std::string keyPath; + std::string customUserAgent; + struct { + // total time of the last request in seconds Total time of previous + // transfer. See CURLINFO_TOTAL_TIME + int totalTime; + // time spent in DNS lookup in seconds Time from start until name + // resolving completed. See CURLINFO_NAMELOOKUP_TIME + int nameLookupTime; + // time it took until Time from start until remote host or proxy + // completed. See CURLINFO_CONNECT_TIME + int connectTime; + // Time from start until SSL/SSH handshake completed. See + // CURLINFO_APPCONNECT_TIME + int appConnectTime; + // Time from start until just before the transfer begins. See + // CURLINFO_PRETRANSFER_TIME + int preTransferTime; + // Time from start until just when the first byte is received. See + // CURLINFO_STARTTRANSFER_TIME + int startTransferTime; + // Time taken for all redirect steps before the final transfer. See + // CURLINFO_REDIRECT_TIME + int redirectTime; + // number of redirects followed. See CURLINFO_REDIRECT_COUNT + int redirectCount; + } lastRequest; +} Info; +``` + +#### Persistent connections/Keep-Alive +The connection object stores the curl easy handle in an instance variable and +uses that for the lifetime of the object. This means curl will [automatically +reuse connections][curl_keepalive] made with that handle. + + +## Thread Safety +restclient-cpp leans heavily on libcurl as it aims to provide a thin wrapper +around it. This means it adheres to the basic level of thread safety [provided +by libcurl][curl_threadsafety]. The `RestClient::init()` and +`RestClient::disable()` methods basically correspond to `curl_global_init` and +`curl_global_cleanup` and thus need to be called right at the beginning of +your program and before shutdown respectively. These set up the environment +and are **not thread-safe**. After that you can create connection objects in +your threads. Do not share connection objects across threads as this would +mean accessing curl handles from multiple threads at the same time which is +not allowed. + +In order to provide an easy to use API, the simple usage via the static +methods implicitly calls the curl global functions and is therefore also **not +thread-safe**. + +## HTTPS User Certificate + +Simple wrapper functions are provided to allow clients to authenticate using certificates. +Under the hood these wrappers set cURL options, e.g. `CURLOPT_SSLCERT`, using `curl_easy_setopt`. +Note: currently `libcurl` compiled with `gnutls` (e.g. `libcurl4-gnutls-dev` on +ubuntu) is buggy in that it returns a wrong error code when these options are set to invalid values. + +```cpp +// set CURLOPT_SSLCERT +conn->SetCertPath(certPath); +// set CURLOPT_SSLCERTTYPE +conn->SetCertType(type); +// set CURLOPT_SSLKEY +conn->SetKeyPath(keyPath); +``` + +## Dependencies +- [libcurl][] + +## Installation +There are some packages available for Linux on [packagecloud][packagecloud]. +And for OSX you can get it from the mrtazz/oss homebrew tap: + +```bash +brew tap mrtazz/oss +brew install restclient-cpp +``` + +Otherwise you can do the regular autotools dance: + +```bash +./autogen.sh +./configure +make install +``` + +## Contribute +All contributions are highly appreciated. This includes filing issues, +updating documentation and writing code. Please take a look at the +[contributing guidelines][contributing] before so your contribution can be +merged as fast as possible. + + +[libcurl]: http://curl.haxx.se/libcurl/ +[gtest]: http://code.google.com/p/googletest/ +[packagecloud]: https://packagecloud.io/mrtazz/restclient-cpp +[contributing]: https://github.com/mrtazz/restclient-cpp/blob/master/CONTRIBUTING.md +[curl_keepalive]: http://curl.haxx.se/docs/faq.html#What_about_Keep_Alive_or_persist +[curl_threadsafety]: http://curl.haxx.se/libcurl/c/threadsafe.html +[restclient_response]: http://code.mrtazz.com/restclient-cpp/ref/struct_rest_client_1_1_response.html diff --git a/docs/ref/annotated.html b/docs/ref/annotated.html new file mode 100644 index 00000000..eb3c5ccf --- /dev/null +++ b/docs/ref/annotated.html @@ -0,0 +1,110 @@ + + + + + + +restclient-cpp: Class List + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + +
+ +
+
+ + +
+ +
+ +
+
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
[detail level 123]
+ + + + + + + +
 ▼NRestClientNamespace for all RestClient definitions
 ▼NHelpers: namespace for all helper functions
 CUploadObjectThis structure represents the payload to upload on POST requests
 ▼CConnectionConnection object for advanced usage
 CInfoHolds some diagnostics information about the connection object it came from
 CRequestInfoHolds some diagnostics information about a request
 CResponseThis structure represents the HTTP response data
+
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/arrowdown.png b/docs/ref/arrowdown.png new file mode 100644 index 00000000..0b63f6d3 Binary files /dev/null and b/docs/ref/arrowdown.png differ diff --git a/docs/ref/arrowright.png b/docs/ref/arrowright.png new file mode 100644 index 00000000..c6ee22f9 Binary files /dev/null and b/docs/ref/arrowright.png differ diff --git a/docs/ref/bc_s.png b/docs/ref/bc_s.png new file mode 100644 index 00000000..224b29aa Binary files /dev/null and b/docs/ref/bc_s.png differ diff --git a/docs/ref/bdwn.png b/docs/ref/bdwn.png new file mode 100644 index 00000000..940a0b95 Binary files /dev/null and b/docs/ref/bdwn.png differ diff --git a/docs/ref/class_rest_client_1_1_connection-members.html b/docs/ref/class_rest_client_1_1_connection-members.html new file mode 100644 index 00000000..e4fcaf31 --- /dev/null +++ b/docs/ref/class_rest_client_1_1_connection-members.html @@ -0,0 +1,128 @@ + + + + + + +restclient-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RestClient::Connection Member List
+
+
+ +

This is the complete list of members for RestClient::Connection, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + +
AppendHeader(const std::string &key, const std::string &value)RestClient::Connection
Connection(const std::string &baseUrl)RestClient::Connectionexplicit
del(const std::string &uri)RestClient::Connection
FollowRedirects(bool follow)RestClient::Connection
get(const std::string &uri)RestClient::Connection
GetHeaders()RestClient::Connection
GetInfo()RestClient::Connection
GetUserAgent()RestClient::Connection
head(const std::string &uri)RestClient::Connection
password (defined in RestClient::Connection)RestClient::Connection
post(const std::string &uri, const std::string &data)RestClient::Connection
put(const std::string &uri, const std::string &data)RestClient::Connection
SetBasicAuth(const std::string &username, const std::string &password)RestClient::Connection
SetCAInfoFilePath(const std::string &caInfoFilePath)RestClient::Connection
SetCertPath(const std::string &cert) (defined in RestClient::Connection)RestClient::Connection
SetCertType(const std::string &type) (defined in RestClient::Connection)RestClient::Connection
SetHeaders(RestClient::HeaderFields headers)RestClient::Connection
SetKeyPath(const std::string &keyPath) (defined in RestClient::Connection)RestClient::Connection
SetTimeout(int seconds)RestClient::Connection
SetUserAgent(const std::string &userAgent)RestClient::Connection
username (defined in RestClient::Connection)RestClient::Connection
~Connection() (defined in RestClient::Connection)RestClient::Connection
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/class_rest_client_1_1_connection.html b/docs/ref/class_rest_client_1_1_connection.html new file mode 100644 index 00000000..6e5b7044 --- /dev/null +++ b/docs/ref/class_rest_client_1_1_connection.html @@ -0,0 +1,624 @@ + + + + + + +restclient-cpp: RestClient::Connection Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Public Member Functions | +List of all members
+
+
RestClient::Connection Class Reference
+
+
+ +

Connection object for advanced usage. + More...

+ +

#include <connection.h>

+ + + + + + + + +

+Classes

struct  Info
 holds some diagnostics information about the connection object it came from More...
 
struct  RequestInfo
 holds some diagnostics information about a request More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Connection (const std::string &baseUrl)
 constructor for the Connection object More...
 
void SetBasicAuth (const std::string &username, const std::string &password)
 set username and password for basic auth More...
 
void SetTimeout (int seconds)
 set timeout for connection More...
 
void FollowRedirects (bool follow)
 configure whether to follow redirects on this connection More...
 
void SetUserAgent (const std::string &userAgent)
 set custom user agent for connection. This gets prepended to the default restclient-cpp/RESTCLIENT_VERSION string More...
 
void SetCAInfoFilePath (const std::string &caInfoFilePath)
 set custom Certificate Authority (CA) path More...
 
+void SetCertPath (const std::string &cert)
 
+void SetCertType (const std::string &type)
 
+void SetKeyPath (const std::string &keyPath)
 
std::string GetUserAgent ()
 get the user agent to add to the request More...
 
RestClient::Connection::Info GetInfo ()
 get diagnostic information about the connection object More...
 
void SetHeaders (RestClient::HeaderFields headers)
 set the custom headers map. This will replace the currently configured headers with the provided ones. If you want to add additional headers, use AppendHeader() More...
 
RestClient::HeaderFields GetHeaders ()
 get all custom headers set on the connection More...
 
void AppendHeader (const std::string &key, const std::string &value)
 append a header to the internal map More...
 
RestClient::Response get (const std::string &uri)
 HTTP GET method. More...
 
RestClient::Response post (const std::string &uri, const std::string &data)
 HTTP POST method. More...
 
RestClient::Response put (const std::string &uri, const std::string &data)
 HTTP PUT method. More...
 
RestClient::Response del (const std::string &uri)
 HTTP DELETE method. More...
 
RestClient::Response head (const std::string &uri)
 HTTP HEAD method. More...
 
+

Detailed Description

+

Connection object for advanced usage.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
RestClient::Connection::Connection (const std::string & baseUrl)
+ 		+explicit
+
+ +

constructor for the Connection object

+
Parameters
+ + +
baseUrl- base URL for the connection to use
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void RestClient::Connection::AppendHeader (const std::string & key,
const std::string & value 
)
+
+ +

append a header to the internal map

+
Parameters
+ + + +
keyfor the header field
valuefor the header field
+
+
+ +
+
+ +
+
+ + + + + + + + +
RestClient::Response RestClient::Connection::del (const std::string & url)
+
+ +

HTTP DELETE method.

+
Parameters
+ + +
urlto query
+
+
+
Returns
response struct
+

we want HTTP DELETE

+

set HTTP DELETE METHOD

+ +
+
+ +
+
+ + + + + + + + +
void RestClient::Connection::FollowRedirects (bool follow)
+
+ +

configure whether to follow redirects on this connection

+
Parameters
+ + +
follow- boolean whether to follow redirects
+
+
+ +
+
+ +
+
+ + + + + + + + +
RestClient::Response RestClient::Connection::get (const std::string & url)
+
+ +

HTTP GET method.

+
Parameters
+ + +
urlto query
+
+
+
Returns
response struct
+ +
+
+ +
+
+ + + + + + + +
RestClient::HeaderFields RestClient::Connection::GetHeaders ()
+
+ +

get all custom headers set on the connection

+
Returns
a RestClient::HeaderFields map containing the custom headers
+ +
+
+ +
+
+ + + + + + + +
RestClient::Connection::Info RestClient::Connection::GetInfo ()
+
+ +

get diagnostic information about the connection object

+
Returns
RestClient::Connection::Info struct
+ +
+
+ +
+
+ + + + + + + +
std::string RestClient::Connection::GetUserAgent ()
+
+ +

get the user agent to add to the request

+
Returns
user agent as std::string
+ +
+
+ +
+
+ + + + + + + + +
RestClient::Response RestClient::Connection::head (const std::string & url)
+
+ +

HTTP HEAD method.

+
Parameters
+ + +
urlto query
+
+
+
Returns
response struct
+

we want HTTP HEAD

+

set HTTP HEAD METHOD

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
RestClient::Response RestClient::Connection::post (const std::string & url,
const std::string & data 
)
+
+ +

HTTP POST method.

+
Parameters
+ + + +
urlto query
dataHTTP POST body
+
+
+
Returns
response struct
+

Now specify we want to POST data

+

set post fields

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
RestClient::Response RestClient::Connection::put (const std::string & url,
const std::string & data 
)
+
+ +

HTTP PUT method.

+
Parameters
+ + + +
urlto query
dataHTTP PUT body
+
+
+
Returns
response struct
+

initialize upload object

+

Now specify we want to PUT data

+

set read callback function

+

set data object to pass to callback function

+

set data size

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void RestClient::Connection::SetBasicAuth (const std::string & username,
const std::string & password 
)
+
+ +

set username and password for basic auth

+
Parameters
+ + + +
username
password
+
+
+ +
+
+ +
+
+ + + + + + + + +
void RestClient::Connection::SetCAInfoFilePath (const std::string & caInfoFilePath)
+
+ +

set custom Certificate Authority (CA) path

+
Parameters
+ + +
caInfoFilePath- The path to a file holding the certificates used to verify the peer with. See CURLOPT_CAINFO
+
+
+ +
+
+ +
+
+ + + + + + + + +
void RestClient::Connection::SetHeaders (RestClient::HeaderFields headers)
+
+ +

set the custom headers map. This will replace the currently configured headers with the provided ones. If you want to add additional headers, use AppendHeader()

+
Parameters
+ + +
headersto set
+
+
+ +
+
+ +
+
+ + + + + + + + +
void RestClient::Connection::SetTimeout (int seconds)
+
+ +

set timeout for connection

+
Parameters
+ + +
seconds- timeout in seconds
+
+
+ +
+
+ +
+
+ + + + + + + + +
void RestClient::Connection::SetUserAgent (const std::string & userAgent)
+
+ +

set custom user agent for connection. This gets prepended to the default restclient-cpp/RESTCLIENT_VERSION string

+
Parameters
+ + +
userAgent- custom userAgent prefix
+
+
+ +
+
+
The documentation for this class was generated from the following files:
    +
  • include/restclient-cpp/connection.h
    • +
  • source/connection.cc
    • +
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/classes.html b/docs/ref/classes.html new file mode 100644 index 00000000..8c1e0c40 --- /dev/null +++ b/docs/ref/classes.html @@ -0,0 +1,112 @@ + + + + + + +restclient-cpp: Class Index + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + +
+ +
+
+ + +
+ +
+ +
+
+
Class Index
+
+
+
C | I | R | U
+ + + + + + +
  C  
+
  I  
+
  R  
+		Response (RestClient)   
  U  
+
Connection (RestClient)   Connection::Info (RestClient)   Connection::RequestInfo (RestClient)   
UploadObject (RestClient::Helpers)   
+
C | I | R | U
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/closed.png b/docs/ref/closed.png new file mode 100644 index 00000000..98cc2c90 Binary files /dev/null and b/docs/ref/closed.png differ diff --git a/docs/ref/connection_8h.html b/docs/ref/connection_8h.html new file mode 100644 index 00000000..587f6e7e --- /dev/null +++ b/docs/ref/connection_8h.html @@ -0,0 +1,139 @@ + + + + + + +restclient-cpp: include/restclient-cpp/connection.h File Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Namespaces
+
+
connection.h File Reference
+
+
+ +

header definitions for restclient-cpp connection class +More...

+
#include <curl/curl.h>
+#include <string>
+#include <map>
+#include <cstdlib>
+#include "restclient-cpp/restclient.h"
+#include "restclient-cpp/version.h"
+
+

Go to the source code of this file.

+ + + + + + + + + + + +

+Classes

class  RestClient::Connection
 Connection object for advanced usage. More...
 
struct  RestClient::Connection::RequestInfo
 holds some diagnostics information about a request More...
 
struct  RestClient::Connection::Info
 holds some diagnostics information about the connection object it came from More...
 
+ + + + +

+Namespaces

 RestClient
 namespace for all RestClient definitions
 
+

Detailed Description

+

header definitions for restclient-cpp connection class

+
Author
Daniel Schauenberg d@unw.nosp@m.ired.nosp@m.couch.nosp@m..com
+
Version
+
Date
2010-10-11
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/connection_8h_source.html b/docs/ref/connection_8h_source.html new file mode 100644 index 00000000..fb9ca6fe --- /dev/null +++ b/docs/ref/connection_8h_source.html @@ -0,0 +1,257 @@ + + + + + + +restclient-cpp: include/restclient-cpp/connection.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
connection.h
+
+
+Go to the documentation of this file.
1 
+
9 #ifndef INCLUDE_RESTCLIENT_CPP_CONNECTION_H_
+
10 #define INCLUDE_RESTCLIENT_CPP_CONNECTION_H_
+
11 
+
12 #include <curl/curl.h>
+
13 #include <string>
+
14 #include <map>
+
15 #include <cstdlib>
+
16 
+
17 #include "restclient-cpp/restclient.h"
+
18 #include "restclient-cpp/version.h"
+
19 
+
23 namespace RestClient {
+
24 
+
28 class Connection {
+
29  public:
+
60  typedef struct {
+
61  double totalTime;
+
62  double nameLookupTime;
+
63  double connectTime;
+
64  double appConnectTime;
+
65  double preTransferTime;
+
66  double startTransferTime;
+
67  double redirectTime;
+
68  int redirectCount;
+
69  } RequestInfo;
+
93  typedef struct {
+
94  std::string baseUrl;
+
95  RestClient::HeaderFields headers;
+
96  int timeout;
+
97  bool followRedirects;
+
98  struct {
+
99  std::string username;
+
100  std::string password;
+
101  } basicAuth;
+
102 
+
103  std::string certPath;
+
104  std::string certType;
+
105  std::string keyPath;
+
106  std::string customUserAgent;
+
107  RequestInfo lastRequest;
+
108  } Info;
+
109 
+
110 
+
111  explicit Connection(const std::string& baseUrl);
+
112  ~Connection();
+
113 
+
114  // Instance configuration methods
+
115  // configure basic auth
+
116  void SetBasicAuth(const std::string& username,
+
117  const std::string& password);
+
118 
+
119  // set connection timeout to seconds
+
120  void SetTimeout(int seconds);
+
121 
+
122  // set whether to follow redirects
+
123  void FollowRedirects(bool follow);
+
124 
+
125  // set custom user agent
+
126  // (this will result in the UA "foo/cool restclient-cpp/VERSION")
+
127  void SetUserAgent(const std::string& userAgent);
+
128 
+
129  // set the Certificate Authority (CA) Info which is the path to file holding
+
130  // certificates to be used to verify peers. See CURLOPT_CAINFO
+
131  void SetCAInfoFilePath(const std::string& caInfoFilePath);
+
132 
+
133  // set CURLOPT_SSLCERT
+
134  void SetCertPath(const std::string& cert);
+
135 
+
136  // set CURLOPT_SSLCERTTYPE
+
137  void SetCertType(const std::string& type);
+
138 
+
139  // set CURLOPT_SSLKEY. Default format is PEM
+
140  void SetKeyPath(const std::string& keyPath);
+
141 
+
142  std::string GetUserAgent();
+
143 
+
144  RestClient::Connection::Info GetInfo();
+
145 
+
146  // set headers
+
147  void SetHeaders(RestClient::HeaderFields headers);
+
148 
+
149  // get headers
+
150  RestClient::HeaderFields GetHeaders();
+
151 
+
152  // append additional headers
+
153  void AppendHeader(const std::string& key,
+
154  const std::string& value);
+
155 
+
156 
+
157  // Basic HTTP verb methods
+
158  RestClient::Response get(const std::string& uri);
+
159  RestClient::Response post(const std::string& uri,
+
160  const std::string& data);
+
161  RestClient::Response put(const std::string& uri,
+
162  const std::string& data);
+
163  RestClient::Response del(const std::string& uri);
+
164  RestClient::Response head(const std::string& uri);
+
165 
+
166  private:
+
167  CURL* curlHandle;
+
168  std::string baseUrl;
+
169  RestClient::HeaderFields headerFields;
+
170  int timeout;
+
171  bool followRedirects;
+
172  struct {
+
173  std::string username;
+
174  std::string password;
+
175  } basicAuth;
+
176  std::string customUserAgent;
+
177  std::string caInfoFilePath;
+
178  RequestInfo lastRequest;
+
179  std::string certPath;
+
180  std::string certType;
+
181  std::string keyPath;
+
182  RestClient::Response performCurlRequest(const std::string& uri);
+
183 };
+
184 }; // namespace RestClient
+
185 
+
186 #endif // INCLUDE_RESTCLIENT_CPP_CONNECTION_H_
+
RestClient::Response
This structure represents the HTTP response data.
Definition: restclient.h:38
+
RestClient::Connection::GetHeaders
RestClient::HeaderFields GetHeaders()
get all custom headers set on the connection
Definition: connection.cc:105
+
RestClient::Connection::RequestInfo::totalTime
double totalTime
Definition: connection.h:61
+
RestClient::Connection::RequestInfo::preTransferTime
double preTransferTime
Definition: connection.h:65
+
RestClient::Connection::RequestInfo::redirectTime
double redirectTime
Definition: connection.h:67
+
RestClient::Connection::GetInfo
RestClient::Connection::Info GetInfo()
get diagnostic information about the connection object
Definition: connection.cc:53
+
restclient.h
libcurl wrapper for REST calls
+
RestClient::Connection::FollowRedirects
void FollowRedirects(bool follow)
configure whether to follow redirects on this connection
Definition: connection.cc:115
+
RestClient::Connection::Connection
Connection(const std::string &baseUrl)
constructor for the Connection object
Definition: connection.cc:28
+
RestClient::Connection::RequestInfo
holds some diagnostics information about a request
Definition: connection.h:60
+
RestClient::Connection::RequestInfo::redirectCount
int redirectCount
Definition: connection.h:68
+
RestClient::Connection::Info
holds some diagnostics information about the connection object it came from
Definition: connection.h:93
+
RestClient::Connection::Info::headers
RestClient::HeaderFields headers
Definition: connection.h:95
+
RestClient::Connection::SetUserAgent
void SetUserAgent(const std::string &userAgent)
set custom user agent for connection. This gets prepended to the default restclient-cpp/RESTCLIENT_VE...
Definition: connection.cc:127
+
RestClient::Connection::GetUserAgent
std::string GetUserAgent()
get the user agent to add to the request
Definition: connection.cc:149
+
RestClient::Connection::SetHeaders
void SetHeaders(RestClient::HeaderFields headers)
set the custom headers map. This will replace the currently configured headers with the provided ones...
Definition: connection.cc:91
+
RestClient::Connection::SetCAInfoFilePath
void SetCAInfoFilePath(const std::string &caInfoFilePath)
set custom Certificate Authority (CA) path
Definition: connection.cc:139
+
RestClient::HeaderFields
std::map< std::string, std::string > HeaderFields
Definition: restclient.h:27
+
RestClient::Connection::post
RestClient::Response post(const std::string &uri, const std::string &data)
HTTP POST method.
Definition: connection.cc:351
+
RestClient::Connection::SetTimeout
void SetTimeout(int seconds)
set timeout for connection
Definition: connection.cc:164
+
RestClient::Connection::AppendHeader
void AppendHeader(const std::string &key, const std::string &value)
append a header to the internal map
Definition: connection.cc:78
+
RestClient::Connection::del
RestClient::Response del(const std::string &uri)
HTTP DELETE method.
Definition: connection.cc:399
+
RestClient::Connection::put
RestClient::Response put(const std::string &uri, const std::string &data)
HTTP PUT method.
Definition: connection.cc:370
+
RestClient::Connection::head
RestClient::Response head(const std::string &uri)
HTTP HEAD method.
Definition: connection.cc:417
+
RestClient::Connection::RequestInfo::startTransferTime
double startTransferTime
Definition: connection.h:66
+
RestClient::Connection
Connection object for advanced usage.
Definition: connection.h:28
+
RestClient::Connection::Info::followRedirects
bool followRedirects
Definition: connection.h:97
+
RestClient::Connection::Info::customUserAgent
std::string customUserAgent
Definition: connection.h:106
+
RestClient::Connection::Info::baseUrl
std::string baseUrl
Definition: connection.h:94
+
RestClient::Connection::RequestInfo::appConnectTime
double appConnectTime
Definition: connection.h:64
+
RestClient::Connection::RequestInfo::connectTime
double connectTime
Definition: connection.h:63
+
RestClient::Connection::RequestInfo::nameLookupTime
double nameLookupTime
Definition: connection.h:62
+
RestClient::Connection::Info::lastRequest
RequestInfo lastRequest
Definition: connection.h:107
+
RestClient::Connection::SetBasicAuth
void SetBasicAuth(const std::string &username, const std::string &password)
set username and password for basic auth
Definition: connection.cc:176
+
RestClient::Connection::Info::timeout
int timeout
Definition: connection.h:96
+
RestClient
namespace for all RestClient definitions
Definition: connection.h:23
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html b/docs/ref/dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html new file mode 100644 index 00000000..5f822a3a --- /dev/null +++ b/docs/ref/dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html @@ -0,0 +1,106 @@ + + + + + + +restclient-cpp: source Directory Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + +
+
+ + +
+ +
+ + +
+
+
+
source Directory Reference
+
+
+ + + + + + + + +

+Files

file  connection.cc
 
file  helpers.cc
 
file  restclient.cc
 
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/ref/dir_d44c64559bbebec7f509842c48db8b23.html new file mode 100644 index 00000000..7bb9660c --- /dev/null +++ b/docs/ref/dir_d44c64559bbebec7f509842c48db8b23.html @@ -0,0 +1,102 @@ + + + + + + +restclient-cpp: include Directory Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + +
+
+ + +
+ +
+ + +
+
+
+
include Directory Reference
+
+
+ + + + +

+Directories

directory  restclient-cpp
 
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/dir_d7863d21b35bfd92001c24d3be435c80.html b/docs/ref/dir_d7863d21b35bfd92001c24d3be435c80.html new file mode 100644 index 00000000..840049f3 --- /dev/null +++ b/docs/ref/dir_d7863d21b35bfd92001c24d3be435c80.html @@ -0,0 +1,109 @@ + + + + + + +restclient-cpp: include/restclient-cpp Directory Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + +
+
+ + +
+ +
+ + +
+
+
+
restclient-cpp Directory Reference
+
+
+ + + + + + + + + + + +

+Files

file  connection.h [code]
 header definitions for restclient-cpp connection class
 
file  helpers.h [code]
 header file for restclient-cpp helpers
 
file  restclient.h [code]
 libcurl wrapper for REST calls
 
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/doc.png b/docs/ref/doc.png new file mode 100644 index 00000000..17edabff Binary files /dev/null and b/docs/ref/doc.png differ diff --git a/docs/ref/doxygen.css b/docs/ref/doxygen.css new file mode 100644 index 00000000..a0008331 --- /dev/null +++ b/docs/ref/doxygen.css @@ -0,0 +1,1449 @@ +/* The standard CSS for doxygen 1.8.9.1 */ + +body, table, div, p, dl { + font: 400 14px/22px Roboto,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; +} + +.title { + font: 400 14px/28px Roboto,sans-serif; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2.groupheader { + border-bottom: 1px solid #879ECB; + color: #354C7B; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #9CAFD4; + color: #ffffff; + border: 1px double #869DCA; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #4665A2; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; +} + +div.fragment { + padding: 4px 6px; + margin: 4px 8px 4px 2px; + background-color: #FBFCFD; + border: 1px solid #C4CFE5; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +div.ah, span.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); +} + +div.classindex ul { + list-style: none; + padding-left: 0; +} + +div.classindex span.ai { + display: inline-block; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + +.memname { + font-weight: bold; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + border-top-left-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + -moz-border-radius-topleft: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + -webkit-border-top-left-radius: 4px; + +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 10px 2px 10px; + background-color: #FBFCFD; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: #728DC1; + border-top:1px solid #5373B4; + border-left:1px solid #5373B4; + border-right:1px solid #C4CFE5; + border-bottom:1px solid #C4CFE5; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid #9CAFD4; + border-bottom: 1px solid #9CAFD4; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 6px; + background-color: #F7F8FB; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3D578C; +} + +.arrow { + color: #9CAFD4; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: #728DC1; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + /*width: 100%;*/ + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + /*width: 100%;*/ +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: #283A5D; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +dl +{ + padding: 0 0 0 10px; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section +{ + margin-left: 0px; + padding-left: 0px; +} + +dl.note +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00D000; +} + +dl.deprecated +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #505050; +} + +dl.todo +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00C0E0; +} + +dl.test +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #3030E0; +} + +dl.bug +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectname +{ + font: 300% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 120% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 20px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + white-space: nowrap; + background-color: white; + border: 1px solid gray; + border-radius: 4px 4px 4px 4px; + box-shadow: 1px 1px 7px gray; + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: grey; + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: #006318; +} + +#powerTip div { + margin: 0px; + padding: 0px; + font: 12px/16px Roboto,sans-serif; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: #ffffff; + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before { + border-top-color: #808080; + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: #ffffff; + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: #808080; + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: #ffffff; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: #ffffff; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + diff --git a/docs/ref/doxygen.png b/docs/ref/doxygen.png new file mode 100644 index 00000000..3ff17d80 Binary files /dev/null and b/docs/ref/doxygen.png differ diff --git a/docs/ref/dynsections.js b/docs/ref/dynsections.js new file mode 100644 index 00000000..85e18369 --- /dev/null +++ b/docs/ref/dynsections.js @@ -0,0 +1,97 @@ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); +} + +function toggleLevel(level) +{ + $('table.directory tr').each(function() { + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (l + + + + + +restclient-cpp: File List + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + +
+ +
+
+ + +
+ +
+ +
+
+
File List
+
+
+
Here is a list of all documented files with brief descriptions:
+
[detail level 123]
+ + + + + + +
 ▼ include
 ▼ restclient-cpp
 connection.hHeader definitions for restclient-cpp connection class
 helpers.hHeader file for restclient-cpp helpers
 restclient.hLibcurl wrapper for REST calls
 config.h
+
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/folderclosed.png b/docs/ref/folderclosed.png new file mode 100644 index 00000000..bb8ab35e Binary files /dev/null and b/docs/ref/folderclosed.png differ diff --git a/docs/ref/folderopen.png b/docs/ref/folderopen.png new file mode 100644 index 00000000..d6c7f676 Binary files /dev/null and b/docs/ref/folderopen.png differ diff --git a/docs/ref/functions.html b/docs/ref/functions.html new file mode 100644 index 00000000..644d7a87 --- /dev/null +++ b/docs/ref/functions.html @@ -0,0 +1,277 @@ + + + + + + +restclient-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- a -

+ + +

- b -

+ + +

- c -

+ + +

- d -

+ + +

- f -

+ + +

- g -

+ + +

- h -

+ + +

- l -

+ + +

- n -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- t -

+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/functions_func.html b/docs/ref/functions_func.html new file mode 100644 index 00000000..eaef5f5b --- /dev/null +++ b/docs/ref/functions_func.html @@ -0,0 +1,152 @@ + + + + + + +restclient-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+ +
+
+ + +
+ +
+ +
+  +
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/functions_vars.html b/docs/ref/functions_vars.html new file mode 100644 index 00000000..d6240582 --- /dev/null +++ b/docs/ref/functions_vars.html @@ -0,0 +1,162 @@ + + + + + + +restclient-cpp: Class Members - Variables + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+ +
+
+ + +
+ +
+ +
+  +
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/helpers_8h.html b/docs/ref/helpers_8h.html new file mode 100644 index 00000000..028550dd --- /dev/null +++ b/docs/ref/helpers_8h.html @@ -0,0 +1,147 @@ + + + + + + +restclient-cpp: include/restclient-cpp/helpers.h File Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Namespaces | +Functions
+
+
helpers.h File Reference
+
+
+ +

header file for restclient-cpp helpers +More...

+
#include <string>
+#include <algorithm>
+#include <functional>
+#include "restclient-cpp/version.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

struct  RestClient::Helpers::UploadObject
 This structure represents the payload to upload on POST requests. More...
 
+ + + + + + + +

+Namespaces

 RestClient
 namespace for all RestClient definitions
 
 RestClient::Helpers
 : namespace for all helper functions
 
+ + + + + + + + + + +

+Functions

size_t RestClient::Helpers::write_callback (void *ptr, size_t size, size_t nmemb, void *userdata)
 write callback function for libcurl More...
 
size_t RestClient::Helpers::header_callback (void *ptr, size_t size, size_t nmemb, void *userdata)
 header callback for libcurl More...
 
size_t RestClient::Helpers::read_callback (void *ptr, size_t size, size_t nmemb, void *userdata)
 read callback function for libcurl More...
 
+

Detailed Description

+

header file for restclient-cpp helpers

+
Author
Daniel Schauenberg d@unw.nosp@m.ired.nosp@m.couch.nosp@m..com
+
Version
+
Date
2010-10-11
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/helpers_8h_source.html b/docs/ref/helpers_8h_source.html new file mode 100644 index 00000000..e0209fda --- /dev/null +++ b/docs/ref/helpers_8h_source.html @@ -0,0 +1,161 @@ + + + + + + +restclient-cpp: include/restclient-cpp/helpers.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
helpers.h
+
+
+Go to the documentation of this file.
1 
+
9 #ifndef INCLUDE_RESTCLIENT_CPP_HELPERS_H_
+
10 #define INCLUDE_RESTCLIENT_CPP_HELPERS_H_
+
11 
+
12 #include <string>
+
13 #include <algorithm>
+
14 #include <functional>
+
15 
+
16 #include "restclient-cpp/version.h"
+
17 
+
21 namespace RestClient {
+
22 
+
26 namespace Helpers {
+
27 
+
36  typedef struct {
+
37  const char* data;
+
38  size_t length;
+
39  } UploadObject;
+
40 
+
41  // writedata callback function
+
42  size_t write_callback(void *ptr, size_t size, size_t nmemb,
+
43  void *userdata);
+
44 
+
45  // header callback function
+
46  size_t header_callback(void *ptr, size_t size, size_t nmemb,
+
47  void *userdata);
+
48  // read callback function
+
49  size_t read_callback(void *ptr, size_t size, size_t nmemb,
+
50  void *userdata);
+
51 
+
52  // trim from start
+
53  static inline std::string &ltrim(std::string &s) { // NOLINT
+
54  s.erase(s.begin(), std::find_if(s.begin(), s.end(),
+
55  std::not1(std::ptr_fun<int, int>(std::isspace))));
+
56  return s;
+
57  }
+
58 
+
59  // trim from end
+
60  static inline std::string &rtrim(std::string &s) { // NOLINT
+
61  s.erase(std::find_if(s.rbegin(), s.rend(),
+
62  std::not1(std::ptr_fun<int, int>(std::isspace))).base(), s.end());
+
63  return s;
+
64  }
+
65 
+
66  // trim from both ends
+
67  static inline std::string &trim(std::string &s) { // NOLINT
+
68  return ltrim(rtrim(s));
+
69  }
+
70 }; // namespace Helpers
+
71 
+
72 }; // namespace RestClient
+
73 
+
74 #endif // INCLUDE_RESTCLIENT_CPP_HELPERS_H_
+
RestClient::Helpers::header_callback
size_t header_callback(void *ptr, size_t size, size_t nmemb, void *userdata)
header callback for libcurl
Definition: helpers.cc:41
+
RestClient::Helpers::UploadObject::data
const char * data
Definition: helpers.h:37
+
RestClient::Helpers::write_callback
size_t write_callback(void *ptr, size_t size, size_t nmemb, void *userdata)
write callback function for libcurl
Definition: helpers.cc:23
+
RestClient::Helpers::UploadObject
This structure represents the payload to upload on POST requests.
Definition: helpers.h:36
+
RestClient::Helpers::read_callback
size_t read_callback(void *ptr, size_t size, size_t nmemb, void *userdata)
read callback function for libcurl
Definition: helpers.cc:75
+
RestClient::Helpers::UploadObject::length
size_t length
Definition: helpers.h:38
+
RestClient
namespace for all RestClient definitions
Definition: connection.h:23
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/index.html b/docs/ref/index.html new file mode 100644 index 00000000..9771908a --- /dev/null +++ b/docs/ref/index.html @@ -0,0 +1,146 @@ + + + + + + +restclient-cpp: Main Page + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + +
+ +
+
+ + +
+ +
+ +
+
+
restclient-cpp Documentation
+
+
+

![Build Status](https://travis-ci.org/mrtazz/restclient-cpp.svg?branch=master) ![Coverage Status](https://coveralls.io/repos/mrtazz/restclient-cpp/badge.svg?branch=master&service=github) ![Packagecloud](https://img.shields.io/badge/packagecloud-available-brightgreen.svg) ![doxygen](https://img.shields.io/badge/doxygen-reference-blue.svg) ![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)

+

About

+

This is a simple REST client for C++. It wraps libcurl for HTTP requests.

+

Usage

+

restclient-cpp provides two ways of interacting with REST endpoints. There is a simple one, which doesn't need you to configure an object to interact with an API. However the simple way doesn't provide a lot of configuration options either. So if you need more than just a simple HTTP call, you will probably want to check out the advanced usage.

+

Simple Usage

+

The simple API is just some static methods modeled after the most common HTTP verbs:

+

```cpp #include "restclient-cpp/restclient.h"

+

RestClient::Response r = RestClient::get("http://url.com") RestClient::Response r = RestClient::post("http://url.com/post", "text/json", "{\"foo": "bla"}") +RestClient::Response r = RestClient::put("http://url.com/put", "text/json", "{"foo": "bla"}") +RestClient::Response r = RestClient::del("http://url.com/delete") +RestClient::Response r = RestClient::head("http://url.com") ```

+

The response is of type RestClient::Response and has three attributes:

+

```cpp RestClient::Response.code // HTTP response code RestClient::Response.body // HTTP response body RestClient::Response.headers // HTTP response headers ```

+

Advanced Usage

+

However if you want more sophisticated features like connection reuse, timeouts or authentication, there is also a different, more configurable way.

+

```cpp #include "restclient-cpp/connection.h" #include "restclient-cpp/restclient.h"

+

// initialize RestClient RestClient::init();

+

// get a connection object RestClient::Connection* conn = new RestClient::Connection("http://url.com");

+

// configure basic auth conn->SetBasicAuth("WarMachine68", "WARMACHINEROX");

+

// set connection timeout to 5s conn->SetTimeout(5);

+

// set custom user agent // (this will result in the UA "foo/cool restclient-cpp/VERSION") conn->SetUserAgent("foo/cool");

+

// enable following of redirects (default is off) conn->FollowRedirects(true);

+

// set headers RestClient::HeaderFields headers; headers["Accept"] = "application/json"; conn->SetHeaders(headers)

+

// append additional headers conn->AppendHeader("X-MY-HEADER", "foo")

+

// if using a non-standard Certificate Authority (CA) trust file conn->SetCAInfoFilePath("/etc/custom-ca.crt")

+

RestClient::Response r = conn->get("/get") RestClient::Response r = conn->head("/get") RestClient::Response r = conn->del("/delete")

+

// set different content header for POST and PUT conn->AppendHeader("Content-Type", "text/json") RestClient::Response r = conn->post("/post", "{\"foo": "bla"}") +RestClient::Response r = conn->put("/put", "text/json", "{"foo": "bla"}")

+

// deinit RestClient. After calling this you have to call RestClient::init() // again before you can use it RestClient::disable(); ```

+

The responses are again of type RestClient::Response and have three attributes:

+

```cpp RestClient::Response.code // HTTP response code RestClient::Response.body // HTTP response body RestClient::Response.headers // HTTP response headers ```

+

The connection object also provides a simple way to get some diagnostics and metrics information via conn->GetInfo(). The result is a RestClient::Connection::Info struct and looks like this:

+

```cpp typedef struct { std::string base_url; RestClients::HeaderFields headers; int timeout; struct { std::string username; std::string password; } basicAuth;

+

std::string certPath; std::string certType; std::string keyPath; std::string customUserAgent; struct { // total time of the last request in seconds Total time of previous // transfer. See CURLINFO_TOTAL_TIME int totalTime; // time spent in DNS lookup in seconds Time from start until name // resolving completed. See CURLINFO_NAMELOOKUP_TIME int nameLookupTime; // time it took until Time from start until remote host or proxy // completed. See CURLINFO_CONNECT_TIME int connectTime; // Time from start until SSL/SSH handshake completed. See // CURLINFO_APPCONNECT_TIME int appConnectTime; // Time from start until just before the transfer begins. See // CURLINFO_PRETRANSFER_TIME int preTransferTime; // Time from start until just when the first byte is received. See // CURLINFO_STARTTRANSFER_TIME int startTransferTime; // Time taken for all redirect steps before the final transfer. See // CURLINFO_REDIRECT_TIME int redirectTime; // number of redirects followed. See CURLINFO_REDIRECT_COUNT int redirectCount; } lastRequest; } Info; ```

+

Persistent connections/Keep-Alive

+

The connection object stores the curl easy handle in an instance variable and uses that for the lifetime of the object. This means curl will automatically reuse connections made with that handle.

+

Thread Safety

+

restclient-cpp leans heavily on libcurl as it aims to provide a thin wrapper around it. This means it adheres to the basic level of thread safety provided by libcurl. The RestClient::init() and RestClient::disable() methods basically correspond to curl_global_init and curl_global_cleanup and thus need to be called right at the beginning of your program and before shutdown respectively. These set up the environment and are not thread-safe. After that you can create connection objects in your threads. Do not share connection objects across threads as this would mean accessing curl handles from multiple threads at the same time which is not allowed.

+

In order to provide an easy to use API, the simple usage via the static methods implicitly calls the curl global functions and is therefore also not thread-safe.

+

HTTPS User Certificate

+

Simple wrapper functions are provided to allow clients to authenticate using certificates. Under the hood these wrappers set cURL options, e.g. CURLOPT_SSLCERT, using curl_easy_setopt. Note: currently libcurl compiled with gnutls (e.g. libcurl4-gnutls-dev on ubuntu) is buggy in that it returns a wrong error code when these options are set to invalid values.

+

```cpp // set CURLOPT_SSLCERT conn->SetCertPath(certPath); // set CURLOPT_SSLCERTTYPE conn->SetCertType(type); // set CURLOPT_SSLKEY conn->SetKeyPath(keyPath); ```

+

Dependencies

+ +

Installation

+

There are some packages available for Linux on packagecloud. And for OSX you can get it from the mrtazz/oss homebrew tap:

+

```bash brew tap mrtazz/oss brew install restclient-cpp ```

+

Otherwise you can do the regular autotools dance:

+

```bash ./autogen.sh ./configure make install ```

+

Contribute

+

All contributions are highly appreciated. This includes filing issues, updating documentation and writing code. Please take a look at the https://github.com/mrtazz/restclient-cpp/blob/master/CONTRIBUTING.md "contributing guidelines" before so your contribution can be merged as fast as possible.

+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/jquery.js b/docs/ref/jquery.js new file mode 100644 index 00000000..1f4d0b47 --- /dev/null +++ b/docs/ref/jquery.js @@ -0,0 +1,68 @@ +/*! + * jQuery JavaScript Library v1.7.1 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Mon Nov 21 21:11:03 2011 -0500 + */ +(function(bb,L){var av=bb.document,bu=bb.navigator,bl=bb.location;var b=(function(){var bF=function(b0,b1){return new bF.fn.init(b0,b1,bD)},bU=bb.jQuery,bH=bb.$,bD,bY=/^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,bM=/\S/,bI=/^\s+/,bE=/\s+$/,bA=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,bN=/^[\],:{}\s]*$/,bW=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,bP=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,bJ=/(?:^|:|,)(?:\s*\[)+/g,by=/(webkit)[ \/]([\w.]+)/,bR=/(opera)(?:.*version)?[ \/]([\w.]+)/,bQ=/(msie) ([\w.]+)/,bS=/(mozilla)(?:.*? rv:([\w.]+))?/,bB=/-([a-z]|[0-9])/ig,bZ=/^-ms-/,bT=function(b0,b1){return(b1+"").toUpperCase()},bX=bu.userAgent,bV,bC,e,bL=Object.prototype.toString,bG=Object.prototype.hasOwnProperty,bz=Array.prototype.push,bK=Array.prototype.slice,bO=String.prototype.trim,bv=Array.prototype.indexOf,bx={};bF.fn=bF.prototype={constructor:bF,init:function(b0,b4,b3){var b2,b5,b1,b6;if(!b0){return this}if(b0.nodeType){this.context=this[0]=b0;this.length=1;return this}if(b0==="body"&&!b4&&av.body){this.context=av;this[0]=av.body;this.selector=b0;this.length=1;return this}if(typeof b0==="string"){if(b0.charAt(0)==="<"&&b0.charAt(b0.length-1)===">"&&b0.length>=3){b2=[null,b0,null]}else{b2=bY.exec(b0)}if(b2&&(b2[1]||!b4)){if(b2[1]){b4=b4 instanceof bF?b4[0]:b4;b6=(b4?b4.ownerDocument||b4:av);b1=bA.exec(b0);if(b1){if(bF.isPlainObject(b4)){b0=[av.createElement(b1[1])];bF.fn.attr.call(b0,b4,true)}else{b0=[b6.createElement(b1[1])]}}else{b1=bF.buildFragment([b2[1]],[b6]);b0=(b1.cacheable?bF.clone(b1.fragment):b1.fragment).childNodes}return bF.merge(this,b0)}else{b5=av.getElementById(b2[2]);if(b5&&b5.parentNode){if(b5.id!==b2[2]){return b3.find(b0)}this.length=1;this[0]=b5}this.context=av;this.selector=b0;return this}}else{if(!b4||b4.jquery){return(b4||b3).find(b0)}else{return this.constructor(b4).find(b0)}}}else{if(bF.isFunction(b0)){return b3.ready(b0)}}if(b0.selector!==L){this.selector=b0.selector;this.context=b0.context}return bF.makeArray(b0,this)},selector:"",jquery:"1.7.1",length:0,size:function(){return this.length},toArray:function(){return bK.call(this,0)},get:function(b0){return b0==null?this.toArray():(b0<0?this[this.length+b0]:this[b0])},pushStack:function(b1,b3,b0){var b2=this.constructor();if(bF.isArray(b1)){bz.apply(b2,b1)}else{bF.merge(b2,b1)}b2.prevObject=this;b2.context=this.context;if(b3==="find"){b2.selector=this.selector+(this.selector?" ":"")+b0}else{if(b3){b2.selector=this.selector+"."+b3+"("+b0+")"}}return b2},each:function(b1,b0){return bF.each(this,b1,b0)},ready:function(b0){bF.bindReady();bC.add(b0);return this},eq:function(b0){b0=+b0;return b0===-1?this.slice(b0):this.slice(b0,b0+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(bK.apply(this,arguments),"slice",bK.call(arguments).join(","))},map:function(b0){return this.pushStack(bF.map(this,function(b2,b1){return b0.call(b2,b1,b2)}))},end:function(){return this.prevObject||this.constructor(null)},push:bz,sort:[].sort,splice:[].splice};bF.fn.init.prototype=bF.fn;bF.extend=bF.fn.extend=function(){var b9,b2,b0,b1,b6,b7,b5=arguments[0]||{},b4=1,b3=arguments.length,b8=false;if(typeof b5==="boolean"){b8=b5;b5=arguments[1]||{};b4=2}if(typeof b5!=="object"&&!bF.isFunction(b5)){b5={}}if(b3===b4){b5=this;--b4}for(;b40){return}bC.fireWith(av,[bF]);if(bF.fn.trigger){bF(av).trigger("ready").off("ready")}}},bindReady:function(){if(bC){return}bC=bF.Callbacks("once memory");if(av.readyState==="complete"){return setTimeout(bF.ready,1)}if(av.addEventListener){av.addEventListener("DOMContentLoaded",e,false);bb.addEventListener("load",bF.ready,false)}else{if(av.attachEvent){av.attachEvent("onreadystatechange",e);bb.attachEvent("onload",bF.ready);var b0=false;try{b0=bb.frameElement==null}catch(b1){}if(av.documentElement.doScroll&&b0){bw()}}}},isFunction:function(b0){return bF.type(b0)==="function"},isArray:Array.isArray||function(b0){return bF.type(b0)==="array"},isWindow:function(b0){return b0&&typeof b0==="object"&&"setInterval" in b0},isNumeric:function(b0){return !isNaN(parseFloat(b0))&&isFinite(b0)},type:function(b0){return b0==null?String(b0):bx[bL.call(b0)]||"object"},isPlainObject:function(b2){if(!b2||bF.type(b2)!=="object"||b2.nodeType||bF.isWindow(b2)){return false}try{if(b2.constructor&&!bG.call(b2,"constructor")&&!bG.call(b2.constructor.prototype,"isPrototypeOf")){return false}}catch(b1){return false}var b0;for(b0 in b2){}return b0===L||bG.call(b2,b0)},isEmptyObject:function(b1){for(var b0 in b1){return false}return true},error:function(b0){throw new Error(b0)},parseJSON:function(b0){if(typeof b0!=="string"||!b0){return null}b0=bF.trim(b0);if(bb.JSON&&bb.JSON.parse){return bb.JSON.parse(b0)}if(bN.test(b0.replace(bW,"@").replace(bP,"]").replace(bJ,""))){return(new Function("return "+b0))()}bF.error("Invalid JSON: "+b0)},parseXML:function(b2){var b0,b1;try{if(bb.DOMParser){b1=new DOMParser();b0=b1.parseFromString(b2,"text/xml")}else{b0=new ActiveXObject("Microsoft.XMLDOM");b0.async="false";b0.loadXML(b2)}}catch(b3){b0=L}if(!b0||!b0.documentElement||b0.getElementsByTagName("parsererror").length){bF.error("Invalid XML: "+b2)}return b0},noop:function(){},globalEval:function(b0){if(b0&&bM.test(b0)){(bb.execScript||function(b1){bb["eval"].call(bb,b1)})(b0)}},camelCase:function(b0){return b0.replace(bZ,"ms-").replace(bB,bT)},nodeName:function(b1,b0){return b1.nodeName&&b1.nodeName.toUpperCase()===b0.toUpperCase()},each:function(b3,b6,b2){var b1,b4=0,b5=b3.length,b0=b5===L||bF.isFunction(b3);if(b2){if(b0){for(b1 in b3){if(b6.apply(b3[b1],b2)===false){break}}}else{for(;b40&&b0[0]&&b0[b1-1])||b1===0||bF.isArray(b0));if(b3){for(;b21?aJ.call(arguments,0):bG;if(!(--bw)){bC.resolveWith(bC,bx)}}}function bz(bF){return function(bG){bB[bF]=arguments.length>1?aJ.call(arguments,0):bG;bC.notifyWith(bE,bB)}}if(e>1){for(;bv
a";bI=bv.getElementsByTagName("*");bF=bv.getElementsByTagName("a")[0];if(!bI||!bI.length||!bF){return{}}bG=av.createElement("select");bx=bG.appendChild(av.createElement("option"));bE=bv.getElementsByTagName("input")[0];bJ={leadingWhitespace:(bv.firstChild.nodeType===3),tbody:!bv.getElementsByTagName("tbody").length,htmlSerialize:!!bv.getElementsByTagName("link").length,style:/top/.test(bF.getAttribute("style")),hrefNormalized:(bF.getAttribute("href")==="/a"),opacity:/^0.55/.test(bF.style.opacity),cssFloat:!!bF.style.cssFloat,checkOn:(bE.value==="on"),optSelected:bx.selected,getSetAttribute:bv.className!=="t",enctype:!!av.createElement("form").enctype,html5Clone:av.createElement("nav").cloneNode(true).outerHTML!=="<:nav>",submitBubbles:true,changeBubbles:true,focusinBubbles:false,deleteExpando:true,noCloneEvent:true,inlineBlockNeedsLayout:false,shrinkWrapBlocks:false,reliableMarginRight:true};bE.checked=true;bJ.noCloneChecked=bE.cloneNode(true).checked;bG.disabled=true;bJ.optDisabled=!bx.disabled;try{delete bv.test}catch(bC){bJ.deleteExpando=false}if(!bv.addEventListener&&bv.attachEvent&&bv.fireEvent){bv.attachEvent("onclick",function(){bJ.noCloneEvent=false});bv.cloneNode(true).fireEvent("onclick")}bE=av.createElement("input");bE.value="t";bE.setAttribute("type","radio");bJ.radioValue=bE.value==="t";bE.setAttribute("checked","checked");bv.appendChild(bE);bD=av.createDocumentFragment();bD.appendChild(bv.lastChild);bJ.checkClone=bD.cloneNode(true).cloneNode(true).lastChild.checked;bJ.appendChecked=bE.checked;bD.removeChild(bE);bD.appendChild(bv);bv.innerHTML="";if(bb.getComputedStyle){bA=av.createElement("div");bA.style.width="0";bA.style.marginRight="0";bv.style.width="2px";bv.appendChild(bA);bJ.reliableMarginRight=(parseInt((bb.getComputedStyle(bA,null)||{marginRight:0}).marginRight,10)||0)===0}if(bv.attachEvent){for(by in {submit:1,change:1,focusin:1}){bB="on"+by;bw=(bB in bv);if(!bw){bv.setAttribute(bB,"return;");bw=(typeof bv[bB]==="function")}bJ[by+"Bubbles"]=bw}}bD.removeChild(bv);bD=bG=bx=bA=bv=bE=null;b(function(){var bM,bU,bV,bT,bN,bO,bL,bS,bR,e,bP,bQ=av.getElementsByTagName("body")[0];if(!bQ){return}bL=1;bS="position:absolute;top:0;left:0;width:1px;height:1px;margin:0;";bR="visibility:hidden;border:0;";e="style='"+bS+"border:5px solid #000;padding:0;'";bP="
";bM=av.createElement("div");bM.style.cssText=bR+"width:0;height:0;position:static;top:0;margin-top:"+bL+"px";bQ.insertBefore(bM,bQ.firstChild);bv=av.createElement("div");bM.appendChild(bv);bv.innerHTML="
t
";bz=bv.getElementsByTagName("td");bw=(bz[0].offsetHeight===0);bz[0].style.display="";bz[1].style.display="none";bJ.reliableHiddenOffsets=bw&&(bz[0].offsetHeight===0);bv.innerHTML="";bv.style.width=bv.style.paddingLeft="1px";b.boxModel=bJ.boxModel=bv.offsetWidth===2;if(typeof bv.style.zoom!=="undefined"){bv.style.display="inline";bv.style.zoom=1;bJ.inlineBlockNeedsLayout=(bv.offsetWidth===2);bv.style.display="";bv.innerHTML="
";bJ.shrinkWrapBlocks=(bv.offsetWidth!==2)}bv.style.cssText=bS+bR;bv.innerHTML=bP;bU=bv.firstChild;bV=bU.firstChild;bN=bU.nextSibling.firstChild.firstChild;bO={doesNotAddBorder:(bV.offsetTop!==5),doesAddBorderForTableAndCells:(bN.offsetTop===5)};bV.style.position="fixed";bV.style.top="20px";bO.fixedPosition=(bV.offsetTop===20||bV.offsetTop===15);bV.style.position=bV.style.top="";bU.style.overflow="hidden";bU.style.position="relative";bO.subtractsBorderForOverflowNotVisible=(bV.offsetTop===-5);bO.doesNotIncludeMarginInBodyOffset=(bQ.offsetTop!==bL);bQ.removeChild(bM);bv=bM=null;b.extend(bJ,bO)});return bJ})();var aS=/^(?:\{.*\}|\[.*\])$/,aA=/([A-Z])/g;b.extend({cache:{},uuid:0,expando:"jQuery"+(b.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:true,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:true},hasData:function(e){e=e.nodeType?b.cache[e[b.expando]]:e[b.expando];return !!e&&!S(e)},data:function(bx,bv,bz,by){if(!b.acceptData(bx)){return}var bG,bA,bD,bE=b.expando,bC=typeof bv==="string",bF=bx.nodeType,e=bF?b.cache:bx,bw=bF?bx[bE]:bx[bE]&&bE,bB=bv==="events";if((!bw||!e[bw]||(!bB&&!by&&!e[bw].data))&&bC&&bz===L){return}if(!bw){if(bF){bx[bE]=bw=++b.uuid}else{bw=bE}}if(!e[bw]){e[bw]={};if(!bF){e[bw].toJSON=b.noop}}if(typeof bv==="object"||typeof bv==="function"){if(by){e[bw]=b.extend(e[bw],bv)}else{e[bw].data=b.extend(e[bw].data,bv)}}bG=bA=e[bw];if(!by){if(!bA.data){bA.data={}}bA=bA.data}if(bz!==L){bA[b.camelCase(bv)]=bz}if(bB&&!bA[bv]){return bG.events}if(bC){bD=bA[bv];if(bD==null){bD=bA[b.camelCase(bv)]}}else{bD=bA}return bD},removeData:function(bx,bv,by){if(!b.acceptData(bx)){return}var bB,bA,bz,bC=b.expando,bD=bx.nodeType,e=bD?b.cache:bx,bw=bD?bx[bC]:bC;if(!e[bw]){return}if(bv){bB=by?e[bw]:e[bw].data;if(bB){if(!b.isArray(bv)){if(bv in bB){bv=[bv]}else{bv=b.camelCase(bv);if(bv in bB){bv=[bv]}else{bv=bv.split(" ")}}}for(bA=0,bz=bv.length;bA-1){return true}}return false},val:function(bx){var e,bv,by,bw=this[0];if(!arguments.length){if(bw){e=b.valHooks[bw.nodeName.toLowerCase()]||b.valHooks[bw.type];if(e&&"get" in e&&(bv=e.get(bw,"value"))!==L){return bv}bv=bw.value;return typeof bv==="string"?bv.replace(aU,""):bv==null?"":bv}return}by=b.isFunction(bx);return this.each(function(bA){var bz=b(this),bB;if(this.nodeType!==1){return}if(by){bB=bx.call(this,bA,bz.val())}else{bB=bx}if(bB==null){bB=""}else{if(typeof bB==="number"){bB+=""}else{if(b.isArray(bB)){bB=b.map(bB,function(bC){return bC==null?"":bC+""})}}}e=b.valHooks[this.nodeName.toLowerCase()]||b.valHooks[this.type];if(!e||!("set" in e)||e.set(this,bB,"value")===L){this.value=bB}})}});b.extend({valHooks:{option:{get:function(e){var bv=e.attributes.value;return !bv||bv.specified?e.value:e.text}},select:{get:function(e){var bA,bv,bz,bx,by=e.selectedIndex,bB=[],bC=e.options,bw=e.type==="select-one";if(by<0){return null}bv=bw?by:0;bz=bw?by+1:bC.length;for(;bv=0});if(!e.length){bv.selectedIndex=-1}return e}}},attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(bA,bx,bB,bz){var bw,e,by,bv=bA.nodeType;if(!bA||bv===3||bv===8||bv===2){return}if(bz&&bx in b.attrFn){return b(bA)[bx](bB)}if(typeof bA.getAttribute==="undefined"){return b.prop(bA,bx,bB)}by=bv!==1||!b.isXMLDoc(bA);if(by){bx=bx.toLowerCase();e=b.attrHooks[bx]||(ao.test(bx)?aY:be)}if(bB!==L){if(bB===null){b.removeAttr(bA,bx);return}else{if(e&&"set" in e&&by&&(bw=e.set(bA,bB,bx))!==L){return bw}else{bA.setAttribute(bx,""+bB);return bB}}}else{if(e&&"get" in e&&by&&(bw=e.get(bA,bx))!==null){return bw}else{bw=bA.getAttribute(bx);return bw===null?L:bw}}},removeAttr:function(bx,bz){var by,bA,bv,e,bw=0;if(bz&&bx.nodeType===1){bA=bz.toLowerCase().split(af);e=bA.length;for(;bw=0)}}})});var bd=/^(?:textarea|input|select)$/i,n=/^([^\.]*)?(?:\.(.+))?$/,J=/\bhover(\.\S+)?\b/,aO=/^key/,bf=/^(?:mouse|contextmenu)|click/,T=/^(?:focusinfocus|focusoutblur)$/,U=/^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/,Y=function(e){var bv=U.exec(e);if(bv){bv[1]=(bv[1]||"").toLowerCase();bv[3]=bv[3]&&new RegExp("(?:^|\\s)"+bv[3]+"(?:\\s|$)")}return bv},j=function(bw,e){var bv=bw.attributes||{};return((!e[1]||bw.nodeName.toLowerCase()===e[1])&&(!e[2]||(bv.id||{}).value===e[2])&&(!e[3]||e[3].test((bv["class"]||{}).value)))},bt=function(e){return b.event.special.hover?e:e.replace(J,"mouseenter$1 mouseleave$1")};b.event={add:function(bx,bC,bJ,bA,by){var bD,bB,bK,bI,bH,bF,e,bG,bv,bz,bw,bE;if(bx.nodeType===3||bx.nodeType===8||!bC||!bJ||!(bD=b._data(bx))){return}if(bJ.handler){bv=bJ;bJ=bv.handler}if(!bJ.guid){bJ.guid=b.guid++}bK=bD.events;if(!bK){bD.events=bK={}}bB=bD.handle;if(!bB){bD.handle=bB=function(bL){return typeof b!=="undefined"&&(!bL||b.event.triggered!==bL.type)?b.event.dispatch.apply(bB.elem,arguments):L};bB.elem=bx}bC=b.trim(bt(bC)).split(" ");for(bI=0;bI=0){bG=bG.slice(0,-1);bw=true}if(bG.indexOf(".")>=0){bx=bG.split(".");bG=bx.shift();bx.sort()}if((!bA||b.event.customEvent[bG])&&!b.event.global[bG]){return}bv=typeof bv==="object"?bv[b.expando]?bv:new b.Event(bG,bv):new b.Event(bG);bv.type=bG;bv.isTrigger=true;bv.exclusive=bw;bv.namespace=bx.join(".");bv.namespace_re=bv.namespace?new RegExp("(^|\\.)"+bx.join("\\.(?:.*\\.)?")+"(\\.|$)"):null;by=bG.indexOf(":")<0?"on"+bG:"";if(!bA){e=b.cache;for(bC in e){if(e[bC].events&&e[bC].events[bG]){b.event.trigger(bv,bD,e[bC].handle.elem,true)}}return}bv.result=L;if(!bv.target){bv.target=bA}bD=bD!=null?b.makeArray(bD):[];bD.unshift(bv);bF=b.event.special[bG]||{};if(bF.trigger&&bF.trigger.apply(bA,bD)===false){return}bB=[[bA,bF.bindType||bG]];if(!bJ&&!bF.noBubble&&!b.isWindow(bA)){bI=bF.delegateType||bG;bH=T.test(bI+bG)?bA:bA.parentNode;bz=null;for(;bH;bH=bH.parentNode){bB.push([bH,bI]);bz=bH}if(bz&&bz===bA.ownerDocument){bB.push([bz.defaultView||bz.parentWindow||bb,bI])}}for(bC=0;bCbA){bH.push({elem:this,matches:bz.slice(bA)})}for(bC=0;bC0?this.on(e,null,bx,bw):this.trigger(e)};if(b.attrFn){b.attrFn[e]=true}if(aO.test(e)){b.event.fixHooks[e]=b.event.keyHooks}if(bf.test(e)){b.event.fixHooks[e]=b.event.mouseHooks}}); +/*! + * Sizzle CSS Selector Engine + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * More information: http://sizzlejs.com/ + */ +(function(){var bH=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,bC="sizcache"+(Math.random()+"").replace(".",""),bI=0,bL=Object.prototype.toString,bB=false,bA=true,bK=/\\/g,bO=/\r\n/g,bQ=/\W/;[0,0].sort(function(){bA=false;return 0});var by=function(bV,e,bY,bZ){bY=bY||[];e=e||av;var b1=e;if(e.nodeType!==1&&e.nodeType!==9){return[]}if(!bV||typeof bV!=="string"){return bY}var bS,b3,b6,bR,b2,b5,b4,bX,bU=true,bT=by.isXML(e),bW=[],b0=bV;do{bH.exec("");bS=bH.exec(b0);if(bS){b0=bS[3];bW.push(bS[1]);if(bS[2]){bR=bS[3];break}}}while(bS);if(bW.length>1&&bD.exec(bV)){if(bW.length===2&&bE.relative[bW[0]]){b3=bM(bW[0]+bW[1],e,bZ)}else{b3=bE.relative[bW[0]]?[e]:by(bW.shift(),e);while(bW.length){bV=bW.shift();if(bE.relative[bV]){bV+=bW.shift()}b3=bM(bV,b3,bZ)}}}else{if(!bZ&&bW.length>1&&e.nodeType===9&&!bT&&bE.match.ID.test(bW[0])&&!bE.match.ID.test(bW[bW.length-1])){b2=by.find(bW.shift(),e,bT);e=b2.expr?by.filter(b2.expr,b2.set)[0]:b2.set[0]}if(e){b2=bZ?{expr:bW.pop(),set:bF(bZ)}:by.find(bW.pop(),bW.length===1&&(bW[0]==="~"||bW[0]==="+")&&e.parentNode?e.parentNode:e,bT);b3=b2.expr?by.filter(b2.expr,b2.set):b2.set;if(bW.length>0){b6=bF(b3)}else{bU=false}while(bW.length){b5=bW.pop();b4=b5;if(!bE.relative[b5]){b5=""}else{b4=bW.pop()}if(b4==null){b4=e}bE.relative[b5](b6,b4,bT)}}else{b6=bW=[]}}if(!b6){b6=b3}if(!b6){by.error(b5||bV)}if(bL.call(b6)==="[object Array]"){if(!bU){bY.push.apply(bY,b6)}else{if(e&&e.nodeType===1){for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&(b6[bX]===true||b6[bX].nodeType===1&&by.contains(e,b6[bX]))){bY.push(b3[bX])}}}else{for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&b6[bX].nodeType===1){bY.push(b3[bX])}}}}}else{bF(b6,bY)}if(bR){by(bR,b1,bY,bZ);by.uniqueSort(bY)}return bY};by.uniqueSort=function(bR){if(bJ){bB=bA;bR.sort(bJ);if(bB){for(var e=1;e0};by.find=function(bX,e,bY){var bW,bS,bU,bT,bV,bR;if(!bX){return[]}for(bS=0,bU=bE.order.length;bS":function(bW,bR){var bV,bU=typeof bR==="string",bS=0,e=bW.length;if(bU&&!bQ.test(bR)){bR=bR.toLowerCase();for(;bS=0)){if(!bS){e.push(bV)}}else{if(bS){bR[bU]=false}}}}return false},ID:function(e){return e[1].replace(bK,"")},TAG:function(bR,e){return bR[1].replace(bK,"").toLowerCase()},CHILD:function(e){if(e[1]==="nth"){if(!e[2]){by.error(e[0])}e[2]=e[2].replace(/^\+|\s*/g,"");var bR=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(e[2]==="even"&&"2n"||e[2]==="odd"&&"2n+1"||!/\D/.test(e[2])&&"0n+"+e[2]||e[2]);e[2]=(bR[1]+(bR[2]||1))-0;e[3]=bR[3]-0}else{if(e[2]){by.error(e[0])}}e[0]=bI++;return e},ATTR:function(bU,bR,bS,e,bV,bW){var bT=bU[1]=bU[1].replace(bK,"");if(!bW&&bE.attrMap[bT]){bU[1]=bE.attrMap[bT]}bU[4]=(bU[4]||bU[5]||"").replace(bK,"");if(bU[2]==="~="){bU[4]=" "+bU[4]+" "}return bU},PSEUDO:function(bU,bR,bS,e,bV){if(bU[1]==="not"){if((bH.exec(bU[3])||"").length>1||/^\w/.test(bU[3])){bU[3]=by(bU[3],null,null,bR)}else{var bT=by.filter(bU[3],bR,bS,true^bV);if(!bS){e.push.apply(e,bT)}return false}}else{if(bE.match.POS.test(bU[0])||bE.match.CHILD.test(bU[0])){return true}}return bU},POS:function(e){e.unshift(true);return e}},filters:{enabled:function(e){return e.disabled===false&&e.type!=="hidden"},disabled:function(e){return e.disabled===true},checked:function(e){return e.checked===true},selected:function(e){if(e.parentNode){e.parentNode.selectedIndex}return e.selected===true},parent:function(e){return !!e.firstChild},empty:function(e){return !e.firstChild},has:function(bS,bR,e){return !!by(e[3],bS).length},header:function(e){return(/h\d/i).test(e.nodeName)},text:function(bS){var e=bS.getAttribute("type"),bR=bS.type;return bS.nodeName.toLowerCase()==="input"&&"text"===bR&&(e===bR||e===null)},radio:function(e){return e.nodeName.toLowerCase()==="input"&&"radio"===e.type},checkbox:function(e){return e.nodeName.toLowerCase()==="input"&&"checkbox"===e.type},file:function(e){return e.nodeName.toLowerCase()==="input"&&"file"===e.type},password:function(e){return e.nodeName.toLowerCase()==="input"&&"password"===e.type},submit:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"submit"===bR.type},image:function(e){return e.nodeName.toLowerCase()==="input"&&"image"===e.type},reset:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"reset"===bR.type},button:function(bR){var e=bR.nodeName.toLowerCase();return e==="input"&&"button"===bR.type||e==="button"},input:function(e){return(/input|select|textarea|button/i).test(e.nodeName)},focus:function(e){return e===e.ownerDocument.activeElement}},setFilters:{first:function(bR,e){return e===0},last:function(bS,bR,e,bT){return bR===bT.length-1},even:function(bR,e){return e%2===0},odd:function(bR,e){return e%2===1},lt:function(bS,bR,e){return bRe[3]-0},nth:function(bS,bR,e){return e[3]-0===bR},eq:function(bS,bR,e){return e[3]-0===bR}},filter:{PSEUDO:function(bS,bX,bW,bY){var e=bX[1],bR=bE.filters[e];if(bR){return bR(bS,bW,bX,bY)}else{if(e==="contains"){return(bS.textContent||bS.innerText||bw([bS])||"").indexOf(bX[3])>=0}else{if(e==="not"){var bT=bX[3];for(var bV=0,bU=bT.length;bV=0)}}},ID:function(bR,e){return bR.nodeType===1&&bR.getAttribute("id")===e},TAG:function(bR,e){return(e==="*"&&bR.nodeType===1)||!!bR.nodeName&&bR.nodeName.toLowerCase()===e},CLASS:function(bR,e){return(" "+(bR.className||bR.getAttribute("class"))+" ").indexOf(e)>-1},ATTR:function(bV,bT){var bS=bT[1],e=by.attr?by.attr(bV,bS):bE.attrHandle[bS]?bE.attrHandle[bS](bV):bV[bS]!=null?bV[bS]:bV.getAttribute(bS),bW=e+"",bU=bT[2],bR=bT[4];return e==null?bU==="!=":!bU&&by.attr?e!=null:bU==="="?bW===bR:bU==="*="?bW.indexOf(bR)>=0:bU==="~="?(" "+bW+" ").indexOf(bR)>=0:!bR?bW&&e!==false:bU==="!="?bW!==bR:bU==="^="?bW.indexOf(bR)===0:bU==="$="?bW.substr(bW.length-bR.length)===bR:bU==="|="?bW===bR||bW.substr(0,bR.length+1)===bR+"-":false},POS:function(bU,bR,bS,bV){var e=bR[2],bT=bE.setFilters[e];if(bT){return bT(bU,bS,bR,bV)}}}};var bD=bE.match.POS,bx=function(bR,e){return"\\"+(e-0+1)};for(var bz in bE.match){bE.match[bz]=new RegExp(bE.match[bz].source+(/(?![^\[]*\])(?![^\(]*\))/.source));bE.leftMatch[bz]=new RegExp(/(^(?:.|\r|\n)*?)/.source+bE.match[bz].source.replace(/\\(\d+)/g,bx))}var bF=function(bR,e){bR=Array.prototype.slice.call(bR,0);if(e){e.push.apply(e,bR);return e}return bR};try{Array.prototype.slice.call(av.documentElement.childNodes,0)[0].nodeType}catch(bP){bF=function(bU,bT){var bS=0,bR=bT||[];if(bL.call(bU)==="[object Array]"){Array.prototype.push.apply(bR,bU)}else{if(typeof bU.length==="number"){for(var e=bU.length;bS";e.insertBefore(bR,e.firstChild);if(av.getElementById(bS)){bE.find.ID=function(bU,bV,bW){if(typeof bV.getElementById!=="undefined"&&!bW){var bT=bV.getElementById(bU[1]);return bT?bT.id===bU[1]||typeof bT.getAttributeNode!=="undefined"&&bT.getAttributeNode("id").nodeValue===bU[1]?[bT]:L:[]}};bE.filter.ID=function(bV,bT){var bU=typeof bV.getAttributeNode!=="undefined"&&bV.getAttributeNode("id");return bV.nodeType===1&&bU&&bU.nodeValue===bT}}e.removeChild(bR);e=bR=null})();(function(){var e=av.createElement("div");e.appendChild(av.createComment(""));if(e.getElementsByTagName("*").length>0){bE.find.TAG=function(bR,bV){var bU=bV.getElementsByTagName(bR[1]);if(bR[1]==="*"){var bT=[];for(var bS=0;bU[bS];bS++){if(bU[bS].nodeType===1){bT.push(bU[bS])}}bU=bT}return bU}}e.innerHTML="";if(e.firstChild&&typeof e.firstChild.getAttribute!=="undefined"&&e.firstChild.getAttribute("href")!=="#"){bE.attrHandle.href=function(bR){return bR.getAttribute("href",2)}}e=null})();if(av.querySelectorAll){(function(){var e=by,bT=av.createElement("div"),bS="__sizzle__";bT.innerHTML="

";if(bT.querySelectorAll&&bT.querySelectorAll(".TEST").length===0){return}by=function(b4,bV,bZ,b3){bV=bV||av;if(!b3&&!by.isXML(bV)){var b2=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b4);if(b2&&(bV.nodeType===1||bV.nodeType===9)){if(b2[1]){return bF(bV.getElementsByTagName(b4),bZ)}else{if(b2[2]&&bE.find.CLASS&&bV.getElementsByClassName){return bF(bV.getElementsByClassName(b2[2]),bZ)}}}if(bV.nodeType===9){if(b4==="body"&&bV.body){return bF([bV.body],bZ)}else{if(b2&&b2[3]){var bY=bV.getElementById(b2[3]);if(bY&&bY.parentNode){if(bY.id===b2[3]){return bF([bY],bZ)}}else{return bF([],bZ)}}}try{return bF(bV.querySelectorAll(b4),bZ)}catch(b0){}}else{if(bV.nodeType===1&&bV.nodeName.toLowerCase()!=="object"){var bW=bV,bX=bV.getAttribute("id"),bU=bX||bS,b6=bV.parentNode,b5=/^\s*[+~]/.test(b4);if(!bX){bV.setAttribute("id",bU)}else{bU=bU.replace(/'/g,"\\$&")}if(b5&&b6){bV=bV.parentNode}try{if(!b5||b6){return bF(bV.querySelectorAll("[id='"+bU+"'] "+b4),bZ)}}catch(b1){}finally{if(!bX){bW.removeAttribute("id")}}}}}return e(b4,bV,bZ,b3)};for(var bR in e){by[bR]=e[bR]}bT=null})()}(function(){var e=av.documentElement,bS=e.matchesSelector||e.mozMatchesSelector||e.webkitMatchesSelector||e.msMatchesSelector;if(bS){var bU=!bS.call(av.createElement("div"),"div"),bR=false;try{bS.call(av.documentElement,"[test!='']:sizzle")}catch(bT){bR=true}by.matchesSelector=function(bW,bY){bY=bY.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!by.isXML(bW)){try{if(bR||!bE.match.PSEUDO.test(bY)&&!/!=/.test(bY)){var bV=bS.call(bW,bY);if(bV||!bU||bW.document&&bW.document.nodeType!==11){return bV}}}catch(bX){}}return by(bY,null,null,[bW]).length>0}}})();(function(){var e=av.createElement("div");e.innerHTML="
";if(!e.getElementsByClassName||e.getElementsByClassName("e").length===0){return}e.lastChild.className="e";if(e.getElementsByClassName("e").length===1){return}bE.order.splice(1,0,"CLASS");bE.find.CLASS=function(bR,bS,bT){if(typeof bS.getElementsByClassName!=="undefined"&&!bT){return bS.getElementsByClassName(bR[1])}};e=null})();function bv(bR,bW,bV,bZ,bX,bY){for(var bT=0,bS=bZ.length;bT0){bU=e;break}}}e=e[bR]}bZ[bT]=bU}}}if(av.documentElement.contains){by.contains=function(bR,e){return bR!==e&&(bR.contains?bR.contains(e):true)}}else{if(av.documentElement.compareDocumentPosition){by.contains=function(bR,e){return !!(bR.compareDocumentPosition(e)&16)}}else{by.contains=function(){return false}}}by.isXML=function(e){var bR=(e?e.ownerDocument||e:0).documentElement;return bR?bR.nodeName!=="HTML":false};var bM=function(bS,e,bW){var bV,bX=[],bU="",bY=e.nodeType?[e]:e;while((bV=bE.match.PSEUDO.exec(bS))){bU+=bV[0];bS=bS.replace(bE.match.PSEUDO,"")}bS=bE.relative[bS]?bS+"*":bS;for(var bT=0,bR=bY.length;bT0){for(bB=bA;bB=0:b.filter(e,this).length>0:this.filter(e).length>0)},closest:function(by,bx){var bv=[],bw,e,bz=this[0];if(b.isArray(by)){var bB=1;while(bz&&bz.ownerDocument&&bz!==bx){for(bw=0;bw-1:b.find.matchesSelector(bz,by)){bv.push(bz);break}else{bz=bz.parentNode;if(!bz||!bz.ownerDocument||bz===bx||bz.nodeType===11){break}}}}bv=bv.length>1?b.unique(bv):bv;return this.pushStack(bv,"closest",by)},index:function(e){if(!e){return(this[0]&&this[0].parentNode)?this.prevAll().length:-1}if(typeof e==="string"){return b.inArray(this[0],b(e))}return b.inArray(e.jquery?e[0]:e,this)},add:function(e,bv){var bx=typeof e==="string"?b(e,bv):b.makeArray(e&&e.nodeType?[e]:e),bw=b.merge(this.get(),bx);return this.pushStack(C(bx[0])||C(bw[0])?bw:b.unique(bw))},andSelf:function(){return this.add(this.prevObject)}});function C(e){return !e||!e.parentNode||e.parentNode.nodeType===11}b.each({parent:function(bv){var e=bv.parentNode;return e&&e.nodeType!==11?e:null},parents:function(e){return b.dir(e,"parentNode")},parentsUntil:function(bv,e,bw){return b.dir(bv,"parentNode",bw)},next:function(e){return b.nth(e,2,"nextSibling")},prev:function(e){return b.nth(e,2,"previousSibling")},nextAll:function(e){return b.dir(e,"nextSibling")},prevAll:function(e){return b.dir(e,"previousSibling")},nextUntil:function(bv,e,bw){return b.dir(bv,"nextSibling",bw)},prevUntil:function(bv,e,bw){return b.dir(bv,"previousSibling",bw)},siblings:function(e){return b.sibling(e.parentNode.firstChild,e)},children:function(e){return b.sibling(e.firstChild)},contents:function(e){return b.nodeName(e,"iframe")?e.contentDocument||e.contentWindow.document:b.makeArray(e.childNodes)}},function(e,bv){b.fn[e]=function(by,bw){var bx=b.map(this,bv,by);if(!ab.test(e)){bw=by}if(bw&&typeof bw==="string"){bx=b.filter(bw,bx)}bx=this.length>1&&!ay[e]?b.unique(bx):bx;if((this.length>1||a9.test(bw))&&aq.test(e)){bx=bx.reverse()}return this.pushStack(bx,e,P.call(arguments).join(","))}});b.extend({filter:function(bw,e,bv){if(bv){bw=":not("+bw+")"}return e.length===1?b.find.matchesSelector(e[0],bw)?[e[0]]:[]:b.find.matches(bw,e)},dir:function(bw,bv,by){var e=[],bx=bw[bv];while(bx&&bx.nodeType!==9&&(by===L||bx.nodeType!==1||!b(bx).is(by))){if(bx.nodeType===1){e.push(bx)}bx=bx[bv]}return e},nth:function(by,e,bw,bx){e=e||1;var bv=0;for(;by;by=by[bw]){if(by.nodeType===1&&++bv===e){break}}return by},sibling:function(bw,bv){var e=[];for(;bw;bw=bw.nextSibling){if(bw.nodeType===1&&bw!==bv){e.push(bw)}}return e}});function aG(bx,bw,e){bw=bw||0;if(b.isFunction(bw)){return b.grep(bx,function(bz,by){var bA=!!bw.call(bz,by,bz);return bA===e})}else{if(bw.nodeType){return b.grep(bx,function(bz,by){return(bz===bw)===e})}else{if(typeof bw==="string"){var bv=b.grep(bx,function(by){return by.nodeType===1});if(bp.test(bw)){return b.filter(bw,bv,!e)}else{bw=b.filter(bw,bv)}}}}return b.grep(bx,function(bz,by){return(b.inArray(bz,bw)>=0)===e})}function a(e){var bw=aR.split("|"),bv=e.createDocumentFragment();if(bv.createElement){while(bw.length){bv.createElement(bw.pop())}}return bv}var aR="abbr|article|aside|audio|canvas|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",ag=/ jQuery\d+="(?:\d+|null)"/g,ar=/^\s+/,R=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,d=/<([\w:]+)/,w=/",""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]},ac=a(av);ax.optgroup=ax.option;ax.tbody=ax.tfoot=ax.colgroup=ax.caption=ax.thead;ax.th=ax.td;if(!b.support.htmlSerialize){ax._default=[1,"div
","
"]}b.fn.extend({text:function(e){if(b.isFunction(e)){return this.each(function(bw){var bv=b(this);bv.text(e.call(this,bw,bv.text()))})}if(typeof e!=="object"&&e!==L){return this.empty().append((this[0]&&this[0].ownerDocument||av).createTextNode(e))}return b.text(this)},wrapAll:function(e){if(b.isFunction(e)){return this.each(function(bw){b(this).wrapAll(e.call(this,bw))})}if(this[0]){var bv=b(e,this[0].ownerDocument).eq(0).clone(true);if(this[0].parentNode){bv.insertBefore(this[0])}bv.map(function(){var bw=this;while(bw.firstChild&&bw.firstChild.nodeType===1){bw=bw.firstChild}return bw}).append(this)}return this},wrapInner:function(e){if(b.isFunction(e)){return this.each(function(bv){b(this).wrapInner(e.call(this,bv))})}return this.each(function(){var bv=b(this),bw=bv.contents();if(bw.length){bw.wrapAll(e)}else{bv.append(e)}})},wrap:function(e){var bv=b.isFunction(e);return this.each(function(bw){b(this).wrapAll(bv?e.call(this,bw):e)})},unwrap:function(){return this.parent().each(function(){if(!b.nodeName(this,"body")){b(this).replaceWith(this.childNodes)}}).end()},append:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.appendChild(e)}})},prepend:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.insertBefore(e,this.firstChild)}})},before:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this)})}else{if(arguments.length){var e=b.clean(arguments);e.push.apply(e,this.toArray());return this.pushStack(e,"before",arguments)}}},after:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this.nextSibling)})}else{if(arguments.length){var e=this.pushStack(this,"after",arguments);e.push.apply(e,b.clean(arguments));return e}}},remove:function(e,bx){for(var bv=0,bw;(bw=this[bv])!=null;bv++){if(!e||b.filter(e,[bw]).length){if(!bx&&bw.nodeType===1){b.cleanData(bw.getElementsByTagName("*"));b.cleanData([bw])}if(bw.parentNode){bw.parentNode.removeChild(bw)}}}return this},empty:function(){for(var e=0,bv;(bv=this[e])!=null;e++){if(bv.nodeType===1){b.cleanData(bv.getElementsByTagName("*"))}while(bv.firstChild){bv.removeChild(bv.firstChild)}}return this},clone:function(bv,e){bv=bv==null?false:bv;e=e==null?bv:e;return this.map(function(){return b.clone(this,bv,e)})},html:function(bx){if(bx===L){return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(ag,""):null}else{if(typeof bx==="string"&&!ae.test(bx)&&(b.support.leadingWhitespace||!ar.test(bx))&&!ax[(d.exec(bx)||["",""])[1].toLowerCase()]){bx=bx.replace(R,"<$1>");try{for(var bw=0,bv=this.length;bw1&&bw0?this.clone(true):this).get();b(bC[bA])[bv](by);bz=bz.concat(by)}return this.pushStack(bz,e,bC.selector)}}});function bg(e){if(typeof e.getElementsByTagName!=="undefined"){return e.getElementsByTagName("*")}else{if(typeof e.querySelectorAll!=="undefined"){return e.querySelectorAll("*")}else{return[]}}}function az(e){if(e.type==="checkbox"||e.type==="radio"){e.defaultChecked=e.checked}}function E(e){var bv=(e.nodeName||"").toLowerCase();if(bv==="input"){az(e)}else{if(bv!=="script"&&typeof e.getElementsByTagName!=="undefined"){b.grep(e.getElementsByTagName("input"),az)}}}function al(e){var bv=av.createElement("div");ac.appendChild(bv);bv.innerHTML=e.outerHTML;return bv.firstChild}b.extend({clone:function(by,bA,bw){var e,bv,bx,bz=b.support.html5Clone||!ah.test("<"+by.nodeName)?by.cloneNode(true):al(by);if((!b.support.noCloneEvent||!b.support.noCloneChecked)&&(by.nodeType===1||by.nodeType===11)&&!b.isXMLDoc(by)){ai(by,bz);e=bg(by);bv=bg(bz);for(bx=0;e[bx];++bx){if(bv[bx]){ai(e[bx],bv[bx])}}}if(bA){t(by,bz);if(bw){e=bg(by);bv=bg(bz);for(bx=0;e[bx];++bx){t(e[bx],bv[bx])}}}e=bv=null;return bz},clean:function(bw,by,bH,bA){var bF;by=by||av;if(typeof by.createElement==="undefined"){by=by.ownerDocument||by[0]&&by[0].ownerDocument||av}var bI=[],bB;for(var bE=0,bz;(bz=bw[bE])!=null;bE++){if(typeof bz==="number"){bz+=""}if(!bz){continue}if(typeof bz==="string"){if(!W.test(bz)){bz=by.createTextNode(bz)}else{bz=bz.replace(R,"<$1>");var bK=(d.exec(bz)||["",""])[1].toLowerCase(),bx=ax[bK]||ax._default,bD=bx[0],bv=by.createElement("div");if(by===av){ac.appendChild(bv)}else{a(by).appendChild(bv)}bv.innerHTML=bx[1]+bz+bx[2];while(bD--){bv=bv.lastChild}if(!b.support.tbody){var e=w.test(bz),bC=bK==="table"&&!e?bv.firstChild&&bv.firstChild.childNodes:bx[1]===""&&!e?bv.childNodes:[];for(bB=bC.length-1;bB>=0;--bB){if(b.nodeName(bC[bB],"tbody")&&!bC[bB].childNodes.length){bC[bB].parentNode.removeChild(bC[bB])}}}if(!b.support.leadingWhitespace&&ar.test(bz)){bv.insertBefore(by.createTextNode(ar.exec(bz)[0]),bv.firstChild)}bz=bv.childNodes}}var bG;if(!b.support.appendChecked){if(bz[0]&&typeof(bG=bz.length)==="number"){for(bB=0;bB=0){return bx+"px"}}else{return bx}}}});if(!b.support.opacity){b.cssHooks.opacity={get:function(bv,e){return au.test((e&&bv.currentStyle?bv.currentStyle.filter:bv.style.filter)||"")?(parseFloat(RegExp.$1)/100)+"":e?"1":""},set:function(by,bz){var bx=by.style,bv=by.currentStyle,e=b.isNumeric(bz)?"alpha(opacity="+bz*100+")":"",bw=bv&&bv.filter||bx.filter||"";bx.zoom=1;if(bz>=1&&b.trim(bw.replace(ak,""))===""){bx.removeAttribute("filter");if(bv&&!bv.filter){return}}bx.filter=ak.test(bw)?bw.replace(ak,e):bw+" "+e}}}b(function(){if(!b.support.reliableMarginRight){b.cssHooks.marginRight={get:function(bw,bv){var e;b.swap(bw,{display:"inline-block"},function(){if(bv){e=Z(bw,"margin-right","marginRight")}else{e=bw.style.marginRight}});return e}}}});if(av.defaultView&&av.defaultView.getComputedStyle){aI=function(by,bw){var bv,bx,e;bw=bw.replace(z,"-$1").toLowerCase();if((bx=by.ownerDocument.defaultView)&&(e=bx.getComputedStyle(by,null))){bv=e.getPropertyValue(bw);if(bv===""&&!b.contains(by.ownerDocument.documentElement,by)){bv=b.style(by,bw)}}return bv}}if(av.documentElement.currentStyle){aX=function(bz,bw){var bA,e,by,bv=bz.currentStyle&&bz.currentStyle[bw],bx=bz.style;if(bv===null&&bx&&(by=bx[bw])){bv=by}if(!bc.test(bv)&&bn.test(bv)){bA=bx.left;e=bz.runtimeStyle&&bz.runtimeStyle.left;if(e){bz.runtimeStyle.left=bz.currentStyle.left}bx.left=bw==="fontSize"?"1em":(bv||0);bv=bx.pixelLeft+"px";bx.left=bA;if(e){bz.runtimeStyle.left=e}}return bv===""?"auto":bv}}Z=aI||aX;function p(by,bw,bv){var bA=bw==="width"?by.offsetWidth:by.offsetHeight,bz=bw==="width"?an:a1,bx=0,e=bz.length;if(bA>0){if(bv!=="border"){for(;bx)<[^<]*)*<\/script>/gi,q=/^(?:select|textarea)/i,h=/\s+/,br=/([?&])_=[^&]*/,K=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,A=b.fn.load,aa={},r={},aE,s,aV=["*/"]+["*"];try{aE=bl.href}catch(aw){aE=av.createElement("a");aE.href="";aE=aE.href}s=K.exec(aE.toLowerCase())||[];function f(e){return function(by,bA){if(typeof by!=="string"){bA=by;by="*"}if(b.isFunction(bA)){var bx=by.toLowerCase().split(h),bw=0,bz=bx.length,bv,bB,bC;for(;bw=0){var e=bw.slice(by,bw.length);bw=bw.slice(0,by)}var bx="GET";if(bz){if(b.isFunction(bz)){bA=bz;bz=L}else{if(typeof bz==="object"){bz=b.param(bz,b.ajaxSettings.traditional);bx="POST"}}}var bv=this;b.ajax({url:bw,type:bx,dataType:"html",data:bz,complete:function(bC,bB,bD){bD=bC.responseText;if(bC.isResolved()){bC.done(function(bE){bD=bE});bv.html(e?b("
").append(bD.replace(a6,"")).find(e):bD)}if(bA){bv.each(bA,[bD,bB,bC])}}});return this},serialize:function(){return b.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?b.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||q.test(this.nodeName)||aZ.test(this.type))}).map(function(e,bv){var bw=b(this).val();return bw==null?null:b.isArray(bw)?b.map(bw,function(by,bx){return{name:bv.name,value:by.replace(bs,"\r\n")}}):{name:bv.name,value:bw.replace(bs,"\r\n")}}).get()}});b.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(e,bv){b.fn[bv]=function(bw){return this.on(bv,bw)}});b.each(["get","post"],function(e,bv){b[bv]=function(bw,by,bz,bx){if(b.isFunction(by)){bx=bx||bz;bz=by;by=L}return b.ajax({type:bv,url:bw,data:by,success:bz,dataType:bx})}});b.extend({getScript:function(e,bv){return b.get(e,L,bv,"script")},getJSON:function(e,bv,bw){return b.get(e,bv,bw,"json")},ajaxSetup:function(bv,e){if(e){am(bv,b.ajaxSettings)}else{e=bv;bv=b.ajaxSettings}am(bv,e);return bv},ajaxSettings:{url:aE,isLocal:aM.test(s[1]),global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":aV},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":bb.String,"text html":true,"text json":b.parseJSON,"text xml":b.parseXML},flatOptions:{context:true,url:true}},ajaxPrefilter:f(aa),ajaxTransport:f(r),ajax:function(bz,bx){if(typeof bz==="object"){bx=bz;bz=L}bx=bx||{};var bD=b.ajaxSetup({},bx),bS=bD.context||bD,bG=bS!==bD&&(bS.nodeType||bS instanceof b)?b(bS):b.event,bR=b.Deferred(),bN=b.Callbacks("once memory"),bB=bD.statusCode||{},bC,bH={},bO={},bQ,by,bL,bE,bI,bA=0,bw,bK,bJ={readyState:0,setRequestHeader:function(bT,bU){if(!bA){var e=bT.toLowerCase();bT=bO[e]=bO[e]||bT;bH[bT]=bU}return this},getAllResponseHeaders:function(){return bA===2?bQ:null},getResponseHeader:function(bT){var e;if(bA===2){if(!by){by={};while((e=aD.exec(bQ))){by[e[1].toLowerCase()]=e[2]}}e=by[bT.toLowerCase()]}return e===L?null:e},overrideMimeType:function(e){if(!bA){bD.mimeType=e}return this},abort:function(e){e=e||"abort";if(bL){bL.abort(e)}bF(0,e);return this}};function bF(bZ,bU,b0,bW){if(bA===2){return}bA=2;if(bE){clearTimeout(bE)}bL=L;bQ=bW||"";bJ.readyState=bZ>0?4:0;var bT,b4,b3,bX=bU,bY=b0?bj(bD,bJ,b0):L,bV,b2;if(bZ>=200&&bZ<300||bZ===304){if(bD.ifModified){if((bV=bJ.getResponseHeader("Last-Modified"))){b.lastModified[bC]=bV}if((b2=bJ.getResponseHeader("Etag"))){b.etag[bC]=b2}}if(bZ===304){bX="notmodified";bT=true}else{try{b4=G(bD,bY);bX="success";bT=true}catch(b1){bX="parsererror";b3=b1}}}else{b3=bX;if(!bX||bZ){bX="error";if(bZ<0){bZ=0}}}bJ.status=bZ;bJ.statusText=""+(bU||bX);if(bT){bR.resolveWith(bS,[b4,bX,bJ])}else{bR.rejectWith(bS,[bJ,bX,b3])}bJ.statusCode(bB);bB=L;if(bw){bG.trigger("ajax"+(bT?"Success":"Error"),[bJ,bD,bT?b4:b3])}bN.fireWith(bS,[bJ,bX]);if(bw){bG.trigger("ajaxComplete",[bJ,bD]);if(!(--b.active)){b.event.trigger("ajaxStop")}}}bR.promise(bJ);bJ.success=bJ.done;bJ.error=bJ.fail;bJ.complete=bN.add;bJ.statusCode=function(bT){if(bT){var e;if(bA<2){for(e in bT){bB[e]=[bB[e],bT[e]]}}else{e=bT[bJ.status];bJ.then(e,e)}}return this};bD.url=((bz||bD.url)+"").replace(bq,"").replace(c,s[1]+"//");bD.dataTypes=b.trim(bD.dataType||"*").toLowerCase().split(h);if(bD.crossDomain==null){bI=K.exec(bD.url.toLowerCase());bD.crossDomain=!!(bI&&(bI[1]!=s[1]||bI[2]!=s[2]||(bI[3]||(bI[1]==="http:"?80:443))!=(s[3]||(s[1]==="http:"?80:443))))}if(bD.data&&bD.processData&&typeof bD.data!=="string"){bD.data=b.param(bD.data,bD.traditional)}aW(aa,bD,bx,bJ);if(bA===2){return false}bw=bD.global;bD.type=bD.type.toUpperCase();bD.hasContent=!aQ.test(bD.type);if(bw&&b.active++===0){b.event.trigger("ajaxStart")}if(!bD.hasContent){if(bD.data){bD.url+=(M.test(bD.url)?"&":"?")+bD.data;delete bD.data}bC=bD.url;if(bD.cache===false){var bv=b.now(),bP=bD.url.replace(br,"$1_="+bv);bD.url=bP+((bP===bD.url)?(M.test(bD.url)?"&":"?")+"_="+bv:"")}}if(bD.data&&bD.hasContent&&bD.contentType!==false||bx.contentType){bJ.setRequestHeader("Content-Type",bD.contentType)}if(bD.ifModified){bC=bC||bD.url;if(b.lastModified[bC]){bJ.setRequestHeader("If-Modified-Since",b.lastModified[bC])}if(b.etag[bC]){bJ.setRequestHeader("If-None-Match",b.etag[bC])}}bJ.setRequestHeader("Accept",bD.dataTypes[0]&&bD.accepts[bD.dataTypes[0]]?bD.accepts[bD.dataTypes[0]]+(bD.dataTypes[0]!=="*"?", "+aV+"; q=0.01":""):bD.accepts["*"]);for(bK in bD.headers){bJ.setRequestHeader(bK,bD.headers[bK])}if(bD.beforeSend&&(bD.beforeSend.call(bS,bJ,bD)===false||bA===2)){bJ.abort();return false}for(bK in {success:1,error:1,complete:1}){bJ[bK](bD[bK])}bL=aW(r,bD,bx,bJ);if(!bL){bF(-1,"No Transport")}else{bJ.readyState=1;if(bw){bG.trigger("ajaxSend",[bJ,bD])}if(bD.async&&bD.timeout>0){bE=setTimeout(function(){bJ.abort("timeout")},bD.timeout)}try{bA=1;bL.send(bH,bF)}catch(bM){if(bA<2){bF(-1,bM)}else{throw bM}}}return bJ},param:function(e,bw){var bv=[],by=function(bz,bA){bA=b.isFunction(bA)?bA():bA;bv[bv.length]=encodeURIComponent(bz)+"="+encodeURIComponent(bA)};if(bw===L){bw=b.ajaxSettings.traditional}if(b.isArray(e)||(e.jquery&&!b.isPlainObject(e))){b.each(e,function(){by(this.name,this.value)})}else{for(var bx in e){v(bx,e[bx],bw,by)}}return bv.join("&").replace(k,"+")}});function v(bw,by,bv,bx){if(b.isArray(by)){b.each(by,function(bA,bz){if(bv||ap.test(bw)){bx(bw,bz)}else{v(bw+"["+(typeof bz==="object"||b.isArray(bz)?bA:"")+"]",bz,bv,bx)}})}else{if(!bv&&by!=null&&typeof by==="object"){for(var e in by){v(bw+"["+e+"]",by[e],bv,bx)}}else{bx(bw,by)}}}b.extend({active:0,lastModified:{},etag:{}});function bj(bD,bC,bz){var bv=bD.contents,bB=bD.dataTypes,bw=bD.responseFields,by,bA,bx,e;for(bA in bw){if(bA in bz){bC[bw[bA]]=bz[bA]}}while(bB[0]==="*"){bB.shift();if(by===L){by=bD.mimeType||bC.getResponseHeader("content-type")}}if(by){for(bA in bv){if(bv[bA]&&bv[bA].test(by)){bB.unshift(bA);break}}}if(bB[0] in bz){bx=bB[0]}else{for(bA in bz){if(!bB[0]||bD.converters[bA+" "+bB[0]]){bx=bA;break}if(!e){e=bA}}bx=bx||e}if(bx){if(bx!==bB[0]){bB.unshift(bx)}return bz[bx]}}function G(bH,bz){if(bH.dataFilter){bz=bH.dataFilter(bz,bH.dataType)}var bD=bH.dataTypes,bG={},bA,bE,bw=bD.length,bB,bC=bD[0],bx,by,bF,bv,e;for(bA=1;bA=bw.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();bw.animatedProperties[this.prop]=true;for(bA in bw.animatedProperties){if(bw.animatedProperties[bA]!==true){e=false}}if(e){if(bw.overflow!=null&&!b.support.shrinkWrapBlocks){b.each(["","X","Y"],function(bC,bD){bz.style["overflow"+bD]=bw.overflow[bC]})}if(bw.hide){b(bz).hide()}if(bw.hide||bw.show){for(bA in bw.animatedProperties){b.style(bz,bA,bw.orig[bA]);b.removeData(bz,"fxshow"+bA,true);b.removeData(bz,"toggle"+bA,true)}}bv=bw.complete;if(bv){bw.complete=false;bv.call(bz)}}return false}else{if(bw.duration==Infinity){this.now=bx}else{bB=bx-this.startTime;this.state=bB/bw.duration;this.pos=b.easing[bw.animatedProperties[this.prop]](this.state,bB,0,1,bw.duration);this.now=this.start+((this.end-this.start)*this.pos)}this.update()}return true}};b.extend(b.fx,{tick:function(){var bw,bv=b.timers,e=0;for(;e").appendTo(e),bw=bv.css("display");bv.remove();if(bw==="none"||bw===""){if(!a8){a8=av.createElement("iframe");a8.frameBorder=a8.width=a8.height=0}e.appendChild(a8);if(!m||!a8.createElement){m=(a8.contentWindow||a8.contentDocument).document;m.write((av.compatMode==="CSS1Compat"?"":"")+"");m.close()}bv=m.createElement(bx);m.body.appendChild(bv);bw=b.css(bv,"display");e.removeChild(a8)}Q[bx]=bw}return Q[bx]}var V=/^t(?:able|d|h)$/i,ad=/^(?:body|html)$/i;if("getBoundingClientRect" in av.documentElement){b.fn.offset=function(bI){var by=this[0],bB;if(bI){return this.each(function(e){b.offset.setOffset(this,bI,e)})}if(!by||!by.ownerDocument){return null}if(by===by.ownerDocument.body){return b.offset.bodyOffset(by)}try{bB=by.getBoundingClientRect()}catch(bF){}var bH=by.ownerDocument,bw=bH.documentElement;if(!bB||!b.contains(bw,by)){return bB?{top:bB.top,left:bB.left}:{top:0,left:0}}var bC=bH.body,bD=aK(bH),bA=bw.clientTop||bC.clientTop||0,bE=bw.clientLeft||bC.clientLeft||0,bv=bD.pageYOffset||b.support.boxModel&&bw.scrollTop||bC.scrollTop,bz=bD.pageXOffset||b.support.boxModel&&bw.scrollLeft||bC.scrollLeft,bG=bB.top+bv-bA,bx=bB.left+bz-bE;return{top:bG,left:bx}}}else{b.fn.offset=function(bF){var bz=this[0];if(bF){return this.each(function(bG){b.offset.setOffset(this,bF,bG)})}if(!bz||!bz.ownerDocument){return null}if(bz===bz.ownerDocument.body){return b.offset.bodyOffset(bz)}var bC,bw=bz.offsetParent,bv=bz,bE=bz.ownerDocument,bx=bE.documentElement,bA=bE.body,bB=bE.defaultView,e=bB?bB.getComputedStyle(bz,null):bz.currentStyle,bD=bz.offsetTop,by=bz.offsetLeft;while((bz=bz.parentNode)&&bz!==bA&&bz!==bx){if(b.support.fixedPosition&&e.position==="fixed"){break}bC=bB?bB.getComputedStyle(bz,null):bz.currentStyle;bD-=bz.scrollTop;by-=bz.scrollLeft;if(bz===bw){bD+=bz.offsetTop;by+=bz.offsetLeft;if(b.support.doesNotAddBorder&&!(b.support.doesAddBorderForTableAndCells&&V.test(bz.nodeName))){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}bv=bw;bw=bz.offsetParent}if(b.support.subtractsBorderForOverflowNotVisible&&bC.overflow!=="visible"){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}e=bC}if(e.position==="relative"||e.position==="static"){bD+=bA.offsetTop;by+=bA.offsetLeft}if(b.support.fixedPosition&&e.position==="fixed"){bD+=Math.max(bx.scrollTop,bA.scrollTop);by+=Math.max(bx.scrollLeft,bA.scrollLeft)}return{top:bD,left:by}}}b.offset={bodyOffset:function(e){var bw=e.offsetTop,bv=e.offsetLeft;if(b.support.doesNotIncludeMarginInBodyOffset){bw+=parseFloat(b.css(e,"marginTop"))||0;bv+=parseFloat(b.css(e,"marginLeft"))||0}return{top:bw,left:bv}},setOffset:function(bx,bG,bA){var bB=b.css(bx,"position");if(bB==="static"){bx.style.position="relative"}var bz=b(bx),bv=bz.offset(),e=b.css(bx,"top"),bE=b.css(bx,"left"),bF=(bB==="absolute"||bB==="fixed")&&b.inArray("auto",[e,bE])>-1,bD={},bC={},bw,by;if(bF){bC=bz.position();bw=bC.top;by=bC.left}else{bw=parseFloat(e)||0;by=parseFloat(bE)||0}if(b.isFunction(bG)){bG=bG.call(bx,bA,bv)}if(bG.top!=null){bD.top=(bG.top-bv.top)+bw}if(bG.left!=null){bD.left=(bG.left-bv.left)+by}if("using" in bG){bG.using.call(bx,bD)}else{bz.css(bD)}}};b.fn.extend({position:function(){if(!this[0]){return null}var bw=this[0],bv=this.offsetParent(),bx=this.offset(),e=ad.test(bv[0].nodeName)?{top:0,left:0}:bv.offset();bx.top-=parseFloat(b.css(bw,"marginTop"))||0;bx.left-=parseFloat(b.css(bw,"marginLeft"))||0;e.top+=parseFloat(b.css(bv[0],"borderTopWidth"))||0;e.left+=parseFloat(b.css(bv[0],"borderLeftWidth"))||0;return{top:bx.top-e.top,left:bx.left-e.left}},offsetParent:function(){return this.map(function(){var e=this.offsetParent||av.body;while(e&&(!ad.test(e.nodeName)&&b.css(e,"position")==="static")){e=e.offsetParent}return e})}});b.each(["Left","Top"],function(bv,e){var bw="scroll"+e;b.fn[bw]=function(bz){var bx,by;if(bz===L){bx=this[0];if(!bx){return null}by=aK(bx);return by?("pageXOffset" in by)?by[bv?"pageYOffset":"pageXOffset"]:b.support.boxModel&&by.document.documentElement[bw]||by.document.body[bw]:bx[bw]}return this.each(function(){by=aK(this);if(by){by.scrollTo(!bv?bz:b(by).scrollLeft(),bv?bz:b(by).scrollTop())}else{this[bw]=bz}})}});function aK(e){return b.isWindow(e)?e:e.nodeType===9?e.defaultView||e.parentWindow:false}b.each(["Height","Width"],function(bv,e){var bw=e.toLowerCase();b.fn["inner"+e]=function(){var bx=this[0];return bx?bx.style?parseFloat(b.css(bx,bw,"padding")):this[bw]():null};b.fn["outer"+e]=function(by){var bx=this[0];return bx?bx.style?parseFloat(b.css(bx,bw,by?"margin":"border")):this[bw]():null};b.fn[bw]=function(bz){var bA=this[0];if(!bA){return bz==null?null:this}if(b.isFunction(bz)){return this.each(function(bE){var bD=b(this);bD[bw](bz.call(this,bE,bD[bw]()))})}if(b.isWindow(bA)){var bB=bA.document.documentElement["client"+e],bx=bA.document.body;return bA.document.compatMode==="CSS1Compat"&&bB||bx&&bx["client"+e]||bB}else{if(bA.nodeType===9){return Math.max(bA.documentElement["client"+e],bA.body["scroll"+e],bA.documentElement["scroll"+e],bA.body["offset"+e],bA.documentElement["offset"+e])}else{if(bz===L){var bC=b.css(bA,bw),by=parseFloat(bC);return b.isNumeric(by)?by:bC}else{return this.css(bw,typeof bz==="string"?bz:bz+"px")}}}}});bb.jQuery=bb.$=b;if(typeof define==="function"&&define.amd&&define.amd.jQuery){define("jquery",[],function(){return b})}})(window);/*! + * jQuery UI 1.8.18 + * + * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about) + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * http://docs.jquery.com/UI + */ +(function(a,d){a.ui=a.ui||{};if(a.ui.version){return}a.extend(a.ui,{version:"1.8.18",keyCode:{ALT:18,BACKSPACE:8,CAPS_LOCK:20,COMMA:188,COMMAND:91,COMMAND_LEFT:91,COMMAND_RIGHT:93,CONTROL:17,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,INSERT:45,LEFT:37,MENU:93,NUMPAD_ADD:107,NUMPAD_DECIMAL:110,NUMPAD_DIVIDE:111,NUMPAD_ENTER:108,NUMPAD_MULTIPLY:106,NUMPAD_SUBTRACT:109,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SHIFT:16,SPACE:32,TAB:9,UP:38,WINDOWS:91}});a.fn.extend({propAttr:a.fn.prop||a.fn.attr,_focus:a.fn.focus,focus:function(e,f){return typeof e==="number"?this.each(function(){var g=this;setTimeout(function(){a(g).focus();if(f){f.call(g)}},e)}):this._focus.apply(this,arguments)},scrollParent:function(){var e;if((a.browser.msie&&(/(static|relative)/).test(this.css("position")))||(/absolute/).test(this.css("position"))){e=this.parents().filter(function(){return(/(relative|absolute|fixed)/).test(a.curCSS(this,"position",1))&&(/(auto|scroll)/).test(a.curCSS(this,"overflow",1)+a.curCSS(this,"overflow-y",1)+a.curCSS(this,"overflow-x",1))}).eq(0)}else{e=this.parents().filter(function(){return(/(auto|scroll)/).test(a.curCSS(this,"overflow",1)+a.curCSS(this,"overflow-y",1)+a.curCSS(this,"overflow-x",1))}).eq(0)}return(/fixed/).test(this.css("position"))||!e.length?a(document):e},zIndex:function(h){if(h!==d){return this.css("zIndex",h)}if(this.length){var f=a(this[0]),e,g;while(f.length&&f[0]!==document){e=f.css("position");if(e==="absolute"||e==="relative"||e==="fixed"){g=parseInt(f.css("zIndex"),10);if(!isNaN(g)&&g!==0){return g}}f=f.parent()}}return 0},disableSelection:function(){return this.bind((a.support.selectstart?"selectstart":"mousedown")+".ui-disableSelection",function(e){e.preventDefault()})},enableSelection:function(){return this.unbind(".ui-disableSelection")}});a.each(["Width","Height"],function(g,e){var f=e==="Width"?["Left","Right"]:["Top","Bottom"],h=e.toLowerCase(),k={innerWidth:a.fn.innerWidth,innerHeight:a.fn.innerHeight,outerWidth:a.fn.outerWidth,outerHeight:a.fn.outerHeight};function j(m,l,i,n){a.each(f,function(){l-=parseFloat(a.curCSS(m,"padding"+this,true))||0;if(i){l-=parseFloat(a.curCSS(m,"border"+this+"Width",true))||0}if(n){l-=parseFloat(a.curCSS(m,"margin"+this,true))||0}});return l}a.fn["inner"+e]=function(i){if(i===d){return k["inner"+e].call(this)}return this.each(function(){a(this).css(h,j(this,i)+"px")})};a.fn["outer"+e]=function(i,l){if(typeof i!=="number"){return k["outer"+e].call(this,i)}return this.each(function(){a(this).css(h,j(this,i,true,l)+"px")})}});function c(g,e){var j=g.nodeName.toLowerCase();if("area"===j){var i=g.parentNode,h=i.name,f;if(!g.href||!h||i.nodeName.toLowerCase()!=="map"){return false}f=a("img[usemap=#"+h+"]")[0];return !!f&&b(f)}return(/input|select|textarea|button|object/.test(j)?!g.disabled:"a"==j?g.href||e:e)&&b(g)}function b(e){return !a(e).parents().andSelf().filter(function(){return a.curCSS(this,"visibility")==="hidden"||a.expr.filters.hidden(this)}).length}a.extend(a.expr[":"],{data:function(g,f,e){return !!a.data(g,e[3])},focusable:function(e){return c(e,!isNaN(a.attr(e,"tabindex")))},tabbable:function(g){var e=a.attr(g,"tabindex"),f=isNaN(e);return(f||e>=0)&&c(g,!f)}});a(function(){var e=document.body,f=e.appendChild(f=document.createElement("div"));f.offsetHeight;a.extend(f.style,{minHeight:"100px",height:"auto",padding:0,borderWidth:0});a.support.minHeight=f.offsetHeight===100;a.support.selectstart="onselectstart" in f;e.removeChild(f).style.display="none"});a.extend(a.ui,{plugin:{add:function(f,g,j){var h=a.ui[f].prototype;for(var e in j){h.plugins[e]=h.plugins[e]||[];h.plugins[e].push([g,j[e]])}},call:function(e,g,f){var j=e.plugins[g];if(!j||!e.element[0].parentNode){return}for(var h=0;h0){return true}h[e]=1;g=(h[e]>0);h[e]=0;return g},isOverAxis:function(f,e,g){return(f>e)&&(f<(e+g))},isOver:function(j,f,i,h,e,g){return a.ui.isOverAxis(j,i,e)&&a.ui.isOverAxis(f,h,g)}})})(jQuery);/*! + * jQuery UI Widget 1.8.18 + * + * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about) + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * http://docs.jquery.com/UI/Widget + */ +(function(b,d){if(b.cleanData){var c=b.cleanData;b.cleanData=function(f){for(var g=0,h;(h=f[g])!=null;g++){try{b(h).triggerHandler("remove")}catch(j){}}c(f)}}else{var a=b.fn.remove;b.fn.remove=function(e,f){return this.each(function(){if(!f){if(!e||b.filter(e,[this]).length){b("*",this).add([this]).each(function(){try{b(this).triggerHandler("remove")}catch(g){}})}}return a.call(b(this),e,f)})}}b.widget=function(f,h,e){var g=f.split(".")[0],j;f=f.split(".")[1];j=g+"-"+f;if(!e){e=h;h=b.Widget}b.expr[":"][j]=function(k){return !!b.data(k,f)};b[g]=b[g]||{};b[g][f]=function(k,l){if(arguments.length){this._createWidget(k,l)}};var i=new h();i.options=b.extend(true,{},i.options);b[g][f].prototype=b.extend(true,i,{namespace:g,widgetName:f,widgetEventPrefix:b[g][f].prototype.widgetEventPrefix||f,widgetBaseClass:j},e);b.widget.bridge(f,b[g][f])};b.widget.bridge=function(f,e){b.fn[f]=function(i){var g=typeof i==="string",h=Array.prototype.slice.call(arguments,1),j=this;i=!g&&h.length?b.extend.apply(null,[true,i].concat(h)):i;if(g&&i.charAt(0)==="_"){return j}if(g){this.each(function(){var k=b.data(this,f),l=k&&b.isFunction(k[i])?k[i].apply(k,h):k;if(l!==k&&l!==d){j=l;return false}})}else{this.each(function(){var k=b.data(this,f);if(k){k.option(i||{})._init()}else{b.data(this,f,new e(i,this))}})}return j}};b.Widget=function(e,f){if(arguments.length){this._createWidget(e,f)}};b.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",options:{disabled:false},_createWidget:function(f,g){b.data(g,this.widgetName,this);this.element=b(g);this.options=b.extend(true,{},this.options,this._getCreateOptions(),f);var e=this;this.element.bind("remove."+this.widgetName,function(){e.destroy()});this._create();this._trigger("create");this._init()},_getCreateOptions:function(){return b.metadata&&b.metadata.get(this.element[0])[this.widgetName]},_create:function(){},_init:function(){},destroy:function(){this.element.unbind("."+this.widgetName).removeData(this.widgetName);this.widget().unbind("."+this.widgetName).removeAttr("aria-disabled").removeClass(this.widgetBaseClass+"-disabled ui-state-disabled")},widget:function(){return this.element},option:function(f,g){var e=f;if(arguments.length===0){return b.extend({},this.options)}if(typeof f==="string"){if(g===d){return this.options[f]}e={};e[f]=g}this._setOptions(e);return this},_setOptions:function(f){var e=this;b.each(f,function(g,h){e._setOption(g,h)});return this},_setOption:function(e,f){this.options[e]=f;if(e==="disabled"){this.widget()[f?"addClass":"removeClass"](this.widgetBaseClass+"-disabled ui-state-disabled").attr("aria-disabled",f)}return this},enable:function(){return this._setOption("disabled",false)},disable:function(){return this._setOption("disabled",true)},_trigger:function(e,f,g){var j,i,h=this.options[e];g=g||{};f=b.Event(f);f.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase();f.target=this.element[0];i=f.originalEvent;if(i){for(j in i){if(!(j in f)){f[j]=i[j]}}}this.element.trigger(f,g);return !(b.isFunction(h)&&h.call(this.element[0],f,g)===false||f.isDefaultPrevented())}}})(jQuery);/*! + * jQuery UI Mouse 1.8.18 + * + * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about) + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * http://docs.jquery.com/UI/Mouse + * + * Depends: + * jquery.ui.widget.js + */ +(function(b,c){var a=false;b(document).mouseup(function(d){a=false});b.widget("ui.mouse",{options:{cancel:":input,option",distance:1,delay:0},_mouseInit:function(){var d=this;this.element.bind("mousedown."+this.widgetName,function(e){return d._mouseDown(e)}).bind("click."+this.widgetName,function(e){if(true===b.data(e.target,d.widgetName+".preventClickEvent")){b.removeData(e.target,d.widgetName+".preventClickEvent");e.stopImmediatePropagation();return false}});this.started=false},_mouseDestroy:function(){this.element.unbind("."+this.widgetName)},_mouseDown:function(f){if(a){return}(this._mouseStarted&&this._mouseUp(f));this._mouseDownEvent=f;var e=this,g=(f.which==1),d=(typeof this.options.cancel=="string"&&f.target.nodeName?b(f.target).closest(this.options.cancel).length:false);if(!g||d||!this._mouseCapture(f)){return true}this.mouseDelayMet=!this.options.delay;if(!this.mouseDelayMet){this._mouseDelayTimer=setTimeout(function(){e.mouseDelayMet=true},this.options.delay)}if(this._mouseDistanceMet(f)&&this._mouseDelayMet(f)){this._mouseStarted=(this._mouseStart(f)!==false);if(!this._mouseStarted){f.preventDefault();return true}}if(true===b.data(f.target,this.widgetName+".preventClickEvent")){b.removeData(f.target,this.widgetName+".preventClickEvent")}this._mouseMoveDelegate=function(h){return e._mouseMove(h)};this._mouseUpDelegate=function(h){return e._mouseUp(h)};b(document).bind("mousemove."+this.widgetName,this._mouseMoveDelegate).bind("mouseup."+this.widgetName,this._mouseUpDelegate);f.preventDefault();a=true;return true},_mouseMove:function(d){if(b.browser.msie&&!(document.documentMode>=9)&&!d.button){return this._mouseUp(d)}if(this._mouseStarted){this._mouseDrag(d);return d.preventDefault()}if(this._mouseDistanceMet(d)&&this._mouseDelayMet(d)){this._mouseStarted=(this._mouseStart(this._mouseDownEvent,d)!==false);(this._mouseStarted?this._mouseDrag(d):this._mouseUp(d))}return !this._mouseStarted},_mouseUp:function(d){b(document).unbind("mousemove."+this.widgetName,this._mouseMoveDelegate).unbind("mouseup."+this.widgetName,this._mouseUpDelegate);if(this._mouseStarted){this._mouseStarted=false;if(d.target==this._mouseDownEvent.target){b.data(d.target,this.widgetName+".preventClickEvent",true)}this._mouseStop(d)}return false},_mouseDistanceMet:function(d){return(Math.max(Math.abs(this._mouseDownEvent.pageX-d.pageX),Math.abs(this._mouseDownEvent.pageY-d.pageY))>=this.options.distance)},_mouseDelayMet:function(d){return this.mouseDelayMet},_mouseStart:function(d){},_mouseDrag:function(d){},_mouseStop:function(d){},_mouseCapture:function(d){return true}})})(jQuery);(function(c,d){c.widget("ui.resizable",c.ui.mouse,{widgetEventPrefix:"resize",options:{alsoResize:false,animate:false,animateDuration:"slow",animateEasing:"swing",aspectRatio:false,autoHide:false,containment:false,ghost:false,grid:false,handles:"e,s,se",helper:false,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:1000},_create:function(){var f=this,k=this.options;this.element.addClass("ui-resizable");c.extend(this,{_aspectRatio:!!(k.aspectRatio),aspectRatio:k.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:k.helper||k.ghost||k.animate?k.helper||"ui-resizable-helper":null});if(this.element[0].nodeName.match(/canvas|textarea|input|select|button|img/i)){this.element.wrap(c('
').css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")}));this.element=this.element.parent().data("resizable",this.element.data("resizable"));this.elementIsWrapper=true;this.element.css({marginLeft:this.originalElement.css("marginLeft"),marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom")});this.originalElement.css({marginLeft:0,marginTop:0,marginRight:0,marginBottom:0});this.originalResizeStyle=this.originalElement.css("resize");this.originalElement.css("resize","none");this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"}));this.originalElement.css({margin:this.originalElement.css("margin")});this._proportionallyResize()}this.handles=k.handles||(!c(".ui-resizable-handle",this.element).length?"e,s,se":{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"});if(this.handles.constructor==String){if(this.handles=="all"){this.handles="n,e,s,w,se,sw,ne,nw"}var l=this.handles.split(",");this.handles={};for(var g=0;g
');if(/sw|se|ne|nw/.test(j)){h.css({zIndex:++k.zIndex})}if("se"==j){h.addClass("ui-icon ui-icon-gripsmall-diagonal-se")}this.handles[j]=".ui-resizable-"+j;this.element.append(h)}}this._renderAxis=function(q){q=q||this.element;for(var n in this.handles){if(this.handles[n].constructor==String){this.handles[n]=c(this.handles[n],this.element).show()}if(this.elementIsWrapper&&this.originalElement[0].nodeName.match(/textarea|input|select|button/i)){var o=c(this.handles[n],this.element),p=0;p=/sw|ne|nw|se|n|s/.test(n)?o.outerHeight():o.outerWidth();var m=["padding",/ne|nw|n/.test(n)?"Top":/se|sw|s/.test(n)?"Bottom":/^e$/.test(n)?"Right":"Left"].join("");q.css(m,p);this._proportionallyResize()}if(!c(this.handles[n]).length){continue}}};this._renderAxis(this.element);this._handles=c(".ui-resizable-handle",this.element).disableSelection();this._handles.mouseover(function(){if(!f.resizing){if(this.className){var i=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)}f.axis=i&&i[1]?i[1]:"se"}});if(k.autoHide){this._handles.hide();c(this.element).addClass("ui-resizable-autohide").hover(function(){if(k.disabled){return}c(this).removeClass("ui-resizable-autohide");f._handles.show()},function(){if(k.disabled){return}if(!f.resizing){c(this).addClass("ui-resizable-autohide");f._handles.hide()}})}this._mouseInit()},destroy:function(){this._mouseDestroy();var e=function(g){c(g).removeClass("ui-resizable ui-resizable-disabled ui-resizable-resizing").removeData("resizable").unbind(".resizable").find(".ui-resizable-handle").remove()};if(this.elementIsWrapper){e(this.element);var f=this.element;f.after(this.originalElement.css({position:f.css("position"),width:f.outerWidth(),height:f.outerHeight(),top:f.css("top"),left:f.css("left")})).remove()}this.originalElement.css("resize",this.originalResizeStyle);e(this.originalElement);return this},_mouseCapture:function(f){var g=false;for(var e in this.handles){if(c(this.handles[e])[0]==f.target){g=true}}return !this.options.disabled&&g},_mouseStart:function(g){var j=this.options,f=this.element.position(),e=this.element;this.resizing=true;this.documentScroll={top:c(document).scrollTop(),left:c(document).scrollLeft()};if(e.is(".ui-draggable")||(/absolute/).test(e.css("position"))){e.css({position:"absolute",top:f.top,left:f.left})}this._renderProxy();var k=b(this.helper.css("left")),h=b(this.helper.css("top"));if(j.containment){k+=c(j.containment).scrollLeft()||0;h+=c(j.containment).scrollTop()||0}this.offset=this.helper.offset();this.position={left:k,top:h};this.size=this._helper?{width:e.outerWidth(),height:e.outerHeight()}:{width:e.width(),height:e.height()};this.originalSize=this._helper?{width:e.outerWidth(),height:e.outerHeight()}:{width:e.width(),height:e.height()};this.originalPosition={left:k,top:h};this.sizeDiff={width:e.outerWidth()-e.width(),height:e.outerHeight()-e.height()};this.originalMousePosition={left:g.pageX,top:g.pageY};this.aspectRatio=(typeof j.aspectRatio=="number")?j.aspectRatio:((this.originalSize.width/this.originalSize.height)||1);var i=c(".ui-resizable-"+this.axis).css("cursor");c("body").css("cursor",i=="auto"?this.axis+"-resize":i);e.addClass("ui-resizable-resizing");this._propagate("start",g);return true},_mouseDrag:function(e){var h=this.helper,g=this.options,m={},q=this,j=this.originalMousePosition,n=this.axis;var r=(e.pageX-j.left)||0,p=(e.pageY-j.top)||0;var i=this._change[n];if(!i){return false}var l=i.apply(this,[e,r,p]),k=c.browser.msie&&c.browser.version<7,f=this.sizeDiff;this._updateVirtualBoundaries(e.shiftKey);if(this._aspectRatio||e.shiftKey){l=this._updateRatio(l,e)}l=this._respectSize(l,e);this._propagate("resize",e);h.css({top:this.position.top+"px",left:this.position.left+"px",width:this.size.width+"px",height:this.size.height+"px"});if(!this._helper&&this._proportionallyResizeElements.length){this._proportionallyResize()}this._updateCache(l);this._trigger("resize",e,this.ui());return false},_mouseStop:function(h){this.resizing=false;var i=this.options,m=this;if(this._helper){var g=this._proportionallyResizeElements,e=g.length&&(/textarea/i).test(g[0].nodeName),f=e&&c.ui.hasScroll(g[0],"left")?0:m.sizeDiff.height,k=e?0:m.sizeDiff.width;var n={width:(m.helper.width()-k),height:(m.helper.height()-f)},j=(parseInt(m.element.css("left"),10)+(m.position.left-m.originalPosition.left))||null,l=(parseInt(m.element.css("top"),10)+(m.position.top-m.originalPosition.top))||null;if(!i.animate){this.element.css(c.extend(n,{top:l,left:j}))}m.helper.height(m.size.height);m.helper.width(m.size.width);if(this._helper&&!i.animate){this._proportionallyResize()}}c("body").css("cursor","auto");this.element.removeClass("ui-resizable-resizing");this._propagate("stop",h);if(this._helper){this.helper.remove()}return false},_updateVirtualBoundaries:function(g){var j=this.options,i,h,f,k,e;e={minWidth:a(j.minWidth)?j.minWidth:0,maxWidth:a(j.maxWidth)?j.maxWidth:Infinity,minHeight:a(j.minHeight)?j.minHeight:0,maxHeight:a(j.maxHeight)?j.maxHeight:Infinity};if(this._aspectRatio||g){i=e.minHeight*this.aspectRatio;f=e.minWidth/this.aspectRatio;h=e.maxHeight*this.aspectRatio;k=e.maxWidth/this.aspectRatio;if(i>e.minWidth){e.minWidth=i}if(f>e.minHeight){e.minHeight=f}if(hl.width),s=a(l.height)&&i.minHeight&&(i.minHeight>l.height);if(h){l.width=i.minWidth}if(s){l.height=i.minHeight}if(t){l.width=i.maxWidth}if(m){l.height=i.maxHeight}var f=this.originalPosition.left+this.originalSize.width,p=this.position.top+this.size.height;var k=/sw|nw|w/.test(q),e=/nw|ne|n/.test(q);if(h&&k){l.left=f-i.minWidth}if(t&&k){l.left=f-i.maxWidth}if(s&&e){l.top=p-i.minHeight}if(m&&e){l.top=p-i.maxHeight}var n=!l.width&&!l.height;if(n&&!l.left&&l.top){l.top=null}else{if(n&&!l.top&&l.left){l.left=null}}return l},_proportionallyResize:function(){var k=this.options;if(!this._proportionallyResizeElements.length){return}var g=this.helper||this.element;for(var f=0;f');var e=c.browser.msie&&c.browser.version<7,g=(e?1:0),h=(e?2:-1);this.helper.addClass(this._helper).css({width:this.element.outerWidth()+h,height:this.element.outerHeight()+h,position:"absolute",left:this.elementOffset.left-g+"px",top:this.elementOffset.top-g+"px",zIndex:++i.zIndex});this.helper.appendTo("body").disableSelection()}else{this.helper=this.element}},_change:{e:function(g,f,e){return{width:this.originalSize.width+f}},w:function(h,f,e){var j=this.options,g=this.originalSize,i=this.originalPosition;return{left:i.left+f,width:g.width-f}},n:function(h,f,e){var j=this.options,g=this.originalSize,i=this.originalPosition;return{top:i.top+e,height:g.height-e}},s:function(g,f,e){return{height:this.originalSize.height+e}},se:function(g,f,e){return c.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[g,f,e]))},sw:function(g,f,e){return c.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[g,f,e]))},ne:function(g,f,e){return c.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[g,f,e]))},nw:function(g,f,e){return c.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[g,f,e]))}},_propagate:function(f,e){c.ui.plugin.call(this,f,[e,this.ui()]);(f!="resize"&&this._trigger(f,e,this.ui()))},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}});c.extend(c.ui.resizable,{version:"1.8.18"});c.ui.plugin.add("resizable","alsoResize",{start:function(f,g){var e=c(this).data("resizable"),i=e.options;var h=function(j){c(j).each(function(){var k=c(this);k.data("resizable-alsoresize",{width:parseInt(k.width(),10),height:parseInt(k.height(),10),left:parseInt(k.css("left"),10),top:parseInt(k.css("top"),10)})})};if(typeof(i.alsoResize)=="object"&&!i.alsoResize.parentNode){if(i.alsoResize.length){i.alsoResize=i.alsoResize[0];h(i.alsoResize)}else{c.each(i.alsoResize,function(j){h(j)})}}else{h(i.alsoResize)}},resize:function(g,i){var f=c(this).data("resizable"),j=f.options,h=f.originalSize,l=f.originalPosition;var k={height:(f.size.height-h.height)||0,width:(f.size.width-h.width)||0,top:(f.position.top-l.top)||0,left:(f.position.left-l.left)||0},e=function(m,n){c(m).each(function(){var q=c(this),r=c(this).data("resizable-alsoresize"),p={},o=n&&n.length?n:q.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];c.each(o,function(s,u){var t=(r[u]||0)+(k[u]||0);if(t&&t>=0){p[u]=t||null}});q.css(p)})};if(typeof(j.alsoResize)=="object"&&!j.alsoResize.nodeType){c.each(j.alsoResize,function(m,n){e(m,n)})}else{e(j.alsoResize)}},stop:function(e,f){c(this).removeData("resizable-alsoresize")}});c.ui.plugin.add("resizable","animate",{stop:function(i,n){var p=c(this).data("resizable"),j=p.options;var h=p._proportionallyResizeElements,e=h.length&&(/textarea/i).test(h[0].nodeName),f=e&&c.ui.hasScroll(h[0],"left")?0:p.sizeDiff.height,l=e?0:p.sizeDiff.width;var g={width:(p.size.width-l),height:(p.size.height-f)},k=(parseInt(p.element.css("left"),10)+(p.position.left-p.originalPosition.left))||null,m=(parseInt(p.element.css("top"),10)+(p.position.top-p.originalPosition.top))||null;p.element.animate(c.extend(g,m&&k?{top:m,left:k}:{}),{duration:j.animateDuration,easing:j.animateEasing,step:function(){var o={width:parseInt(p.element.css("width"),10),height:parseInt(p.element.css("height"),10),top:parseInt(p.element.css("top"),10),left:parseInt(p.element.css("left"),10)};if(h&&h.length){c(h[0]).css({width:o.width,height:o.height})}p._updateCache(o);p._propagate("resize",i)}})}});c.ui.plugin.add("resizable","containment",{start:function(f,r){var t=c(this).data("resizable"),j=t.options,l=t.element;var g=j.containment,k=(g instanceof c)?g.get(0):(/parent/.test(g))?l.parent().get(0):g;if(!k){return}t.containerElement=c(k);if(/document/.test(g)||g==document){t.containerOffset={left:0,top:0};t.containerPosition={left:0,top:0};t.parentData={element:c(document),left:0,top:0,width:c(document).width(),height:c(document).height()||document.body.parentNode.scrollHeight}}else{var n=c(k),i=[];c(["Top","Right","Left","Bottom"]).each(function(p,o){i[p]=b(n.css("padding"+o))});t.containerOffset=n.offset();t.containerPosition=n.position();t.containerSize={height:(n.innerHeight()-i[3]),width:(n.innerWidth()-i[1])};var q=t.containerOffset,e=t.containerSize.height,m=t.containerSize.width,h=(c.ui.hasScroll(k,"left")?k.scrollWidth:m),s=(c.ui.hasScroll(k)?k.scrollHeight:e);t.parentData={element:k,left:q.left,top:q.top,width:h,height:s}}},resize:function(g,q){var t=c(this).data("resizable"),i=t.options,f=t.containerSize,p=t.containerOffset,m=t.size,n=t.position,r=t._aspectRatio||g.shiftKey,e={top:0,left:0},h=t.containerElement;if(h[0]!=document&&(/static/).test(h.css("position"))){e=p}if(n.left<(t._helper?p.left:0)){t.size.width=t.size.width+(t._helper?(t.position.left-p.left):(t.position.left-e.left));if(r){t.size.height=t.size.width/i.aspectRatio}t.position.left=i.helper?p.left:0}if(n.top<(t._helper?p.top:0)){t.size.height=t.size.height+(t._helper?(t.position.top-p.top):t.position.top);if(r){t.size.width=t.size.height*i.aspectRatio}t.position.top=t._helper?p.top:0}t.offset.left=t.parentData.left+t.position.left;t.offset.top=t.parentData.top+t.position.top;var l=Math.abs((t._helper?t.offset.left-e.left:(t.offset.left-e.left))+t.sizeDiff.width),s=Math.abs((t._helper?t.offset.top-e.top:(t.offset.top-p.top))+t.sizeDiff.height);var k=t.containerElement.get(0)==t.element.parent().get(0),j=/relative|absolute/.test(t.containerElement.css("position"));if(k&&j){l-=t.parentData.left}if(l+t.size.width>=t.parentData.width){t.size.width=t.parentData.width-l;if(r){t.size.height=t.size.width/t.aspectRatio}}if(s+t.size.height>=t.parentData.height){t.size.height=t.parentData.height-s;if(r){t.size.width=t.size.height*t.aspectRatio}}},stop:function(f,n){var q=c(this).data("resizable"),g=q.options,l=q.position,m=q.containerOffset,e=q.containerPosition,i=q.containerElement;var j=c(q.helper),r=j.offset(),p=j.outerWidth()-q.sizeDiff.width,k=j.outerHeight()-q.sizeDiff.height;if(q._helper&&!g.animate&&(/relative/).test(i.css("position"))){c(this).css({left:r.left-e.left-m.left,width:p,height:k})}if(q._helper&&!g.animate&&(/static/).test(i.css("position"))){c(this).css({left:r.left-e.left-m.left,width:p,height:k})}}});c.ui.plugin.add("resizable","ghost",{start:function(g,h){var e=c(this).data("resizable"),i=e.options,f=e.size;e.ghost=e.originalElement.clone();e.ghost.css({opacity:0.25,display:"block",position:"relative",height:f.height,width:f.width,margin:0,left:0,top:0}).addClass("ui-resizable-ghost").addClass(typeof i.ghost=="string"?i.ghost:"");e.ghost.appendTo(e.helper)},resize:function(f,g){var e=c(this).data("resizable"),h=e.options;if(e.ghost){e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})}},stop:function(f,g){var e=c(this).data("resizable"),h=e.options;if(e.ghost&&e.helper){e.helper.get(0).removeChild(e.ghost.get(0))}}});c.ui.plugin.add("resizable","grid",{resize:function(e,m){var p=c(this).data("resizable"),h=p.options,k=p.size,i=p.originalSize,j=p.originalPosition,n=p.axis,l=h._aspectRatio||e.shiftKey;h.grid=typeof h.grid=="number"?[h.grid,h.grid]:h.grid;var g=Math.round((k.width-i.width)/(h.grid[0]||1))*(h.grid[0]||1),f=Math.round((k.height-i.height)/(h.grid[1]||1))*(h.grid[1]||1);if(/^(se|s|e)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f}else{if(/^(ne)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f;p.position.top=j.top-f}else{if(/^(sw)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f;p.position.left=j.left-g}else{p.size.width=i.width+g;p.size.height=i.height+f;p.position.top=j.top-f;p.position.left=j.left-g}}}}});var b=function(e){return parseInt(e,10)||0};var a=function(e){return !isNaN(parseInt(e,10))}})(jQuery);/*! + * jQuery hashchange event - v1.3 - 7/21/2010 + * http://benalman.com/projects/jquery-hashchange-plugin/ + * + * Copyright (c) 2010 "Cowboy" Ben Alman + * Dual licensed under the MIT and GPL licenses. + * http://benalman.com/about/license/ + */ +(function($,e,b){var c="hashchange",h=document,f,g=$.event.special,i=h.documentMode,d="on"+c in e&&(i===b||i>7);function a(j){j=j||location.href;return"#"+j.replace(/^[^#]*#?(.*)$/,"$1")}$.fn[c]=function(j){return j?this.bind(c,j):this.trigger(c)};$.fn[c].delay=50;g[c]=$.extend(g[c],{setup:function(){if(d){return false}$(f.start)},teardown:function(){if(d){return false}$(f.stop)}});f=(function(){var j={},p,m=a(),k=function(q){return q},l=k,o=k;j.start=function(){p||n()};j.stop=function(){p&&clearTimeout(p);p=b};function n(){var r=a(),q=o(m);if(r!==m){l(m=r,q);$(e).trigger(c)}else{if(q!==m){location.href=location.href.replace(/#.*/,"")+q}}p=setTimeout(n,$.fn[c].delay)}$.browser.msie&&!d&&(function(){var q,r;j.start=function(){if(!q){r=$.fn[c].src;r=r&&r+a();q=$(' + + + +
+
+
Changelog
+
+
+

v0.4.4 (13th May 2016)

+
    +
  • bump version because v0.4.3 was mistagged
    • +
+

v0.4.3 (13th May 2016)

+
    +
  • only release packages from gcc builds (Daniel Schauenberg)
    • +
+

v0.4.2 (13th May 2016)

+
    +
  • add an ldconfig script to package builds (Daniel Schauenberg)
    • +
  • Add option to set the Certificate Authority (CA) Info option. (tgoetze)
    • +
  • add clang to the travis build matrix (Daniel Schauenberg)
    • +
  • README: Update Advanced Example (Marc Zych)
    • +
  • Connection: Initialize timeout and followRedirects (Marc Zych)
    • +
+

v0.4.1 (2nd February 2016)

+
    +
  • fix package build to include new header files from refactoring
    • +
+

v0.4.0 (2nd February 2016)

+

Features

+

This is a major backwards-incompatible API refactor please read carefully

+
    +
  • split out into a simple and an advanced API
      +
    • simple API via static methods
      • +
    • advanced usage via a connection object
      • +
    +
    • +
  • support for custom user agent strings
    • +
  • support for connection pooling and keep-alive
    • +
  • support for following redirects
    • +
  • support for getting request metrics from the Connection object
    • +
+

Improvements and fixes

+
    +
  • increased test coverage
    • +
  • addition of valgrind and lint runs on CI
    • +
  • fixed some memory leaks
    • +
  • improved documentation coverage
    • +
+

v0.3.0 (10th January 2016)

+

Features

+
    +
  • added support for connection timeouts (Islam Yasar)
    • +
  • Allow for setting additional HTTP headers (Karol Samborski)
    • +
+

Improvements and Bug fixes

+
    +
  • improve general documentation and add docs for auth (Daniel Schauenberg)
    • +
  • remove calls to curl_global_cleanup (Daniel Schauenberg)
    • +
  • add unit test for basic auth (Daniel Schauenberg)
    • +
  • switch unit tests to use [http://httpbin.org]() (Daniel Schauenberg)
    • +
  • move two include instructions (Jos)
    • +
  • added reporting for test coverage (Daniel Schauenberg)
    • +
  • cleanup version gen to be driven by git tags (Daniel Schauenberg)
    • +
  • clean up build and support building on FreeBSD (Daniel Schauenberg)
    • +
  • automate package deployment to packagecloud (Daniel Schauenberg)
    • +
  • add automatic doc build & deploy (Daniel Schauenberg)
    • +
  • Ensure the built shared library does not have dynamic references to libgtest (Thomas Goetze)
    • +
+

v0.2.0 (19th April 2015)

+
    +
  • support basic auth
    • +
  • Add header's to response object
    • +
  • fix memory leaks related to curl cleanup
    • +
  • add autotools build
    • +
  • add CONTRIBUTING.md
    • +
  • add vendorized gtest
    • +
+

v0.1.2 (22nd March 2011)

+
    +
  • return -1 for failed query instead of exit(1)
    • +
  • add unit tests for failed query returncode == -1
    • +
  • fix typos in README and add more sections
    • +
  • include cstring for memcpy
    • +
  • add cstdlib as include for proper dependencies
    • +
+

v0.1.1 (27th October 2010)

+
    +
  • bump version to v0.1.1
    • +
  • add target for static library
    • +
  • add target for dynamic library
    • +
  • ignore lib folder in gitignore
    • +
  • include meta.h from local include folder
    • +
  • update README
    • +
+

v0.1.0 (15th October 2010)

+
    +
  • initial release
    • +
  • support basic HTTP verbs (GET, POST, PUT, DELETE)
    • +
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/md__c_o_n_t_r_i_b_u_t_i_n_g.html b/docs/ref/md__c_o_n_t_r_i_b_u_t_i_n_g.html new file mode 100644 index 00000000..c6e6757f --- /dev/null +++ b/docs/ref/md__c_o_n_t_r_i_b_u_t_i_n_g.html @@ -0,0 +1,106 @@ + + + + + + +restclient-cpp: Contribute + + + + + + + + + + +
+
+
+ + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
Contribute
+
+
+
    +
  • Fork the project.
    • +
  • Make your feature addition or bug fix.
    • +
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
    • +
  • Commit, do not mess with version
    • +
  • If you add functionality, document it in the README
    • +
  • Send me a pull request. Bonus points for topic branches.
    • +
+

How to run tests

+
    +
  1. build vendorized gtest: ./utils/build_gtest.sh
    2. +
  2. build restclient-cpp: ./autogen.sh && ./configure && make check
    3. +
  3. run the unit test suite: make test
    4. +
+
+ +
+Generated on Sun Nov 27 2016 21:27:11 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/namespace_rest_client.html b/docs/ref/namespace_rest_client.html new file mode 100644 index 00000000..953bb3b1 --- /dev/null +++ b/docs/ref/namespace_rest_client.html @@ -0,0 +1,332 @@ + + + + + + +restclient-cpp: RestClient Namespace Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ +
+
+
+Namespaces | +Classes | +Typedefs | +Functions
+
+
RestClient Namespace Reference
+
+
+ +

namespace for all RestClient definitions +More...

+ + + + + +

+Namespaces

 Helpers
 : namespace for all helper functions
 
+ + + + + + + +

+Classes

class  Connection
 Connection object for advanced usage. More...
 
struct  Response
 This structure represents the HTTP response data. More...
 
+ + + +

+Typedefs

typedef std::map< std::string, std::string > HeaderFields
 
+ + + + + + + + + + + + + + + + + + + + + + +

+Functions

+int init ()
 global init function. Call this before you start any threads.
 
+void disable ()
 global disable function. Call this before you terminate your program.
 
Response get (const std::string &url)
 HTTP GET method. More...
 
Response post (const std::string &url, const std::string &content_type, const std::string &data)
 HTTP POST method. More...
 
Response put (const std::string &url, const std::string &content_type, const std::string &data)
 HTTP PUT method. More...
 
Response del (const std::string &url)
 HTTP DELETE method. More...
 
Response head (const std::string &url)
 HTTP HEAD method. More...
 
+

Detailed Description

+

namespace for all RestClient definitions

+

Typedef Documentation

+ +
+
+ + + + +
typedef std::map<std::string, std::string> RestClient::HeaderFields
+
+

public data definitions

+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + +
RestClient::Response RestClient::del (const std::string & url)
+
+ +

HTTP DELETE method.

+
Parameters
+ + +
urlto query
+
+
+
Returns
response struct
+ +
+
+ +
+
+ + + + + + + + +
RestClient::Response RestClient::get (const std::string & url)
+
+ +

HTTP GET method.

+

public methods for the simple API. These don't allow a lot of configuration but are meant for simple HTTP calls.

+
Parameters
+ + +
urlto query
+
+
+
Returns
response struct
+ +
+
+ +
+
+ + + + + + + + +
RestClient::Response RestClient::head (const std::string & url)
+
+ +

HTTP HEAD method.

+
Parameters
+ + +
urlto query
+
+
+
Returns
response struct
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
RestClient::Response RestClient::post (const std::string & url,
const std::string & ctype,
const std::string & data 
)
+
+ +

HTTP POST method.

+
Parameters
+ + + + +
urlto query
ctypecontent type as string
dataHTTP POST body
+
+
+
Returns
response struct
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
RestClient::Response RestClient::put (const std::string & url,
const std::string & ctype,
const std::string & data 
)
+
+ +

HTTP PUT method.

+
Parameters
+ + + + +
urlto query
ctypecontent type as string
dataHTTP PUT body
+
+
+
Returns
response struct
+ +
+
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/namespace_rest_client_1_1_helpers.html b/docs/ref/namespace_rest_client_1_1_helpers.html new file mode 100644 index 00000000..1bbe321a --- /dev/null +++ b/docs/ref/namespace_rest_client_1_1_helpers.html @@ -0,0 +1,285 @@ + + + + + + +restclient-cpp: RestClient::Helpers Namespace Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Functions
+
+
RestClient::Helpers Namespace Reference
+
+
+ +

: namespace for all helper functions +More...

+ + + + + +

+Classes

struct  UploadObject
 This structure represents the payload to upload on POST requests. More...
 
+ + + + + + + + + + +

+Functions

size_t write_callback (void *ptr, size_t size, size_t nmemb, void *userdata)
 write callback function for libcurl More...
 
size_t header_callback (void *ptr, size_t size, size_t nmemb, void *userdata)
 header callback for libcurl More...
 
size_t read_callback (void *ptr, size_t size, size_t nmemb, void *userdata)
 read callback function for libcurl More...
 
+

Detailed Description

+

: namespace for all helper functions

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
size_t RestClient::Helpers::header_callback (void * data,
size_t size,
size_t nmemb,
void * userdata 
)
+
+ +

header callback for libcurl

+
Parameters
+ + + + + +
datareturned (header line)
sizeof data
nmembmemblock
userdatapointer to user data object to save headr data
+
+
+
Returns
size * nmemb;
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
size_t RestClient::Helpers::read_callback (void * data,
size_t size,
size_t nmemb,
void * userdata 
)
+
+ +

read callback function for libcurl

+
Parameters
+ + + + + +
datapointer of max size (size*nmemb) to write data to
sizesize parameter
nmembmemblock parameter
userdatapointer to user data to read data from
+
+
+
Returns
(size * nmemb)
+

get upload struct

+

set correct sizes

+

copy data to buffer

+

decrement length and increment data pointer

+

return copied size

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
size_t RestClient::Helpers::write_callback (void * data,
size_t size,
size_t nmemb,
void * userdata 
)
+
+ +

write callback function for libcurl

+
Parameters
+ + + + + +
datareturned data of size (size*nmemb)
sizesize parameter
nmembmemblock parameter
userdatapointer to user data to save/work with return data
+
+
+
Returns
(size * nmemb)
+ +
+
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/namespacemembers.html b/docs/ref/namespacemembers.html new file mode 100644 index 00000000..34e466d0 --- /dev/null +++ b/docs/ref/namespacemembers.html @@ -0,0 +1,136 @@ + + + + + + +restclient-cpp: Namespace Members + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+ +
+
+ + +
+ +
+ +
+
Here is a list of all documented namespace members with links to the namespaces they belong to:
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/namespacemembers_func.html b/docs/ref/namespacemembers_func.html new file mode 100644 index 00000000..2c2a7b29 --- /dev/null +++ b/docs/ref/namespacemembers_func.html @@ -0,0 +1,133 @@ + + + + + + +restclient-cpp: Namespace Members + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+ +
+
+ + +
+ +
+ +
+  +
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/namespacemembers_type.html b/docs/ref/namespacemembers_type.html new file mode 100644 index 00000000..601147a2 --- /dev/null +++ b/docs/ref/namespacemembers_type.html @@ -0,0 +1,106 @@ + + + + + + +restclient-cpp: Namespace Members + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+ +
+
+ + +
+ +
+ +
+  +
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/namespaces.html b/docs/ref/namespaces.html new file mode 100644 index 00000000..7559672f --- /dev/null +++ b/docs/ref/namespaces.html @@ -0,0 +1,104 @@ + + + + + + +restclient-cpp: Namespace List + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + +
+ +
+
+ + +
+ +
+ +
+
+
Namespace List
+
+
+
Here is a list of all documented namespaces with brief descriptions:
+
[detail level 12]
+ + +
 ▼NRestClientNamespace for all RestClient definitions
 NHelpers: namespace for all helper functions
+
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/nav_f.png b/docs/ref/nav_f.png new file mode 100644 index 00000000..72a58a52 Binary files /dev/null and b/docs/ref/nav_f.png differ diff --git a/docs/ref/nav_g.png b/docs/ref/nav_g.png new file mode 100644 index 00000000..2093a237 Binary files /dev/null and b/docs/ref/nav_g.png differ diff --git a/docs/ref/nav_h.png b/docs/ref/nav_h.png new file mode 100644 index 00000000..33389b10 Binary files /dev/null and b/docs/ref/nav_h.png differ diff --git a/docs/ref/open.png b/docs/ref/open.png new file mode 100644 index 00000000..30f75c7e Binary files /dev/null and b/docs/ref/open.png differ diff --git a/docs/ref/pages.html b/docs/ref/pages.html new file mode 100644 index 00000000..0d489b85 --- /dev/null +++ b/docs/ref/pages.html @@ -0,0 +1,97 @@ + + + + + + +restclient-cpp: Related Pages + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + +
+ +
+
+ + +
+ +
+ +
+
+
Related Pages
+
+
+
Here is a list of all related documentation pages:
+ + +
 Changelog
+
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/restclient_8h.html b/docs/ref/restclient_8h.html new file mode 100644 index 00000000..5a633c69 --- /dev/null +++ b/docs/ref/restclient_8h.html @@ -0,0 +1,165 @@ + + + + + + +restclient-cpp: include/restclient-cpp/restclient.h File Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Namespaces | +Typedefs | +Functions
+
+
restclient.h File Reference
+
+
+ +

libcurl wrapper for REST calls +More...

+
#include <curl/curl.h>
+#include <string>
+#include <map>
+#include <cstdlib>
+#include "restclient-cpp/version.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

struct  RestClient::Response
 This structure represents the HTTP response data. More...
 
+ + + + +

+Namespaces

 RestClient
 namespace for all RestClient definitions
 
+ + + +

+Typedefs

typedef std::map< std::string, std::string > RestClient::HeaderFields
 
+ + + + + + + + + + + + + + + + + + + + + + +

+Functions

+int RestClient::init ()
 global init function. Call this before you start any threads.
 
+void RestClient::disable ()
 global disable function. Call this before you terminate your program.
 
Response RestClient::get (const std::string &url)
 HTTP GET method. More...
 
Response RestClient::post (const std::string &url, const std::string &content_type, const std::string &data)
 HTTP POST method. More...
 
Response RestClient::put (const std::string &url, const std::string &content_type, const std::string &data)
 HTTP PUT method. More...
 
Response RestClient::del (const std::string &url)
 HTTP DELETE method. More...
 
Response RestClient::head (const std::string &url)
 HTTP HEAD method. More...
 
+

Detailed Description

+

libcurl wrapper for REST calls

+
Author
Daniel Schauenberg d@unw.nosp@m.ired.nosp@m.couch.nosp@m..com
+
Version
+
Date
2010-10-11
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/restclient_8h_source.html b/docs/ref/restclient_8h_source.html new file mode 100644 index 00000000..ebbbf49e --- /dev/null +++ b/docs/ref/restclient_8h_source.html @@ -0,0 +1,151 @@ + + + + + + +restclient-cpp: include/restclient-cpp/restclient.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
restclient.h
+
+
+Go to the documentation of this file.
1 
+
9 #ifndef INCLUDE_RESTCLIENT_CPP_RESTCLIENT_H_
+
10 #define INCLUDE_RESTCLIENT_CPP_RESTCLIENT_H_
+
11 
+
12 #include <curl/curl.h>
+
13 #include <string>
+
14 #include <map>
+
15 #include <cstdlib>
+
16 
+
17 #include "restclient-cpp/version.h"
+
18 
+
22 namespace RestClient {
+
23 
+
27 typedef std::map<std::string, std::string> HeaderFields;
+
28 
+
38 typedef struct {
+
39  int code;
+
40  std::string body;
+
41  HeaderFields headers;
+
42 } Response;
+
43 
+
44 // init and disable functions
+
45 int init();
+
46 void disable();
+
47 
+
53 Response get(const std::string& url);
+
54 Response post(const std::string& url,
+
55  const std::string& content_type,
+
56  const std::string& data);
+
57 Response put(const std::string& url,
+
58  const std::string& content_type,
+
59  const std::string& data);
+
60 Response del(const std::string& url);
+
61 Response head(const std::string& url);
+
62 
+
63 } // namespace RestClient
+
64 
+
65 #endif // INCLUDE_RESTCLIENT_CPP_RESTCLIENT_H_
+
RestClient::Response::headers
HeaderFields headers
Definition: restclient.h:41
+
RestClient::Response::code
int code
Definition: restclient.h:39
+
RestClient::Response
This structure represents the HTTP response data.
Definition: restclient.h:38
+
RestClient::HeaderFields
std::map< std::string, std::string > HeaderFields
Definition: restclient.h:27
+
RestClient::disable
void disable()
global disable function. Call this before you terminate your program.
Definition: restclient.cc:37
+
RestClient::head
Response head(const std::string &url)
HTTP HEAD method.
Definition: restclient.cc:118
+
RestClient::del
Response del(const std::string &url)
HTTP DELETE method.
Definition: restclient.cc:103
+
RestClient::put
Response put(const std::string &url, const std::string &content_type, const std::string &data)
HTTP PUT method.
Definition: restclient.cc:85
+
RestClient::post
Response post(const std::string &url, const std::string &content_type, const std::string &data)
HTTP POST method.
Definition: restclient.cc:65
+
RestClient::init
int init()
global init function. Call this before you start any threads.
Definition: restclient.cc:24
+
RestClient::Response::body
std::string body
Definition: restclient.h:40
+
RestClient
namespace for all RestClient definitions
Definition: connection.h:23
+
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/search/all_0.html b/docs/ref/search/all_0.html new file mode 100644 index 00000000..c491fd8f --- /dev/null +++ b/docs/ref/search/all_0.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_0.js b/docs/ref/search/all_0.js new file mode 100644 index 00000000..eafb95cb --- /dev/null +++ b/docs/ref/search/all_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['appconnecttime',['appConnectTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a05d4f74f97a3e02cb9bbe3a6039135bc',1,'RestClient::Connection::RequestInfo']]], + ['appendheader',['AppendHeader',['../class_rest_client_1_1_connection.html#a60fd7521bfb4f604e6c7cdd278f038b3',1,'RestClient::Connection']]] +]; diff --git a/docs/ref/search/all_1.html b/docs/ref/search/all_1.html new file mode 100644 index 00000000..89fd5f83 --- /dev/null +++ b/docs/ref/search/all_1.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_1.js b/docs/ref/search/all_1.js new file mode 100644 index 00000000..885da35c --- /dev/null +++ b/docs/ref/search/all_1.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['baseurl',['baseUrl',['../struct_rest_client_1_1_connection_1_1_info.html#ae908949ed901ed0883da20efad56cf67',1,'RestClient::Connection::Info']]], + ['basicauth',['basicAuth',['../struct_rest_client_1_1_connection_1_1_info.html#ac659be6ed4f5f699ca7609b1e0f6863d',1,'RestClient::Connection::Info']]], + ['body',['body',['../struct_rest_client_1_1_response.html#a87ba6d5e5ae9ae7d628d5ed34b36cc95',1,'RestClient::Response']]] +]; diff --git a/docs/ref/search/all_2.html b/docs/ref/search/all_2.html new file mode 100644 index 00000000..2c23ed46 --- /dev/null +++ b/docs/ref/search/all_2.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_2.js b/docs/ref/search/all_2.js new file mode 100644 index 00000000..522517e9 --- /dev/null +++ b/docs/ref/search/all_2.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['code',['code',['../struct_rest_client_1_1_response.html#a3b3b63aeae7ca761d54a009ee329ea28',1,'RestClient::Response']]], + ['connection',['Connection',['../class_rest_client_1_1_connection.html#a658af2c6d1300c8a02e7f6436b43b4c9',1,'RestClient::Connection']]], + ['connection',['Connection',['../class_rest_client_1_1_connection.html',1,'RestClient']]], + ['connection_2eh',['connection.h',['../connection_8h.html',1,'']]], + ['connecttime',['connectTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a7c8347cc41e35a944663d333baea88a9',1,'RestClient::Connection::RequestInfo']]], + ['customuseragent',['customUserAgent',['../struct_rest_client_1_1_connection_1_1_info.html#a8cec6f505e26773638ea7c2df895b5e8',1,'RestClient::Connection::Info']]], + ['changelog',['Changelog',['../md__c_h_a_n_g_e_l_o_g.html',1,'']]] +]; diff --git a/docs/ref/search/all_3.html b/docs/ref/search/all_3.html new file mode 100644 index 00000000..7ddb0cfb --- /dev/null +++ b/docs/ref/search/all_3.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_3.js b/docs/ref/search/all_3.js new file mode 100644 index 00000000..312c6d1c --- /dev/null +++ b/docs/ref/search/all_3.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['data',['data',['../struct_rest_client_1_1_helpers_1_1_upload_object.html#a0f0bebacc6bb930899ee9babadb92a31',1,'RestClient::Helpers::UploadObject']]], + ['del',['del',['../class_rest_client_1_1_connection.html#a4a14035f66375a7291f9d16d87db41f2',1,'RestClient::Connection::del()'],['../namespace_rest_client.html#a52975c3a96fe5f90b40adc74faae8f94',1,'RestClient::del()']]], + ['disable',['disable',['../namespace_rest_client.html#aa4dc1337561e6622b013d22639d3d26c',1,'RestClient']]] +]; diff --git a/docs/ref/search/all_4.html b/docs/ref/search/all_4.html new file mode 100644 index 00000000..eab9eb1b --- /dev/null +++ b/docs/ref/search/all_4.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_4.js b/docs/ref/search/all_4.js new file mode 100644 index 00000000..43390dbe --- /dev/null +++ b/docs/ref/search/all_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['followredirects',['FollowRedirects',['../class_rest_client_1_1_connection.html#a77c9d405950492f9bcec21ce79edd2b3',1,'RestClient::Connection::FollowRedirects()'],['../struct_rest_client_1_1_connection_1_1_info.html#a4b194ea487bf48f55e597b3146bc0c9b',1,'RestClient::Connection::Info::followRedirects()']]] +]; diff --git a/docs/ref/search/all_5.html b/docs/ref/search/all_5.html new file mode 100644 index 00000000..4dfd1d50 --- /dev/null +++ b/docs/ref/search/all_5.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_5.js b/docs/ref/search/all_5.js new file mode 100644 index 00000000..29443667 --- /dev/null +++ b/docs/ref/search/all_5.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['get',['get',['../class_rest_client_1_1_connection.html#ad52e3500f995cb681b5f3d7f83d36418',1,'RestClient::Connection::get()'],['../namespace_rest_client.html#a4b542b597eb854401c02520af258006f',1,'RestClient::get()']]], + ['getheaders',['GetHeaders',['../class_rest_client_1_1_connection.html#afa869b17f4fb6387c057bfb9fcbd0bbf',1,'RestClient::Connection']]], + ['getinfo',['GetInfo',['../class_rest_client_1_1_connection.html#ac489a801edc621a384cdfb29e7071231',1,'RestClient::Connection']]], + ['getuseragent',['GetUserAgent',['../class_rest_client_1_1_connection.html#aa4353eb1df932b254aa02446f4ac3b32',1,'RestClient::Connection']]] +]; diff --git a/docs/ref/search/all_6.html b/docs/ref/search/all_6.html new file mode 100644 index 00000000..b98d7310 --- /dev/null +++ b/docs/ref/search/all_6.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_6.js b/docs/ref/search/all_6.js new file mode 100644 index 00000000..c3aa5aa9 --- /dev/null +++ b/docs/ref/search/all_6.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['head',['head',['../class_rest_client_1_1_connection.html#a64f085227c8c4d47dc6c84fea4f71398',1,'RestClient::Connection::head()'],['../namespace_rest_client.html#a99dee400dfdab150b9fdce2ab6a0c2dc',1,'RestClient::head()']]], + ['header_5fcallback',['header_callback',['../namespace_rest_client_1_1_helpers.html#a464be55c71cef59eebb53d922956a4d1',1,'RestClient::Helpers']]], + ['headerfields',['HeaderFields',['../namespace_rest_client.html#ab2bbc7fd5ec10171e4e1fb2d7fc8e865',1,'RestClient']]], + ['headers',['headers',['../struct_rest_client_1_1_connection_1_1_info.html#a8e9c9ad0c74a6e6f5c73ced7306464d1',1,'RestClient::Connection::Info::headers()'],['../struct_rest_client_1_1_response.html#a2141b4d9929e0df26d918dfba8451496',1,'RestClient::Response::headers()']]], + ['helpers_2eh',['helpers.h',['../helpers_8h.html',1,'']]] +]; diff --git a/docs/ref/search/all_7.html b/docs/ref/search/all_7.html new file mode 100644 index 00000000..ef202229 --- /dev/null +++ b/docs/ref/search/all_7.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_7.js b/docs/ref/search/all_7.js new file mode 100644 index 00000000..2af06994 --- /dev/null +++ b/docs/ref/search/all_7.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['info',['Info',['../struct_rest_client_1_1_connection_1_1_info.html',1,'RestClient::Connection']]], + ['init',['init',['../namespace_rest_client.html#a38395626a68f2dc66e2acf5b01f5b70b',1,'RestClient']]] +]; diff --git a/docs/ref/search/all_8.html b/docs/ref/search/all_8.html new file mode 100644 index 00000000..12e5aff1 --- /dev/null +++ b/docs/ref/search/all_8.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_8.js b/docs/ref/search/all_8.js new file mode 100644 index 00000000..359ed049 --- /dev/null +++ b/docs/ref/search/all_8.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['lastrequest',['lastRequest',['../struct_rest_client_1_1_connection_1_1_info.html#ac9393ffec292dc9ef1f9378bf0df5f31',1,'RestClient::Connection::Info']]], + ['length',['length',['../struct_rest_client_1_1_helpers_1_1_upload_object.html#a8cfb479c87d4870a7e54e62dc0a3d3f6',1,'RestClient::Helpers::UploadObject']]] +]; diff --git a/docs/ref/search/all_9.html b/docs/ref/search/all_9.html new file mode 100644 index 00000000..7e100075 --- /dev/null +++ b/docs/ref/search/all_9.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_9.js b/docs/ref/search/all_9.js new file mode 100644 index 00000000..8bbc8dc8 --- /dev/null +++ b/docs/ref/search/all_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['namelookuptime',['nameLookupTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a73d3bab1fd832feb912f1e20656b185d',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/search/all_a.html b/docs/ref/search/all_a.html new file mode 100644 index 00000000..95b4c8fc --- /dev/null +++ b/docs/ref/search/all_a.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_a.js b/docs/ref/search/all_a.js new file mode 100644 index 00000000..5a9fb554 --- /dev/null +++ b/docs/ref/search/all_a.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['post',['post',['../class_rest_client_1_1_connection.html#a76b11e6e01fb84cafdacf99e49aae6a7',1,'RestClient::Connection::post()'],['../namespace_rest_client.html#a7de7aa2d333b6e7c5f2c2726d4e5485e',1,'RestClient::post()']]], + ['pretransfertime',['preTransferTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#abcccb563d60a3f5325918ef912130e16',1,'RestClient::Connection::RequestInfo']]], + ['put',['put',['../class_rest_client_1_1_connection.html#af1a30c5aa6a646e6bad4caf2abb7084c',1,'RestClient::Connection::put()'],['../namespace_rest_client.html#ac180f6320d47cad592399378f8c45f7a',1,'RestClient::put()']]] +]; diff --git a/docs/ref/search/all_b.html b/docs/ref/search/all_b.html new file mode 100644 index 00000000..1f1beb55 --- /dev/null +++ b/docs/ref/search/all_b.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_b.js b/docs/ref/search/all_b.js new file mode 100644 index 00000000..b7c1d162 --- /dev/null +++ b/docs/ref/search/all_b.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['helpers',['Helpers',['../namespace_rest_client_1_1_helpers.html',1,'RestClient']]], + ['read_5fcallback',['read_callback',['../namespace_rest_client_1_1_helpers.html#a1209e4977d76d9be7d8b40328bcb464d',1,'RestClient::Helpers']]], + ['redirectcount',['redirectCount',['../struct_rest_client_1_1_connection_1_1_request_info.html#ab0240290fa51b11468936199ff0c248f',1,'RestClient::Connection::RequestInfo']]], + ['redirecttime',['redirectTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#af219b63ad58cb52748ba7afd5b2290aa',1,'RestClient::Connection::RequestInfo']]], + ['requestinfo',['RequestInfo',['../struct_rest_client_1_1_connection_1_1_request_info.html',1,'RestClient::Connection']]], + ['response',['Response',['../struct_rest_client_1_1_response.html',1,'RestClient']]], + ['restclient',['RestClient',['../namespace_rest_client.html',1,'']]], + ['restclient_2eh',['restclient.h',['../restclient_8h.html',1,'']]] +]; diff --git a/docs/ref/search/all_c.html b/docs/ref/search/all_c.html new file mode 100644 index 00000000..ec9a0c84 --- /dev/null +++ b/docs/ref/search/all_c.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_c.js b/docs/ref/search/all_c.js new file mode 100644 index 00000000..8064dad1 --- /dev/null +++ b/docs/ref/search/all_c.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['setbasicauth',['SetBasicAuth',['../class_rest_client_1_1_connection.html#a9fdc2ee1b3b2cc2cca1f9fd29e6fd73f',1,'RestClient::Connection']]], + ['setcainfofilepath',['SetCAInfoFilePath',['../class_rest_client_1_1_connection.html#afd74a344a00b58fc6997e34c37dde834',1,'RestClient::Connection']]], + ['setheaders',['SetHeaders',['../class_rest_client_1_1_connection.html#a6af41bf467a80deb83f20044f2c17344',1,'RestClient::Connection']]], + ['settimeout',['SetTimeout',['../class_rest_client_1_1_connection.html#ad7b6f92f59861b4c8dc914d4d226d89d',1,'RestClient::Connection']]], + ['setuseragent',['SetUserAgent',['../class_rest_client_1_1_connection.html#a3e510fdf8291e9e277df72b0fae0a111',1,'RestClient::Connection']]], + ['starttransfertime',['startTransferTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a022ad817c51c37e781d3ef6590b47d96',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/search/all_d.html b/docs/ref/search/all_d.html new file mode 100644 index 00000000..654d1988 --- /dev/null +++ b/docs/ref/search/all_d.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_d.js b/docs/ref/search/all_d.js new file mode 100644 index 00000000..8483af7b --- /dev/null +++ b/docs/ref/search/all_d.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['timeout',['timeout',['../struct_rest_client_1_1_connection_1_1_info.html#a0a63e442ce474e50017fcbae563c4a7c',1,'RestClient::Connection::Info']]], + ['totaltime',['totalTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a5febf41f2662384129b874e195e1c01e',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/search/all_e.html b/docs/ref/search/all_e.html new file mode 100644 index 00000000..812aced8 --- /dev/null +++ b/docs/ref/search/all_e.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_e.js b/docs/ref/search/all_e.js new file mode 100644 index 00000000..81fcdd5a --- /dev/null +++ b/docs/ref/search/all_e.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['uploadobject',['UploadObject',['../struct_rest_client_1_1_helpers_1_1_upload_object.html',1,'RestClient::Helpers']]] +]; diff --git a/docs/ref/search/all_f.html b/docs/ref/search/all_f.html new file mode 100644 index 00000000..c395a474 --- /dev/null +++ b/docs/ref/search/all_f.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/all_f.js b/docs/ref/search/all_f.js new file mode 100644 index 00000000..3fbfbab8 --- /dev/null +++ b/docs/ref/search/all_f.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['write_5fcallback',['write_callback',['../namespace_rest_client_1_1_helpers.html#a1dfc03258041ee29084ef9cf566ab836',1,'RestClient::Helpers']]] +]; diff --git a/docs/ref/search/classes_0.html b/docs/ref/search/classes_0.html new file mode 100644 index 00000000..8888fa80 --- /dev/null +++ b/docs/ref/search/classes_0.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/classes_0.js b/docs/ref/search/classes_0.js new file mode 100644 index 00000000..e4adc525 --- /dev/null +++ b/docs/ref/search/classes_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['connection',['Connection',['../class_rest_client_1_1_connection.html',1,'RestClient']]] +]; diff --git a/docs/ref/search/classes_1.html b/docs/ref/search/classes_1.html new file mode 100644 index 00000000..a402bbef --- /dev/null +++ b/docs/ref/search/classes_1.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/classes_1.js b/docs/ref/search/classes_1.js new file mode 100644 index 00000000..1d2d2c98 --- /dev/null +++ b/docs/ref/search/classes_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['info',['Info',['../struct_rest_client_1_1_connection_1_1_info.html',1,'RestClient::Connection']]] +]; diff --git a/docs/ref/search/classes_2.html b/docs/ref/search/classes_2.html new file mode 100644 index 00000000..003214bb --- /dev/null +++ b/docs/ref/search/classes_2.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/classes_2.js b/docs/ref/search/classes_2.js new file mode 100644 index 00000000..a2dd4c85 --- /dev/null +++ b/docs/ref/search/classes_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['requestinfo',['RequestInfo',['../struct_rest_client_1_1_connection_1_1_request_info.html',1,'RestClient::Connection']]], + ['response',['Response',['../struct_rest_client_1_1_response.html',1,'RestClient']]] +]; diff --git a/docs/ref/search/classes_3.html b/docs/ref/search/classes_3.html new file mode 100644 index 00000000..fadcfc83 --- /dev/null +++ b/docs/ref/search/classes_3.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/classes_3.js b/docs/ref/search/classes_3.js new file mode 100644 index 00000000..81fcdd5a --- /dev/null +++ b/docs/ref/search/classes_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['uploadobject',['UploadObject',['../struct_rest_client_1_1_helpers_1_1_upload_object.html',1,'RestClient::Helpers']]] +]; diff --git a/docs/ref/search/close.png b/docs/ref/search/close.png new file mode 100644 index 00000000..9342d3df Binary files /dev/null and b/docs/ref/search/close.png differ diff --git a/docs/ref/search/files_0.html b/docs/ref/search/files_0.html new file mode 100644 index 00000000..04578537 --- /dev/null +++ b/docs/ref/search/files_0.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/files_0.js b/docs/ref/search/files_0.js new file mode 100644 index 00000000..52426caf --- /dev/null +++ b/docs/ref/search/files_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['connection_2eh',['connection.h',['../connection_8h.html',1,'']]] +]; diff --git a/docs/ref/search/files_1.html b/docs/ref/search/files_1.html new file mode 100644 index 00000000..ce0a3a7a --- /dev/null +++ b/docs/ref/search/files_1.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/files_1.js b/docs/ref/search/files_1.js new file mode 100644 index 00000000..d9d90b08 --- /dev/null +++ b/docs/ref/search/files_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['helpers_2eh',['helpers.h',['../helpers_8h.html',1,'']]] +]; diff --git a/docs/ref/search/files_2.html b/docs/ref/search/files_2.html new file mode 100644 index 00000000..d188d98a --- /dev/null +++ b/docs/ref/search/files_2.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/files_2.js b/docs/ref/search/files_2.js new file mode 100644 index 00000000..df1528b1 --- /dev/null +++ b/docs/ref/search/files_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['restclient_2eh',['restclient.h',['../restclient_8h.html',1,'']]] +]; diff --git a/docs/ref/search/functions_0.html b/docs/ref/search/functions_0.html new file mode 100644 index 00000000..88c8a268 --- /dev/null +++ b/docs/ref/search/functions_0.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_0.js b/docs/ref/search/functions_0.js new file mode 100644 index 00000000..2eb7fbbf --- /dev/null +++ b/docs/ref/search/functions_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['appendheader',['AppendHeader',['../class_rest_client_1_1_connection.html#a60fd7521bfb4f604e6c7cdd278f038b3',1,'RestClient::Connection']]] +]; diff --git a/docs/ref/search/functions_1.html b/docs/ref/search/functions_1.html new file mode 100644 index 00000000..215c1bf6 --- /dev/null +++ b/docs/ref/search/functions_1.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_1.js b/docs/ref/search/functions_1.js new file mode 100644 index 00000000..50199c4a --- /dev/null +++ b/docs/ref/search/functions_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['connection',['Connection',['../class_rest_client_1_1_connection.html#a658af2c6d1300c8a02e7f6436b43b4c9',1,'RestClient::Connection']]] +]; diff --git a/docs/ref/search/functions_2.html b/docs/ref/search/functions_2.html new file mode 100644 index 00000000..f17abffc --- /dev/null +++ b/docs/ref/search/functions_2.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_2.js b/docs/ref/search/functions_2.js new file mode 100644 index 00000000..1b8322a8 --- /dev/null +++ b/docs/ref/search/functions_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['del',['del',['../class_rest_client_1_1_connection.html#a4a14035f66375a7291f9d16d87db41f2',1,'RestClient::Connection::del()'],['../namespace_rest_client.html#a52975c3a96fe5f90b40adc74faae8f94',1,'RestClient::del()']]], + ['disable',['disable',['../namespace_rest_client.html#aa4dc1337561e6622b013d22639d3d26c',1,'RestClient']]] +]; diff --git a/docs/ref/search/functions_3.html b/docs/ref/search/functions_3.html new file mode 100644 index 00000000..8a4bbe14 --- /dev/null +++ b/docs/ref/search/functions_3.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_3.js b/docs/ref/search/functions_3.js new file mode 100644 index 00000000..7ebfe6ca --- /dev/null +++ b/docs/ref/search/functions_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['followredirects',['FollowRedirects',['../class_rest_client_1_1_connection.html#a77c9d405950492f9bcec21ce79edd2b3',1,'RestClient::Connection']]] +]; diff --git a/docs/ref/search/functions_4.html b/docs/ref/search/functions_4.html new file mode 100644 index 00000000..cce7ce90 --- /dev/null +++ b/docs/ref/search/functions_4.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_4.js b/docs/ref/search/functions_4.js new file mode 100644 index 00000000..29443667 --- /dev/null +++ b/docs/ref/search/functions_4.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['get',['get',['../class_rest_client_1_1_connection.html#ad52e3500f995cb681b5f3d7f83d36418',1,'RestClient::Connection::get()'],['../namespace_rest_client.html#a4b542b597eb854401c02520af258006f',1,'RestClient::get()']]], + ['getheaders',['GetHeaders',['../class_rest_client_1_1_connection.html#afa869b17f4fb6387c057bfb9fcbd0bbf',1,'RestClient::Connection']]], + ['getinfo',['GetInfo',['../class_rest_client_1_1_connection.html#ac489a801edc621a384cdfb29e7071231',1,'RestClient::Connection']]], + ['getuseragent',['GetUserAgent',['../class_rest_client_1_1_connection.html#aa4353eb1df932b254aa02446f4ac3b32',1,'RestClient::Connection']]] +]; diff --git a/docs/ref/search/functions_5.html b/docs/ref/search/functions_5.html new file mode 100644 index 00000000..e2f6e313 --- /dev/null +++ b/docs/ref/search/functions_5.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_5.js b/docs/ref/search/functions_5.js new file mode 100644 index 00000000..81f4d441 --- /dev/null +++ b/docs/ref/search/functions_5.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['head',['head',['../class_rest_client_1_1_connection.html#a64f085227c8c4d47dc6c84fea4f71398',1,'RestClient::Connection::head()'],['../namespace_rest_client.html#a99dee400dfdab150b9fdce2ab6a0c2dc',1,'RestClient::head()']]], + ['header_5fcallback',['header_callback',['../namespace_rest_client_1_1_helpers.html#a464be55c71cef59eebb53d922956a4d1',1,'RestClient::Helpers']]] +]; diff --git a/docs/ref/search/functions_6.html b/docs/ref/search/functions_6.html new file mode 100644 index 00000000..342a0762 --- /dev/null +++ b/docs/ref/search/functions_6.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_6.js b/docs/ref/search/functions_6.js new file mode 100644 index 00000000..af717672 --- /dev/null +++ b/docs/ref/search/functions_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['init',['init',['../namespace_rest_client.html#a38395626a68f2dc66e2acf5b01f5b70b',1,'RestClient']]] +]; diff --git a/docs/ref/search/functions_7.html b/docs/ref/search/functions_7.html new file mode 100644 index 00000000..04db8a64 --- /dev/null +++ b/docs/ref/search/functions_7.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_7.js b/docs/ref/search/functions_7.js new file mode 100644 index 00000000..6e0c49fd --- /dev/null +++ b/docs/ref/search/functions_7.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['post',['post',['../class_rest_client_1_1_connection.html#a76b11e6e01fb84cafdacf99e49aae6a7',1,'RestClient::Connection::post()'],['../namespace_rest_client.html#a7de7aa2d333b6e7c5f2c2726d4e5485e',1,'RestClient::post()']]], + ['put',['put',['../class_rest_client_1_1_connection.html#af1a30c5aa6a646e6bad4caf2abb7084c',1,'RestClient::Connection::put()'],['../namespace_rest_client.html#ac180f6320d47cad592399378f8c45f7a',1,'RestClient::put()']]] +]; diff --git a/docs/ref/search/functions_8.html b/docs/ref/search/functions_8.html new file mode 100644 index 00000000..6bab2c81 --- /dev/null +++ b/docs/ref/search/functions_8.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_8.js b/docs/ref/search/functions_8.js new file mode 100644 index 00000000..c01c9a03 --- /dev/null +++ b/docs/ref/search/functions_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['read_5fcallback',['read_callback',['../namespace_rest_client_1_1_helpers.html#a1209e4977d76d9be7d8b40328bcb464d',1,'RestClient::Helpers']]] +]; diff --git a/docs/ref/search/functions_9.html b/docs/ref/search/functions_9.html new file mode 100644 index 00000000..e32df637 --- /dev/null +++ b/docs/ref/search/functions_9.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_9.js b/docs/ref/search/functions_9.js new file mode 100644 index 00000000..69b4a30b --- /dev/null +++ b/docs/ref/search/functions_9.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['setbasicauth',['SetBasicAuth',['../class_rest_client_1_1_connection.html#a9fdc2ee1b3b2cc2cca1f9fd29e6fd73f',1,'RestClient::Connection']]], + ['setcainfofilepath',['SetCAInfoFilePath',['../class_rest_client_1_1_connection.html#afd74a344a00b58fc6997e34c37dde834',1,'RestClient::Connection']]], + ['setheaders',['SetHeaders',['../class_rest_client_1_1_connection.html#a6af41bf467a80deb83f20044f2c17344',1,'RestClient::Connection']]], + ['settimeout',['SetTimeout',['../class_rest_client_1_1_connection.html#ad7b6f92f59861b4c8dc914d4d226d89d',1,'RestClient::Connection']]], + ['setuseragent',['SetUserAgent',['../class_rest_client_1_1_connection.html#a3e510fdf8291e9e277df72b0fae0a111',1,'RestClient::Connection']]] +]; diff --git a/docs/ref/search/functions_a.html b/docs/ref/search/functions_a.html new file mode 100644 index 00000000..1ae07c72 --- /dev/null +++ b/docs/ref/search/functions_a.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/functions_a.js b/docs/ref/search/functions_a.js new file mode 100644 index 00000000..3fbfbab8 --- /dev/null +++ b/docs/ref/search/functions_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['write_5fcallback',['write_callback',['../namespace_rest_client_1_1_helpers.html#a1dfc03258041ee29084ef9cf566ab836',1,'RestClient::Helpers']]] +]; diff --git a/docs/ref/search/mag_sel.png b/docs/ref/search/mag_sel.png new file mode 100644 index 00000000..81f6040a Binary files /dev/null and b/docs/ref/search/mag_sel.png differ diff --git a/docs/ref/search/namespaces_0.html b/docs/ref/search/namespaces_0.html new file mode 100644 index 00000000..6d5853b6 --- /dev/null +++ b/docs/ref/search/namespaces_0.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/namespaces_0.js b/docs/ref/search/namespaces_0.js new file mode 100644 index 00000000..3df96531 --- /dev/null +++ b/docs/ref/search/namespaces_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['helpers',['Helpers',['../namespace_rest_client_1_1_helpers.html',1,'RestClient']]], + ['restclient',['RestClient',['../namespace_rest_client.html',1,'']]] +]; diff --git a/docs/ref/search/nomatches.html b/docs/ref/search/nomatches.html new file mode 100644 index 00000000..b1ded27e --- /dev/null +++ b/docs/ref/search/nomatches.html @@ -0,0 +1,12 @@ + + + + + + + +
+
No Matches
+
+ + diff --git a/docs/ref/search/pages_0.html b/docs/ref/search/pages_0.html new file mode 100644 index 00000000..4b85b346 --- /dev/null +++ b/docs/ref/search/pages_0.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/pages_0.js b/docs/ref/search/pages_0.js new file mode 100644 index 00000000..c698a484 --- /dev/null +++ b/docs/ref/search/pages_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['changelog',['Changelog',['../md__c_h_a_n_g_e_l_o_g.html',1,'']]] +]; diff --git a/docs/ref/search/search.css b/docs/ref/search/search.css new file mode 100644 index 00000000..4d7612ff --- /dev/null +++ b/docs/ref/search/search.css @@ -0,0 +1,271 @@ +/*---------------- Search Box */ + +#FSearchBox { + float: left; +} + +#MSearchBox { + white-space : nowrap; + position: absolute; + float: none; + display: inline; + margin-top: 8px; + right: 0px; + width: 170px; + z-index: 102; + background-color: white; +} + +#MSearchBox .left +{ + display:block; + position:absolute; + left:10px; + width:20px; + height:19px; + background:url('search_l.png') no-repeat; + background-position:right; +} + +#MSearchSelect { + display:block; + position:absolute; + width:20px; + height:19px; +} + +.left #MSearchSelect { + left:4px; +} + +.right #MSearchSelect { + right:5px; +} + +#MSearchField { + display:block; + position:absolute; + height:19px; + background:url('search_m.png') repeat-x; + border:none; + width:111px; + margin-left:20px; + padding-left:4px; + color: #909090; + outline: none; + font: 9pt Arial, Verdana, sans-serif; +} + +#FSearchBox #MSearchField { + margin-left:15px; +} + +#MSearchBox .right { + display:block; + position:absolute; + right:10px; + top:0px; + width:20px; + height:19px; + background:url('search_r.png') no-repeat; + background-position:left; +} + +#MSearchClose { + display: none; + position: absolute; + top: 4px; + background : none; + border: none; + margin: 0px 4px 0px 0px; + padding: 0px 0px; + outline: none; +} + +.left #MSearchClose { + left: 6px; +} + +.right #MSearchClose { + right: 2px; +} + +.MSearchBoxActive #MSearchField { + color: #000000; +} + +/*---------------- Search filter selection */ + +#MSearchSelectWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #90A5CE; + background-color: #F9FAFC; + z-index: 1; + padding-top: 4px; + padding-bottom: 4px; + -moz-border-radius: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.SelectItem { + font: 8pt Arial, Verdana, sans-serif; + padding-left: 2px; + padding-right: 12px; + border: 0px; +} + +span.SelectionMark { + margin-right: 4px; + font-family: monospace; + outline-style: none; + text-decoration: none; +} + +a.SelectItem { + display: block; + outline-style: none; + color: #000000; + text-decoration: none; + padding-left: 6px; + padding-right: 12px; +} + +a.SelectItem:focus, +a.SelectItem:active { + color: #000000; + outline-style: none; + text-decoration: none; +} + +a.SelectItem:hover { + color: #FFFFFF; + background-color: #3D578C; + outline-style: none; + text-decoration: none; + cursor: pointer; + display: block; +} + +/*---------------- Search results window */ + +iframe#MSearchResults { + width: 60ex; + height: 15em; +} + +#MSearchResultsWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #000; + background-color: #EEF1F7; +} + +/* ----------------------------------- */ + + +#SRIndex { + clear:both; + padding-bottom: 15px; +} + +.SREntry { + font-size: 10pt; + padding-left: 1ex; +} + +.SRPage .SREntry { + font-size: 8pt; + padding: 1px 5px; +} + +body.SRPage { + margin: 5px 2px; +} + +.SRChildren { + padding-left: 3ex; padding-bottom: .5em +} + +.SRPage .SRChildren { + display: none; +} + +.SRSymbol { + font-weight: bold; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRScope { + display: block; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRSymbol:focus, a.SRSymbol:active, +a.SRScope:focus, a.SRScope:active { + text-decoration: underline; +} + +span.SRScope { + padding-left: 4px; +} + +.SRPage .SRStatus { + padding: 2px 5px; + font-size: 8pt; + font-style: italic; +} + +.SRResult { + display: none; +} + +DIV.searchresults { + margin-left: 10px; + margin-right: 10px; +} + +/*---------------- External search page results */ + +.searchresult { + background-color: #F0F3F8; +} + +.pages b { + color: white; + padding: 5px 5px 3px 5px; + background-image: url("../tab_a.png"); + background-repeat: repeat-x; + text-shadow: 0 1px 1px #000000; +} + +.pages { + line-height: 17px; + margin-left: 4px; + text-decoration: none; +} + +.hl { + font-weight: bold; +} + +#searchresults { + margin-bottom: 20px; +} + +.searchpages { + margin-top: 10px; +} + diff --git a/docs/ref/search/search.js b/docs/ref/search/search.js new file mode 100644 index 00000000..dedce3bf --- /dev/null +++ b/docs/ref/search/search.js @@ -0,0 +1,791 @@ +function convertToId(search) +{ + var result = ''; + for (i=0;i do a search + { + this.Search(); + } + } + + this.OnSearchSelectKey = function(evt) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==40 && this.searchIndex0) // Up + { + this.searchIndex--; + this.OnSelectItem(this.searchIndex); + } + else if (e.keyCode==13 || e.keyCode==27) + { + this.OnSelectItem(this.searchIndex); + this.CloseSelectionWindow(); + this.DOMSearchField().focus(); + } + return false; + } + + // --------- Actions + + // Closes the results window. + this.CloseResultsWindow = function() + { + this.DOMPopupSearchResultsWindow().style.display = 'none'; + this.DOMSearchClose().style.display = 'none'; + this.Activate(false); + } + + this.CloseSelectionWindow = function() + { + this.DOMSearchSelectWindow().style.display = 'none'; + } + + // Performs a search. + this.Search = function() + { + this.keyTimeout = 0; + + // strip leading whitespace + var searchValue = this.DOMSearchField().value.replace(/^ +/, ""); + + var code = searchValue.toLowerCase().charCodeAt(0); + var idxChar = searchValue.substr(0, 1).toLowerCase(); + if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair + { + idxChar = searchValue.substr(0, 2); + } + + var resultsPage; + var resultsPageWithSearch; + var hasResultsPage; + + var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar); + if (idx!=-1) + { + var hexCode=idx.toString(16); + resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html'; + resultsPageWithSearch = resultsPage+'?'+escape(searchValue); + hasResultsPage = true; + } + else // nothing available for this search term + { + resultsPage = this.resultsPath + '/nomatches.html'; + resultsPageWithSearch = resultsPage; + hasResultsPage = false; + } + + window.frames.MSearchResults.location = resultsPageWithSearch; + var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow(); + + if (domPopupSearchResultsWindow.style.display!='block') + { + var domSearchBox = this.DOMSearchBox(); + this.DOMSearchClose().style.display = 'inline'; + if (this.insideFrame) + { + var domPopupSearchResults = this.DOMPopupSearchResults(); + domPopupSearchResultsWindow.style.position = 'relative'; + domPopupSearchResultsWindow.style.display = 'block'; + var width = document.body.clientWidth - 8; // the -8 is for IE :-( + domPopupSearchResultsWindow.style.width = width + 'px'; + domPopupSearchResults.style.width = width + 'px'; + } + else + { + var domPopupSearchResults = this.DOMPopupSearchResults(); + var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth; + var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1; + domPopupSearchResultsWindow.style.display = 'block'; + left -= domPopupSearchResults.offsetWidth; + domPopupSearchResultsWindow.style.top = top + 'px'; + domPopupSearchResultsWindow.style.left = left + 'px'; + } + } + + this.lastSearchValue = searchValue; + this.lastResultsPage = resultsPage; + } + + // -------- Activation Functions + + // Activates or deactivates the search panel, resetting things to + // their default values if necessary. + this.Activate = function(isActive) + { + if (isActive || // open it + this.DOMPopupSearchResultsWindow().style.display == 'block' + ) + { + this.DOMSearchBox().className = 'MSearchBoxActive'; + + var searchField = this.DOMSearchField(); + + if (searchField.value == this.searchLabel) // clear "Search" term upon entry + { + searchField.value = ''; + this.searchActive = true; + } + } + else if (!isActive) // directly remove the panel + { + this.DOMSearchBox().className = 'MSearchBoxInactive'; + this.DOMSearchField().value = this.searchLabel; + this.searchActive = false; + this.lastSearchValue = '' + this.lastResultsPage = ''; + } + } +} + +// ----------------------------------------------------------------------- + +// The class that handles everything on the search results page. +function SearchResults(name) +{ + // The number of matches from the last run of . + this.lastMatchCount = 0; + this.lastKey = 0; + this.repeatOn = false; + + // Toggles the visibility of the passed element ID. + this.FindChildElement = function(id) + { + var parentElement = document.getElementById(id); + var element = parentElement.firstChild; + + while (element && element!=parentElement) + { + if (element.nodeName == 'DIV' && element.className == 'SRChildren') + { + return element; + } + + if (element.nodeName == 'DIV' && element.hasChildNodes()) + { + element = element.firstChild; + } + else if (element.nextSibling) + { + element = element.nextSibling; + } + else + { + do + { + element = element.parentNode; + } + while (element && element!=parentElement && !element.nextSibling); + + if (element && element!=parentElement) + { + element = element.nextSibling; + } + } + } + } + + this.Toggle = function(id) + { + var element = this.FindChildElement(id); + if (element) + { + if (element.style.display == 'block') + { + element.style.display = 'none'; + } + else + { + element.style.display = 'block'; + } + } + } + + // Searches for the passed string. If there is no parameter, + // it takes it from the URL query. + // + // Always returns true, since other documents may try to call it + // and that may or may not be possible. + this.Search = function(search) + { + if (!search) // get search word from URL + { + search = window.location.search; + search = search.substring(1); // Remove the leading '?' + search = unescape(search); + } + + search = search.replace(/^ +/, ""); // strip leading spaces + search = search.replace(/ +$/, ""); // strip trailing spaces + search = search.toLowerCase(); + search = convertToId(search); + + var resultRows = document.getElementsByTagName("div"); + var matches = 0; + + var i = 0; + while (i < resultRows.length) + { + var row = resultRows.item(i); + if (row.className == "SRResult") + { + var rowMatchName = row.id.toLowerCase(); + rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_' + + if (search.length<=rowMatchName.length && + rowMatchName.substr(0, search.length)==search) + { + row.style.display = 'block'; + matches++; + } + else + { + row.style.display = 'none'; + } + } + i++; + } + document.getElementById("Searching").style.display='none'; + if (matches == 0) // no results + { + document.getElementById("NoMatches").style.display='block'; + } + else // at least one result + { + document.getElementById("NoMatches").style.display='none'; + } + this.lastMatchCount = matches; + return true; + } + + // return the first item with index index or higher that is visible + this.NavNext = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index++; + } + return focusItem; + } + + this.NavPrev = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index--; + } + return focusItem; + } + + this.ProcessKeys = function(e) + { + if (e.type == "keydown") + { + this.repeatOn = false; + this.lastKey = e.keyCode; + } + else if (e.type == "keypress") + { + if (!this.repeatOn) + { + if (this.lastKey) this.repeatOn = true; + return false; // ignore first keypress after keydown + } + } + else if (e.type == "keyup") + { + this.lastKey = 0; + this.repeatOn = false; + } + return this.lastKey!=0; + } + + this.Nav = function(evt,itemIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + var newIndex = itemIndex-1; + var focusItem = this.NavPrev(newIndex); + if (focusItem) + { + var child = this.FindChildElement(focusItem.parentNode.parentNode.id); + if (child && child.style.display == 'block') // children visible + { + var n=0; + var tmpElem; + while (1) // search for last child + { + tmpElem = document.getElementById('Item'+newIndex+'_c'+n); + if (tmpElem) + { + focusItem = tmpElem; + } + else // found it! + { + break; + } + n++; + } + } + } + if (focusItem) + { + focusItem.focus(); + } + else // return focus to search field + { + parent.document.getElementById("MSearchField").focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = itemIndex+1; + var focusItem; + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem && elem.style.display == 'block') // children visible + { + focusItem = document.getElementById('Item'+itemIndex+'_c0'); + } + if (!focusItem) focusItem = this.NavNext(newIndex); + if (focusItem) focusItem.focus(); + } + else if (this.lastKey==39) // Right + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'block'; + } + else if (this.lastKey==37) // Left + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'none'; + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } + + this.NavChild = function(evt,itemIndex,childIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + if (childIndex>0) + { + var newIndex = childIndex-1; + document.getElementById('Item'+itemIndex+'_c'+newIndex).focus(); + } + else // already at first child, jump to parent + { + document.getElementById('Item'+itemIndex).focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = childIndex+1; + var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex); + if (!elem) // last child, jump to parent next parent + { + elem = this.NavNext(itemIndex+1); + } + if (elem) + { + elem.focus(); + } + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } +} + +function setKeyActions(elem,action) +{ + elem.setAttribute('onkeydown',action); + elem.setAttribute('onkeypress',action); + elem.setAttribute('onkeyup',action); +} + +function setClassAttr(elem,attr) +{ + elem.setAttribute('class',attr); + elem.setAttribute('className',attr); +} + +function createResults() +{ + var results = document.getElementById("SRResults"); + for (var e=0; e + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/typedefs_0.js b/docs/ref/search/typedefs_0.js new file mode 100644 index 00000000..36a191cc --- /dev/null +++ b/docs/ref/search/typedefs_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['headerfields',['HeaderFields',['../namespace_rest_client.html#ab2bbc7fd5ec10171e4e1fb2d7fc8e865',1,'RestClient']]] +]; diff --git a/docs/ref/search/variables_0.html b/docs/ref/search/variables_0.html new file mode 100644 index 00000000..2837a574 --- /dev/null +++ b/docs/ref/search/variables_0.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_0.js b/docs/ref/search/variables_0.js new file mode 100644 index 00000000..fde1c467 --- /dev/null +++ b/docs/ref/search/variables_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['appconnecttime',['appConnectTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a05d4f74f97a3e02cb9bbe3a6039135bc',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/search/variables_1.html b/docs/ref/search/variables_1.html new file mode 100644 index 00000000..6a866b1b --- /dev/null +++ b/docs/ref/search/variables_1.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_1.js b/docs/ref/search/variables_1.js new file mode 100644 index 00000000..885da35c --- /dev/null +++ b/docs/ref/search/variables_1.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['baseurl',['baseUrl',['../struct_rest_client_1_1_connection_1_1_info.html#ae908949ed901ed0883da20efad56cf67',1,'RestClient::Connection::Info']]], + ['basicauth',['basicAuth',['../struct_rest_client_1_1_connection_1_1_info.html#ac659be6ed4f5f699ca7609b1e0f6863d',1,'RestClient::Connection::Info']]], + ['body',['body',['../struct_rest_client_1_1_response.html#a87ba6d5e5ae9ae7d628d5ed34b36cc95',1,'RestClient::Response']]] +]; diff --git a/docs/ref/search/variables_2.html b/docs/ref/search/variables_2.html new file mode 100644 index 00000000..3115f99e --- /dev/null +++ b/docs/ref/search/variables_2.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_2.js b/docs/ref/search/variables_2.js new file mode 100644 index 00000000..4ca6981e --- /dev/null +++ b/docs/ref/search/variables_2.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['code',['code',['../struct_rest_client_1_1_response.html#a3b3b63aeae7ca761d54a009ee329ea28',1,'RestClient::Response']]], + ['connecttime',['connectTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a7c8347cc41e35a944663d333baea88a9',1,'RestClient::Connection::RequestInfo']]], + ['customuseragent',['customUserAgent',['../struct_rest_client_1_1_connection_1_1_info.html#a8cec6f505e26773638ea7c2df895b5e8',1,'RestClient::Connection::Info']]] +]; diff --git a/docs/ref/search/variables_3.html b/docs/ref/search/variables_3.html new file mode 100644 index 00000000..b2941ee6 --- /dev/null +++ b/docs/ref/search/variables_3.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_3.js b/docs/ref/search/variables_3.js new file mode 100644 index 00000000..866c7139 --- /dev/null +++ b/docs/ref/search/variables_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['data',['data',['../struct_rest_client_1_1_helpers_1_1_upload_object.html#a0f0bebacc6bb930899ee9babadb92a31',1,'RestClient::Helpers::UploadObject']]] +]; diff --git a/docs/ref/search/variables_4.html b/docs/ref/search/variables_4.html new file mode 100644 index 00000000..e14a4ffc --- /dev/null +++ b/docs/ref/search/variables_4.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_4.js b/docs/ref/search/variables_4.js new file mode 100644 index 00000000..b2416c01 --- /dev/null +++ b/docs/ref/search/variables_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['followredirects',['followRedirects',['../struct_rest_client_1_1_connection_1_1_info.html#a4b194ea487bf48f55e597b3146bc0c9b',1,'RestClient::Connection::Info']]] +]; diff --git a/docs/ref/search/variables_5.html b/docs/ref/search/variables_5.html new file mode 100644 index 00000000..ee6461cb --- /dev/null +++ b/docs/ref/search/variables_5.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_5.js b/docs/ref/search/variables_5.js new file mode 100644 index 00000000..1c53cf94 --- /dev/null +++ b/docs/ref/search/variables_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['headers',['headers',['../struct_rest_client_1_1_connection_1_1_info.html#a8e9c9ad0c74a6e6f5c73ced7306464d1',1,'RestClient::Connection::Info::headers()'],['../struct_rest_client_1_1_response.html#a2141b4d9929e0df26d918dfba8451496',1,'RestClient::Response::headers()']]] +]; diff --git a/docs/ref/search/variables_6.html b/docs/ref/search/variables_6.html new file mode 100644 index 00000000..9b457a20 --- /dev/null +++ b/docs/ref/search/variables_6.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_6.js b/docs/ref/search/variables_6.js new file mode 100644 index 00000000..359ed049 --- /dev/null +++ b/docs/ref/search/variables_6.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['lastrequest',['lastRequest',['../struct_rest_client_1_1_connection_1_1_info.html#ac9393ffec292dc9ef1f9378bf0df5f31',1,'RestClient::Connection::Info']]], + ['length',['length',['../struct_rest_client_1_1_helpers_1_1_upload_object.html#a8cfb479c87d4870a7e54e62dc0a3d3f6',1,'RestClient::Helpers::UploadObject']]] +]; diff --git a/docs/ref/search/variables_7.html b/docs/ref/search/variables_7.html new file mode 100644 index 00000000..aae170d5 --- /dev/null +++ b/docs/ref/search/variables_7.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_7.js b/docs/ref/search/variables_7.js new file mode 100644 index 00000000..8bbc8dc8 --- /dev/null +++ b/docs/ref/search/variables_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['namelookuptime',['nameLookupTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a73d3bab1fd832feb912f1e20656b185d',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/search/variables_8.html b/docs/ref/search/variables_8.html new file mode 100644 index 00000000..7d96ca32 --- /dev/null +++ b/docs/ref/search/variables_8.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_8.js b/docs/ref/search/variables_8.js new file mode 100644 index 00000000..fdc9cc86 --- /dev/null +++ b/docs/ref/search/variables_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['pretransfertime',['preTransferTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#abcccb563d60a3f5325918ef912130e16',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/search/variables_9.html b/docs/ref/search/variables_9.html new file mode 100644 index 00000000..29d10923 --- /dev/null +++ b/docs/ref/search/variables_9.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_9.js b/docs/ref/search/variables_9.js new file mode 100644 index 00000000..6d28dda3 --- /dev/null +++ b/docs/ref/search/variables_9.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['redirectcount',['redirectCount',['../struct_rest_client_1_1_connection_1_1_request_info.html#ab0240290fa51b11468936199ff0c248f',1,'RestClient::Connection::RequestInfo']]], + ['redirecttime',['redirectTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#af219b63ad58cb52748ba7afd5b2290aa',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/search/variables_a.html b/docs/ref/search/variables_a.html new file mode 100644 index 00000000..b4a88a82 --- /dev/null +++ b/docs/ref/search/variables_a.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_a.js b/docs/ref/search/variables_a.js new file mode 100644 index 00000000..8ec9c983 --- /dev/null +++ b/docs/ref/search/variables_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['starttransfertime',['startTransferTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a022ad817c51c37e781d3ef6590b47d96',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/search/variables_b.html b/docs/ref/search/variables_b.html new file mode 100644 index 00000000..3eb3a399 --- /dev/null +++ b/docs/ref/search/variables_b.html @@ -0,0 +1,26 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/ref/search/variables_b.js b/docs/ref/search/variables_b.js new file mode 100644 index 00000000..8483af7b --- /dev/null +++ b/docs/ref/search/variables_b.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['timeout',['timeout',['../struct_rest_client_1_1_connection_1_1_info.html#a0a63e442ce474e50017fcbae563c4a7c',1,'RestClient::Connection::Info']]], + ['totaltime',['totalTime',['../struct_rest_client_1_1_connection_1_1_request_info.html#a5febf41f2662384129b874e195e1c01e',1,'RestClient::Connection::RequestInfo']]] +]; diff --git a/docs/ref/splitbar.png b/docs/ref/splitbar.png new file mode 100644 index 00000000..fe895f2c Binary files /dev/null and b/docs/ref/splitbar.png differ diff --git a/docs/ref/struct_rest_client_1_1_connection_1_1_info-members.html b/docs/ref/struct_rest_client_1_1_connection_1_1_info-members.html new file mode 100644 index 00000000..7e1f66ff --- /dev/null +++ b/docs/ref/struct_rest_client_1_1_connection_1_1_info-members.html @@ -0,0 +1,118 @@ + + + + + + +restclient-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RestClient::Connection::Info Member List
+
+
+ +

This is the complete list of members for RestClient::Connection::Info, including all inherited members.

+ + + + + + + + + + + + + +
baseUrlRestClient::Connection::Info
basicAuthRestClient::Connection::Info
certPath (defined in RestClient::Connection::Info)RestClient::Connection::Info
certType (defined in RestClient::Connection::Info)RestClient::Connection::Info
customUserAgentRestClient::Connection::Info
followRedirectsRestClient::Connection::Info
headersRestClient::Connection::Info
keyPath (defined in RestClient::Connection::Info)RestClient::Connection::Info
lastRequestRestClient::Connection::Info
password (defined in RestClient::Connection::Info)RestClient::Connection::Info
timeoutRestClient::Connection::Info
username (defined in RestClient::Connection::Info)RestClient::Connection::Info
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/struct_rest_client_1_1_connection_1_1_info.html b/docs/ref/struct_rest_client_1_1_connection_1_1_info.html new file mode 100644 index 00000000..29a92a12 --- /dev/null +++ b/docs/ref/struct_rest_client_1_1_connection_1_1_info.html @@ -0,0 +1,242 @@ + + + + + + +restclient-cpp: RestClient::Connection::Info Struct Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Attributes | +List of all members
+
+
RestClient::Connection::Info Struct Reference
+
+
+ +

holds some diagnostics information about the connection object it came from + More...

+ +

#include <connection.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

std::string baseUrl
 
RestClient::HeaderFields headers
 
int timeout
 
bool followRedirects
 
struct {
+   std::string   username
 
+   std::string   password
 
} basicAuth
 
+std::string certPath
 
+std::string certType
 
+std::string keyPath
 
std::string customUserAgent
 
RequestInfo lastRequest
 
+

Detailed Description

+

holds some diagnostics information about the connection object it came from

+

Member Data Documentation

+ +
+
+ + + + +
RestClient::Connection::Info::baseUrl
+
+

Member 'baseUrl' contains the base URL for the connection object

+ +
+
+ +
+
+ + + + +
RestClient::Connection::Info::basicAuth
+
+

Member 'basicAuth' contains information about basic auth

+ +
+
+ +
+
+ + + + +
RestClient::Connection::Info::customUserAgent
+
+

Member 'customUserAgent' contains the custom user agent

+ +
+
+ +
+
+ + + + +
RestClient::Connection::Info::followRedirects
+
+

Member 'followRedirects' contains whether or not to follow redirects

+ +
+
+ +
+
+ + + + +
RestClient::Connection::Info::headers
+
+

Member 'headers' contains the HeaderFields map

+ +
+
+ +
+
+ + + + +
RestClient::Connection::Info::lastRequest
+
+

Member 'lastRequest' contains metrics about the last request

+ +
+
+ +
+
+ + + + +
RestClient::Connection::Info::timeout
+
+

Member 'timeout' contains the configured timeout

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/struct_rest_client_1_1_connection_1_1_request_info-members.html b/docs/ref/struct_rest_client_1_1_connection_1_1_request_info-members.html new file mode 100644 index 00000000..88fde378 --- /dev/null +++ b/docs/ref/struct_rest_client_1_1_connection_1_1_request_info-members.html @@ -0,0 +1,114 @@ + + + + + + +restclient-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RestClient::Connection::RequestInfo Member List
+
+
+ +

This is the complete list of members for RestClient::Connection::RequestInfo, including all inherited members.

+ + + + + + + + + +
appConnectTimeRestClient::Connection::RequestInfo
connectTimeRestClient::Connection::RequestInfo
nameLookupTimeRestClient::Connection::RequestInfo
preTransferTimeRestClient::Connection::RequestInfo
redirectCountRestClient::Connection::RequestInfo
redirectTimeRestClient::Connection::RequestInfo
startTransferTimeRestClient::Connection::RequestInfo
totalTimeRestClient::Connection::RequestInfo
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/struct_rest_client_1_1_connection_1_1_request_info.html b/docs/ref/struct_rest_client_1_1_connection_1_1_request_info.html new file mode 100644 index 00000000..a63358d0 --- /dev/null +++ b/docs/ref/struct_rest_client_1_1_connection_1_1_request_info.html @@ -0,0 +1,241 @@ + + + + + + +restclient-cpp: RestClient::Connection::RequestInfo Struct Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Attributes | +List of all members
+
+
RestClient::Connection::RequestInfo Struct Reference
+
+
+ +

holds some diagnostics information about a request + More...

+ +

#include <connection.h>

+ + + + + + + + + + + + + + + + + + +

+Public Attributes

double totalTime
 
double nameLookupTime
 
double connectTime
 
double appConnectTime
 
double preTransferTime
 
double startTransferTime
 
double redirectTime
 
int redirectCount
 
+

Detailed Description

+

holds some diagnostics information about a request

+

Member Data Documentation

+ +
+
+ + + + +
RestClient::Connection::RequestInfo::appConnectTime
+
+

Member 'appConnectTime' contains the time from start until SSL/SSH handshake completed. See CURLINFO_APPCONNECT_TIME

+ +
+
+ +
+
+ + + + +
RestClient::Connection::RequestInfo::connectTime
+
+

Member 'connectTime' contains the time it took until Time from start until remote host or proxy completed. See CURLINFO_CONNECT_TIME

+ +
+
+ +
+
+ + + + +
RestClient::Connection::RequestInfo::nameLookupTime
+
+

Member 'nameLookupTime' contains the time spent in DNS lookup in seconds Time from start until name resolving completed. See CURLINFO_NAMELOOKUP_TIME

+ +
+
+ +
+
+ + + + +
RestClient::Connection::RequestInfo::preTransferTime
+
+

Member 'preTransferTime' contains the total time from start until just before the transfer begins. See CURLINFO_PRETRANSFER_TIME

+ +
+
+ +
+
+ + + + +
RestClient::Connection::RequestInfo::redirectCount
+
+

Member 'redirectCount' contains the number of redirects followed. See CURLINFO_REDIRECT_COUNT

+ +
+
+ +
+
+ + + + +
RestClient::Connection::RequestInfo::redirectTime
+
+

Member 'redirectTime' contains the total time taken for all redirect steps before the final transfer. See CURLINFO_REDIRECT_TIME

+ +
+
+ +
+
+ + + + +
RestClient::Connection::RequestInfo::startTransferTime
+
+

Member 'startTransferTime' contains the total time from start until just when the first byte is received. See CURLINFO_STARTTRANSFER_TIME

+ +
+
+ +
+
+ + + + +
RestClient::Connection::RequestInfo::totalTime
+
+

Member 'totalTime' contains the total time of the last request in seconds Total time of previous transfer. See CURLINFO_TOTAL_TIME

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/struct_rest_client_1_1_helpers_1_1_upload_object-members.html b/docs/ref/struct_rest_client_1_1_helpers_1_1_upload_object-members.html new file mode 100644 index 00000000..d57d89bd --- /dev/null +++ b/docs/ref/struct_rest_client_1_1_helpers_1_1_upload_object-members.html @@ -0,0 +1,108 @@ + + + + + + +restclient-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RestClient::Helpers::UploadObject Member List
+
+
+ +

This is the complete list of members for RestClient::Helpers::UploadObject, including all inherited members.

+ + + +
dataRestClient::Helpers::UploadObject
lengthRestClient::Helpers::UploadObject
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/struct_rest_client_1_1_helpers_1_1_upload_object.html b/docs/ref/struct_rest_client_1_1_helpers_1_1_upload_object.html new file mode 100644 index 00000000..a58b8bf4 --- /dev/null +++ b/docs/ref/struct_rest_client_1_1_helpers_1_1_upload_object.html @@ -0,0 +1,151 @@ + + + + + + +restclient-cpp: RestClient::Helpers::UploadObject Struct Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Attributes | +List of all members
+
+
RestClient::Helpers::UploadObject Struct Reference
+
+
+ +

This structure represents the payload to upload on POST requests. + More...

+ +

#include <helpers.h>

+ + + + + + +

+Public Attributes

const char * data
 
size_t length
 
+

Detailed Description

+

This structure represents the payload to upload on POST requests.

+

Member Data Documentation

+ +
+
+ + + + +
RestClient::Helpers::UploadObject::data
+
+

Member 'data' contains the data to upload

+ +
+
+ +
+
+ + + + +
RestClient::Helpers::UploadObject::length
+
+

Member 'length' contains the length of the data to upload

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/struct_rest_client_1_1_response-members.html b/docs/ref/struct_rest_client_1_1_response-members.html new file mode 100644 index 00000000..f6e4df5b --- /dev/null +++ b/docs/ref/struct_rest_client_1_1_response-members.html @@ -0,0 +1,109 @@ + + + + + + +restclient-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RestClient::Response Member List
+
+
+ +

This is the complete list of members for RestClient::Response, including all inherited members.

+ + + + +
bodyRestClient::Response
codeRestClient::Response
headersRestClient::Response
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/struct_rest_client_1_1_response.html b/docs/ref/struct_rest_client_1_1_response.html new file mode 100644 index 00000000..2e2b4afe --- /dev/null +++ b/docs/ref/struct_rest_client_1_1_response.html @@ -0,0 +1,166 @@ + + + + + + +restclient-cpp: RestClient::Response Struct Reference + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Attributes | +List of all members
+
+
RestClient::Response Struct Reference
+
+
+ +

This structure represents the HTTP response data. + More...

+ +

#include <restclient.h>

+ + + + + + + + +

+Public Attributes

int code
 
std::string body
 
HeaderFields headers
 
+

Detailed Description

+

This structure represents the HTTP response data.

+

Member Data Documentation

+ +
+
+ + + + +
RestClient::Response::body
+
+

Member 'body' contains the HTTP response body

+ +
+
+ +
+
+ + + + +
RestClient::Response::code
+
+

Member 'code' contains the HTTP response code

+ +
+
+ +
+
+ + + + +
RestClient::Response::headers
+
+

Member 'headers' contains the HTTP response headers

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated on Fri Dec 2 2016 10:53:09 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/docs/ref/sync_off.png b/docs/ref/sync_off.png new file mode 100644 index 00000000..3b443fc6 Binary files /dev/null and b/docs/ref/sync_off.png differ diff --git a/docs/ref/sync_on.png b/docs/ref/sync_on.png new file mode 100644 index 00000000..e08320fb Binary files /dev/null and b/docs/ref/sync_on.png differ diff --git a/docs/ref/tab_a.png b/docs/ref/tab_a.png new file mode 100644 index 00000000..3b725c41 Binary files /dev/null and b/docs/ref/tab_a.png differ diff --git a/docs/ref/tab_b.png b/docs/ref/tab_b.png new file mode 100644 index 00000000..e2b4a863 Binary files /dev/null and b/docs/ref/tab_b.png differ diff --git a/docs/ref/tab_h.png b/docs/ref/tab_h.png new file mode 100644 index 00000000..fd5cb705 Binary files /dev/null and b/docs/ref/tab_h.png differ diff --git a/docs/ref/tab_s.png b/docs/ref/tab_s.png new file mode 100644 index 00000000..ab478c95 Binary files /dev/null and b/docs/ref/tab_s.png differ diff --git a/docs/ref/tabs.css b/docs/ref/tabs.css new file mode 100644 index 00000000..9cf578f2 --- /dev/null +++ b/docs/ref/tabs.css @@ -0,0 +1,60 @@ +.tabs, .tabs2, .tabs3 { + background-image: url('tab_b.png'); + width: 100%; + z-index: 101; + font-size: 13px; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; +} + +.tabs2 { + font-size: 10px; +} +.tabs3 { + font-size: 9px; +} + +.tablist { + margin: 0; + padding: 0; + display: table; +} + +.tablist li { + float: left; + display: table-cell; + background-image: url('tab_b.png'); + line-height: 36px; + list-style: none; +} + +.tablist a { + display: block; + padding: 0 20px; + font-weight: bold; + background-image:url('tab_s.png'); + background-repeat:no-repeat; + background-position:right; + color: #283A5D; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; + outline: none; +} + +.tabs3 .tablist a { + padding: 0 10px; +} + +.tablist a:hover { + background-image: url('tab_h.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + text-decoration: none; +} + +.tablist li.current a { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} diff --git a/docs/ref/version_8h_source.html b/docs/ref/version_8h_source.html new file mode 100644 index 00000000..edbc0d3c --- /dev/null +++ b/docs/ref/version_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +restclient-cpp: include/restclient-cpp/version.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
restclient-cpp +
+
C++ client for making HTTP/REST requests
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
version.h
+
+
+
1 #ifndef INCLUDE_RESTCLIENT_CPP_VERSION_H_
+
2 #define INCLUDE_RESTCLIENT_CPP_VERSION_H_
+
3 #define RESTCLIENT_VERSION "0.5.1"
+
4 #endif // INCLUDE_RESTCLIENT_CPP_VERSION_H_
+
+ +
+Generated on Sun Nov 27 2016 21:27:11 for restclient-cpp by   +doxygen + 1.8.9.1 +
+ + diff --git a/doxygen.config b/doxygen.config new file mode 100644 index 00000000..f50b7984 --- /dev/null +++ b/doxygen.config @@ -0,0 +1,2362 @@ +# Doxyfile 1.8.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "restclient-cpp" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "C++ client for making HTTP/REST requests" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = . include/restclient-cpp source + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = ref + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /