thrift/tutorial
Roger Meier 49ff8b123a THRIFT-1552 Include paths for c/c++ should be prefixed with 'thrift/'
To ensure there are no include path collisions the C and C++ header
include paths should include 'thrift' as the root leaf. This will
prevent having to place /usr/include/thrift into the compilers include
header search path, which might otherwise result in the compiler
accidentally picking up headers that it shouldn't.

e.g. #include <foo/bar.h> should be #include <thrift/foo/bar.h>

Change-Id: I48f2b0f549bda0fc81e85506ac857adc800b98a1

git-svn-id: https://svn.apache.org/repos/asf/thrift/trunk@1325674 13f79535-47bb-0310-9956-ffa450edef68
2012-04-13 09:12:31 +00:00
..
cpp THRIFT-1552 Include paths for c/c++ should be prefixed with 'thrift/' 2012-04-13 09:12:31 +00:00
csharp THRIFT-881. csharp: add csharp to the tutorial 2010-09-24 16:47:59 +00:00
d THRIFT-1500: d programming language support 2012-03-22 21:49:10 +00:00
delphi THRIFT-1555 Delphi version of the tutorial code 2012-04-09 16:31:42 +00:00
erl THRIFT-1227 - erlang implementation of thrift json protocol 2011-09-18 04:57:50 +00:00
go THRIFT-625: Add support for 'Go'; provided by Aalok Shah. 2011-02-20 02:39:19 +00:00
hs add ASL to a handful of files 2010-07-28 18:23:22 +00:00
java updating java tutorial readme 2011-07-25 13:22:14 +00:00
js THRIFT-1133 Java and JavaScript tutorial is broken since we have Java maven deployment 2011-04-08 21:28:50 +00:00
perl THRIFT-619: Perl server and example 2009-11-12 03:01:33 +00:00
php THRIFT-592. php: Make the tutorial work properly after r815878 2009-12-09 19:29:48 +00:00
py THRIFT-387. Add license headers to a bunch of files 2009-03-30 21:35:00 +00:00
py.twisted Thrift-1303: Twisted tutorial client does not include correct generated path 2011-08-29 15:27:41 +00:00
rb THRIFT-486. rb: ruby tutorial needs updated require statements 2009-05-05 18:59:49 +00:00
README THRIFT-387. Add appropriate Apache header to all code files 2009-04-08 00:19:37 +00:00
shared.thrift THRIFT-1500: d programming language support 2012-03-22 21:49:10 +00:00
tutorial.thrift THRIFT-1500: d programming language support 2012-03-22 21:49:10 +00:00

Thrift Tutorial

License
=======

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

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

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

Tutorial
========

1) First things first, you'll need to install the Thrift compiler and the
   language libraries. Do that using the instructions in the top level
   README file.

2) Read tutorial.thrift to learn about the syntax of a Thrift file

3) Compile the code for the language of your choice:

     $ thrift
     $ thrift -r --gen cpp tutorial.thrift

4) Take a look at the generated code.

5) Look in the language directories for sample client/server code.

6) That's about it for now. This tutorial is intentionally brief. It should be
   just enough to get you started and ready to build your own project.