1Apache Thrift 2============= 3 4Introduction 5============ 6 7Thrift is a lightweight, language-independent software stack for 8point-to-point RPC implementation. 9Thrift provides clean abstractions and implementations for data transport, 10data serialization, and application level processing. The code generation 11system takes a simple definition language as input and generates code 12across programming languages that uses the abstracted stack to build 13interoperable RPC clients and servers. 14 15 16 17Thrift makes it easy for programs written in different programming 18languages to share data and call remote procedures. With support 19for [28 programming languages](LANGUAGES.md), chances are Thrift 20supports the languages that you currently use. 21 22Thrift is specifically designed to support non-atomic version changes 23across client and server code. This allows you to upgrade your 24server while still being able to service older clients; or have newer 25clients issue requests to older servers. An excellent community-provided 26write-up about thrift and compatibility when versioning an API can be 27found in the [Thrift Missing Guide](https://diwakergupta.github.io/thrift-missing-guide/#_versioning_compatibility). 28 29For more details on Thrift's design and implementation, see the Thrift 30whitepaper included in this distribution, or at the README.md file 31in your particular subdirectory of interest. 32 33Status 34====== 35 36| Branch | Travis | Appveyor | Coverity Scan | codecov.io | Website | 37| :----- | :----- | :------- | :------------ | :--------- | :------ | 38| [`master`](https://github.com/apache/thrift/tree/master) | [](https://app.travis-ci.com/apache/thrift/branches) | [](https://ci.appveyor.com/project/ApacheSoftwareFoundation/thrift/history) | [](https://scan.coverity.com/projects/thrift) | | [](https://thrift.apache.org/) | 39| [`0.17.0`](https://github.com/apache/thrift/tree/0.17.0) | [](https://app.travis-ci.com/apache/thrift/branches) | | | | | 40 41Releases 42======== 43 44Thrift does not maintain a specific release calendar at this time. 45 46We strive to release twice yearly. Download the [current release](http://thrift.apache.org/download). 47 48License 49======= 50 51Licensed to the Apache Software Foundation (ASF) under one 52or more contributor license agreements. See the NOTICE file 53distributed with this work for additional information 54regarding copyright ownership. The ASF licenses this file 55to you under the Apache License, Version 2.0 (the 56"License"); you may not use this file except in compliance 57with the License. You may obtain a copy of the License at 58 59 http://www.apache.org/licenses/LICENSE-2.0 60 61Unless required by applicable law or agreed to in writing, 62software distributed under the License is distributed on an 63"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 64KIND, either express or implied. See the License for the 65specific language governing permissions and limitations 66under the License. 67 68Project Hierarchy 69================= 70 71thrift/ 72 73 compiler/ 74 75 Contains the Thrift compiler, implemented in C++. 76 77 lib/ 78 79 Contains the Thrift software library implementation, subdivided by 80 language of implementation. 81 82 cpp/ 83 go/ 84 java/ 85 php/ 86 py/ 87 rb/ 88 ... 89 90 test/ 91 92 Contains sample Thrift files and test code across the target programming 93 languages. 94 95 tutorial/ 96 97 Contains a basic tutorial that will teach you how to develop software 98 using Thrift. 99 100Development 101=========== 102 103To build the same way Travis CI builds the project you should use docker. 104We have [comprehensive building instructions for docker](build/docker/README.md). 105 106Requirements 107============ 108 109See http://thrift.apache.org/docs/install for a list of build requirements (may be stale). Alternatively, see the docker build environments for a list of prerequisites. 110 111Resources 112========= 113 114More information about Thrift can be obtained on the Thrift webpage at: 115 116 http://thrift.apache.org 117 118Acknowledgments 119=============== 120 121Thrift was inspired by pillar, a lightweight RPC tool written by Adam D'Angelo, 122and also by Google's protocol buffers. 123 124Installation 125============ 126 127If you are building from the first time out of the source repository, you will 128need to generate the configure scripts. (This is not necessary if you 129downloaded a tarball.) From the top directory, do: 130 131 ./bootstrap.sh 132 133Once the configure scripts are generated, thrift can be configured. 134From the top directory, do: 135 136 ./configure 137 138You may need to specify the location of the boost files explicitly. 139If you installed boost in `/usr/local`, you would run configure as follows: 140 141 ./configure --with-boost=/usr/local 142 143Note that by default the thrift C++ library is typically built with debugging 144symbols included. If you want to customize these options you should use the 145CXXFLAGS option in configure, as such: 146 147 ./configure CXXFLAGS='-g -O2' 148 ./configure CFLAGS='-g -O2' 149 ./configure CPPFLAGS='-DDEBUG_MY_FEATURE' 150 151To enable gcov required options -fprofile-arcs -ftest-coverage enable them: 152 153 ./configure --enable-coverage 154 155Run ./configure --help to see other configuration options 156 157Please be aware that the Python library will ignore the --prefix option 158and just install wherever Python's distutils puts it (usually along 159the lines of `/usr/lib/pythonX.Y/site-packages/`). If you need to control 160where the Python modules are installed, set the PY_PREFIX variable. 161(DESTDIR is respected for Python and C++.) 162 163Make thrift: 164 165 make 166 167From the top directory, become superuser and do: 168 169 make install 170 171Uninstall thrift: 172 173 make uninstall 174 175Note that some language packages must be installed manually using build tools 176better suited to those languages (at the time of this writing, this applies 177to Java, Ruby, PHP). 178 179Look for the README.md file in the lib/<language>/ folder for more details on the 180installation of each language library package. 181 182Package Managers 183================ 184 185Apache Thrift is available via a number of package managers, a list which is 186is steadily growing. A more detailed overview can be found 187[at the Apache Thrift web site under "Libraries"](http://thrift.apache.org/lib/) 188and/or in the respective READMEs for each language under /lib 189 190Testing 191======= 192 193There are a large number of client library tests that can all be run 194from the top-level directory. 195 196 make -k check 197 198This will make all of the libraries (as necessary), and run through 199the unit tests defined in each of the client libraries. If a single 200language fails, the make check will continue on and provide a synopsis 201at the end. 202 203To run the cross-language test suite, please run: 204 205 make cross 206 207This will run a set of tests that use different language clients and 208servers. 209 210 211
){kind=link}
){kind=link}
){kind=link}
){kind=link}