Repository files navigation

Last Modified: 2014-03-16

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

http://www.apache.org/licenses/LICENSE-2.0

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

Thrift is a lightweight, language-independent software stack with anassociated code generation mechanism for RPC. Thrift provides cleanabstractions for data transport, data serialization, and applicationlevel processing. The code generation system takes a simple definitionlanguage as its input and generates code across programming languages thatuses the abstracted stack to build interoperable RPC clients and servers.

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

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

thrift/

compiler/

Contains the Thrift compiler, implemented in C++.

lib/

Contains the Thrift software library implementation, subdivided bylanguage of implementation.cpp/go/java/php/py/rb/

test/

Contains sample Thrift files and test code across the target programminglanguages.

tutorial/

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

Seehttp://thrift.apache.org/docs/install for an up-to-date list of build requirements.

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

 http://thrift.apache.org

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 willneed to generate the configure scripts. (This is not necessary if youdownloaded a tarball.) From the top directory, do:

./bootstrap.sh

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

./configure

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 debuggingsymbols included. If you want to customize these options you should use theCXXFLAGS option in configure, as such:

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

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 optionand just install wherever Python's distutils puts it (usually alongthe lines of /usr/lib/pythonX.Y/site-packages/). If you need to controlwhere the Python modules are installed, set the PY_PREFIX variable.(DESTDIR is respected for Python and C++.)

Make thrift:

make

From the top directory, become superuser and do:

make install

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

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

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

      make -k check

This will make all of the libraries (as necessary), and run throughthe unit tests defined in each of the client libraries. If a singlelanguage fails, the make check will continue on and provide a synopsisat 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 andservers.