Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Mirror of Apache Thrift
C++ Java C D Go Pascal Other cleanup

Client: docs
Patch: Chris Snow

Github Pull Request:
This closes #594
Failed to load latest commit information.
aclocal THRIFT-3271 "Could not find or load main class configtest_ax_javac_an…
build THRIFT-3053: Added perl SSL Socket support, split SSLSocket and SSLSe…
compiler/cpp THRIFT-2981: IDL with no namespace produces unparsable PHP
contrib THRIFT-3155 move contrib/mingw32-toolchain.cmake to build/cmake/
debian THRIFT-2849: spelling errors fixed using codespell tool
doc THRIFT-3286 Apache Ant is a necessary dependency
lib THRIFT-3308: Fix broken test cases for 0.9.3 release candidate
test THRIFT-3305: Missing dist files for 0.9.3 release candidate
tutorial THRIFT-3305: Missing dist files for 0.9.3 release candidate
.clang-format THRIFT-2729: C++ - .clang-format created and applied
.editorconfig THRIFT-2967 Add .editorconfig to root
.gitattributes THRIFT-2724 - Coding standards template added all over project
.gitignore THRIFT-3308: Fix broken test cases for 0.9.3 release candidate
.travis.yml travis CI sudo: required
CHANGES THRIFT-2793: Go compiler produces uncompilable code
CMakeLists.txt THRIFT-3245 Tutorials can't be disabled when using CMake doc GitHub service hooks
LICENSE THRIFT-3209: LGPL mentioned in license file THRIFT-3305: Missing dist files for 0.9.3 release candidate
NOTICE Update the NOTICE file. cleanup
appveyor.yml THRIFT-3014 AppVeyor support - fix format THRIFT-3071 fix on MinGW
bower.json THRIFT-3040: wrong main path in bower.json svn ignore and remove php artifacts left by phpize in
composer.json THRIFT-1743: Add composer.json for new Symfony 2.1 Dependency Manager THRIFT-3164: disable insecure SSLv3 protocol in cpp lib unless SSLv3 …
doap.rdf THRIFT-3203: DOAP - please fix "Ocaml" => "OCaml"
json-schema.json THRIFT-2859 JSON generator: output complete descriptors
package.json THRIFT-3122 Javascript struct constructor should properly initialize …
rat_exclude THRIFT-1614: handle automake >= 1.12 yacc output name (thrifty.hh) INFRA-4347 Add Thrift to sonar

Apache Thrift

Last Modified: 2014-03-16


Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


Thrift is a lightweight, language-independent software stack with an associated code generation mechanism for RPC. Thrift provides clean abstractions for data transport, data serialization, and application level processing. The code generation system takes a simple definition language as its input and generates code across programming languages that uses the abstracted stack to build interoperable RPC clients and servers.

Thrift is specifically designed to support non-atomic version changes across client and server code.

For more details on Thrift's design and implementation, take a gander at the Thrift whitepaper included in this distribution or at the files in your particular subdirectory of interest.




Contains the Thrift compiler, implemented in C++.


Contains the Thrift software library implementation, subdivided by
language of implementation.



Contains sample Thrift files and test code across the target programming


Contains a basic tutorial that will teach you how to develop software
using Thrift.


See for an up-to-date list of build requirements.


More information about Thrift can be obtained on the Thrift webpage at:


Thrift was inspired by pillar, a lightweight RPC tool written by Adam D'Angelo, and also by Google's protocol buffers.


If you are building from the first time out of the source repository, you will need to generate the configure scripts. (This is not necessary if you downloaded a tarball.) From the top directory, do:


Once the configure scripts are generated, thrift can be configured. From the top directory, do:


You may need to specify the location of the boost files explicitly. If you installed boost in /usr/local, you would run configure as follows:

./configure --with-boost=/usr/local

Note that by default the thrift C++ library is typically built with debugging symbols included. If you want to customize these options you should use the CXXFLAGS option in configure, as such:

./configure CXXFLAGS='-g -O2'
./configure CFLAGS='-g -O2'

To enable gcov required options -fprofile-arcs -ftest-coverage enable them:

./configure  --enable-coverage

Run ./configure --help to see other configuration options

Please be aware that the Python library will ignore the --prefix option and just install wherever Python's distutils puts it (usually along the lines of /usr/lib/pythonX.Y/site-packages/). If you need to control where the Python modules are installed, set the PY_PREFIX variable. (DESTDIR is respected for Python and C++.)

Make thrift:


From the top directory, become superuser and do:

make install

Note that some language packages must be installed manually using build tools better suited to those languages (at the time of this writing, this applies to Java, Ruby, PHP).

Look for the file in the lib// folder for more details on the installation of each language library package.


There are a large number of client library tests that can all be run from the top-level directory.

      make -k check

This will make all of the libraries (as necessary), and run through the unit tests defined in each of the client libraries. If a single language fails, the make check will continue on and provide a synopsis at the end.

To run the cross-language test suite, please run:

      make cross

This will run a set of tests that use different language clients and servers.

Something went wrong with that request. Please try again.