summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Reiss <dreiss@apache.org>2008-06-11 01:19:02 +0000
committerDavid Reiss <dreiss@apache.org>2008-06-11 01:19:02 +0000
commit218c11f70164ef22de51f1abc05624f56418cad7 (patch)
tree1993f042d4529275df5052298a7fe7e3b6592613 /doc
parentc88eb8c9dda2bd5100216458779f8bff7b1a9275 (diff)
downloadthrift-218c11f70164ef22de51f1abc05624f56418cad7.tar.gz
Move some top-level files into more sensible directories.
git-svn-id: https://svn.apache.org/repos/asf/incubator/thrift/trunk@666499 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'doc')
-rw-r--r--doc/thrift.bnf82
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/thrift.bnf b/doc/thrift.bnf
new file mode 100644
index 000000000..60e757d74
--- /dev/null
+++ b/doc/thrift.bnf
@@ -0,0 +1,82 @@
+Thrift Protocol Structure
+
+Mark Slee (mcslee@facebook.com)
+
+Last Modified: 2007-Jun-29
+
+Thrift is distributed under the Thrift open source software license.
+Please see the included LICENSE file.
+
+--------------------------------------------------------------------
+
+This document describes the structure of the Thrift protocol
+without specifying the encoding. Thus, the order of elements
+could in some cases be rearranged depending upon the TProtocol
+implementation, but this document specifies the minimum required
+structure. There are some "dumb" terminals like STRING and INT
+that take the place of an actual encoding specification.
+
+They key point to notice is that ALL messages are just one wrapped
+<struct>. Depending upon the message type, the <struct> can be
+interpreted as the argument list to a function, the return value
+of a function, or an exception.
+
+--------------------------------------------------------------------
+
+ <message> ::= <message-begin> <struct> <message-end>
+
+ <message-begin> ::= <method-name> <message-type> <message-seqid>
+
+ <method-name> ::= STRING
+
+ <message-type> ::= T_CALL | T_REPLY | T_EXCEPTION
+
+ <message-seqid> ::= I32
+
+ <struct> ::= <struct-begin> <field>* <field-stop> <struct-end>
+
+ <struct-begin> ::= <struct-name>
+
+ <struct-name> ::= STRING
+
+ <field-stop> ::= T_STOP
+
+ <field> ::= <field-begin> <field-data> <field-end>
+
+ <field-begin> ::= <field-name> <field-type> <field-id>
+
+ <field-name> ::= STRING
+
+ <field-type> ::= T_BOOL | T_BYTE | T_I8 | T_I16 | T_I32 | T_I64 | T_DOUBLE
+ | T_STRING | T_STRUCT | T_MAP | T_SET | T_LIST
+
+ <field-id> ::= I16
+
+ <field-data> ::= I8 | I16 | I32 | I64 | DOUBLE | STRING |
+ <struct> | <map> | <list> | <set>
+
+ <map> ::= <map-begin> <field-datum>* <map-end>
+
+ <map-begin> ::= <map-key-type> <map-value-type> <map-size>
+
+ <map-key-type> ::= <field-type>
+
+<map-value-type> ::= <field-type>
+
+ <map-size> ::= I32
+
+ <list> ::= <list-begin> <field-data>* <list-end>
+
+ <list-begin> ::= <list-elem-type> <list-size>
+
+<list-elem-type> ::= <field-type>
+
+ <list-size> ::= I32
+
+ <set> ::= <set-begin> <field-data>* <set-end>
+
+ <set-begin> ::= <set-elem-type> <set-size>
+
+ <set-elem-type> ::= <field-type>
+
+ <set-size> ::= I32