TTextProtocol (Armeria 0.48.0 API reference)

java.lang.Object
- org.apache.thrift.protocol.TProtocol
- - com.linecorp.armeria.common.thrift.text.TTextProtocol

```
public class TTextProtocol
extends TProtocol
```
A simple text format for serializing/deserializing thrift messages. This format is inefficient in space.
For an example, see: tests/resources/com/twitter/common/thrift/text/TTextProtocol_TestData.txt
which is a text encoding of the thrift message defined in:
src/main/thrift/com/twitter/common/thrift/text/TTextProtocolTest.thrift
Whitespace (including newlines) is not significant.
No comments are allowed in the json.
Messages must be formatted as a JSON object with a field 'method' containing the message name, 'type' containing the message type as an uppercase string corresponding to TMessageType, 'args' containing a JSON object with the actual arguments, and an optional 'seqid' field containing the sequence id. If 'seqid' is not provided, it will be treated as 0. 'args' should use the argument names as defined in the service definition.
Example:{ "method": "GetItem", "type": "CALL", "args": { "id": 1, "fetchAll": true }, "seqid": 100 }
TODO(Alex Roetter): write a wrapper that allows us to read in a file of many structs (perhaps stored in a JsonArray), passing each struct to this class for parsing.
See thrift's @see org.apache.thrift.protocol.TJSONProtocol for another example an implementation of the @see TProtocol interface. This class is based on that.
TODO(Alex Roetter): Also add a new TEXT_PROTOCOL field to ThriftCodec
TODO: Support map enum keys specified as strings.
TODO: Support string values for enums that have been typedef'd.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TTextProtocol.Factory
Factory.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TTextProtocol.Factory` Factory.

Field Summary
- Fields inherited from class org.apache.thrift.protocol.TProtocol
  trans_

Constructor Summary

Constructors
Constructor and Description

TTextProtocol(TTransport trans)
Create a parser which can read from trans, and create the output writer that can write to a TTransport.

Constructors
Constructor and Description
`TTextProtocol(TTransport trans)` Create a parser which can read from trans, and create the output writer that can write to a TTransport.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Class<? extends IScheme>`	`getScheme()`
`ByteBuffer`	`readBinary()`
`boolean`	`readBool()`
`byte`	`readByte()`
`double`	`readDouble()`
`TField`	`readFieldBegin()`
`void`	`readFieldEnd()`
`short`	`readI16()`
`int`	`readI32()`
`long`	`readI64()`
`TList`	`readListBegin()`
`void`	`readListEnd()`
`TMap`	`readMapBegin()`
`void`	`readMapEnd()`
`TMessage`	`readMessageBegin()`
`void`	`readMessageEnd()`
`TSet`	`readSetBegin()`
`void`	`readSetEnd()`
`String`	`readString()`
`TStruct`	`readStructBegin()`
`void`	`readStructEnd()`
`void`	`reset()`
`void`	`writeBinary(ByteBuffer buf)`
`void`	`writeBool(boolean b)`
`void`	`writeByte(byte b)`
`void`	`writeDouble(double dub)`
`void`	`writeFieldBegin(TField field)`
`void`	`writeFieldEnd()`
`void`	`writeFieldStop()`
`void`	`writeI16(short i16)`
`void`	`writeI32(int i32)`
`void`	`writeI64(long i64)`
`void`	`writeListBegin(TList list)`
`void`	`writeListEnd()`
`void`	`writeMapBegin(TMap map)`
`void`	`writeMapEnd()`
`void`	`writeMessageBegin(TMessage message)` I believe these two messages are called for a thrift service interface.
`void`	`writeMessageEnd()`
`void`	`writeSetBegin(TSet set)`
`void`	`writeSetEnd()`
`void`	`writeString(String str)`
`void`	`writeStructBegin(TStruct struct)`
`void`	`writeStructEnd()`

Methods inherited from class org.apache.thrift.protocol.TProtocol
getTransport

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TTextProtocol
```
public TTextProtocol(TTransport trans)
```
    Create a parser which can read from trans, and create the output writer that can write to a TTransport.
- Method Detail
  - getScheme
```
public Class<? extends IScheme> getScheme()
```
    Overrides:
    
    getScheme in class TProtocol
  - reset
```
public final void reset()
```
    Overrides:
    
    reset in class TProtocol
  - writeMessageBegin
```
public void writeMessageBegin(TMessage message)
                       throws TException
```
    I believe these two messages are called for a thrift service interface. We don't plan on storing any text objects of that type on disk.
    
    Specified by:
    
    writeMessageBegin in class TProtocol
    
    Throws:
    
    TException
  - writeMessageEnd
```
public void writeMessageEnd()
                     throws TException
```
    Specified by:
    
    writeMessageEnd in class TProtocol
    
    Throws:
    
    TException
  - writeStructBegin
```
public void writeStructBegin(TStruct struct)
                      throws TException
```
    Specified by:
    
    writeStructBegin in class TProtocol
    
    Throws:
    
    TException
  - writeStructEnd
```
public void writeStructEnd()
                    throws TException
```
    Specified by:
    
    writeStructEnd in class TProtocol
    
    Throws:
    
    TException
  - writeFieldBegin
```
public void writeFieldBegin(TField field)
                     throws TException
```
    Specified by:
    
    writeFieldBegin in class TProtocol
    
    Throws:
    
    TException
  - writeFieldEnd
```
public void writeFieldEnd()
                   throws TException
```
    Specified by:
    
    writeFieldEnd in class TProtocol
    
    Throws:
    
    TException
  - writeFieldStop
```
public void writeFieldStop()
                    throws TException
```
    Specified by:
    
    writeFieldStop in class TProtocol
    
    Throws:
    
    TException
  - writeMapBegin
```
public void writeMapBegin(TMap map)
                   throws TException
```
    Specified by:
    
    writeMapBegin in class TProtocol
    
    Throws:
    
    TException
  - writeMapEnd
```
public void writeMapEnd()
                 throws TException
```
    Specified by:
    
    writeMapEnd in class TProtocol
    
    Throws:
    
    TException
  - writeListBegin
```
public void writeListBegin(TList list)
                    throws TException
```
    Specified by:
    
    writeListBegin in class TProtocol
    
    Throws:
    
    TException
  - writeListEnd
```
public void writeListEnd()
                  throws TException
```
    Specified by:
    
    writeListEnd in class TProtocol
    
    Throws:
    
    TException
  - writeSetBegin
```
public void writeSetBegin(TSet set)
                   throws TException
```
    Specified by:
    
    writeSetBegin in class TProtocol
    
    Throws:
    
    TException
  - writeSetEnd
```
public void writeSetEnd()
                 throws TException
```
    Specified by:
    
    writeSetEnd in class TProtocol
    
    Throws:
    
    TException
  - writeBool
```
public void writeBool(boolean b)
               throws TException
```
    Specified by:
    
    writeBool in class TProtocol
    
    Throws:
    
    TException
  - writeByte
```
public void writeByte(byte b)
               throws TException
```
    Specified by:
    
    writeByte in class TProtocol
    
    Throws:
    
    TException
  - writeI16
```
public void writeI16(short i16)
              throws TException
```
    Specified by:
    
    writeI16 in class TProtocol
    
    Throws:
    
    TException
  - writeI32
```
public void writeI32(int i32)
              throws TException
```
    Specified by:
    
    writeI32 in class TProtocol
    
    Throws:
    
    TException
  - writeI64
```
public void writeI64(long i64)
              throws TException
```
    Specified by:
    
    writeI64 in class TProtocol
    
    Throws:
    
    TException
  - writeDouble
```
public void writeDouble(double dub)
                 throws TException
```
    Specified by:
    
    writeDouble in class TProtocol
    
    Throws:
    
    TException
  - writeString
```
public void writeString(String str)
                 throws TException
```
    Specified by:
    
    writeString in class TProtocol
    
    Throws:
    
    TException
  - writeBinary
```
public void writeBinary(ByteBuffer buf)
                 throws TException
```
    Specified by:
    
    writeBinary in class TProtocol
    
    Throws:
    
    TException
  - readMessageBegin
```
public TMessage readMessageBegin()
                          throws TException
```
    Specified by:
    
    readMessageBegin in class TProtocol
    
    Throws:
    
    TException
  - readMessageEnd
```
public void readMessageEnd()
                    throws TException
```
    Specified by:
    
    readMessageEnd in class TProtocol
    
    Throws:
    
    TException
  - readStructBegin
```
public TStruct readStructBegin()
                        throws TException
```
    Specified by:
    
    readStructBegin in class TProtocol
    
    Throws:
    
    TException
  - readStructEnd
```
public void readStructEnd()
                   throws TException
```
    Specified by:
    
    readStructEnd in class TProtocol
    
    Throws:
    
    TException
  - readFieldBegin
```
public TField readFieldBegin()
                      throws TException
```
    Specified by:
    
    readFieldBegin in class TProtocol
    
    Throws:
    
    TException
  - readFieldEnd
```
public void readFieldEnd()
                  throws TException
```
    Specified by:
    
    readFieldEnd in class TProtocol
    
    Throws:
    
    TException
  - readMapBegin
```
public TMap readMapBegin()
                  throws TException
```
    Specified by:
    
    readMapBegin in class TProtocol
    
    Throws:
    
    TException
  - readMapEnd
```
public void readMapEnd()
                throws TException
```
    Specified by:
    
    readMapEnd in class TProtocol
    
    Throws:
    
    TException
  - readListBegin
```
public TList readListBegin()
                    throws TException
```
    Specified by:
    
    readListBegin in class TProtocol
    
    Throws:
    
    TException
  - readListEnd
```
public void readListEnd()
                 throws TException
```
    Specified by:
    
    readListEnd in class TProtocol
    
    Throws:
    
    TException
  - readSetBegin
```
public TSet readSetBegin()
                  throws TException
```
    Specified by:
    
    readSetBegin in class TProtocol
    
    Throws:
    
    TException
  - readSetEnd
```
public void readSetEnd()
                throws TException
```
    Specified by:
    
    readSetEnd in class TProtocol
    
    Throws:
    
    TException
  - readBool
```
public boolean readBool()
                 throws TException
```
    Specified by:
    
    readBool in class TProtocol
    
    Throws:
    
    TException
  - readByte
```
public byte readByte()
              throws TException
```
    Specified by:
    
    readByte in class TProtocol
    
    Throws:
    
    TException
  - readI16
```
public short readI16()
              throws TException
```
    Specified by:
    
    readI16 in class TProtocol
    
    Throws:
    
    TException
  - readI32
```
public int readI32()
            throws TException
```
    Specified by:
    
    readI32 in class TProtocol
    
    Throws:
    
    TException
  - readI64
```
public long readI64()
             throws TException
```
    Specified by:
    
    readI64 in class TProtocol
    
    Throws:
    
    TException
  - readDouble
```
public double readDouble()
                  throws TException
```
    Specified by:
    
    readDouble in class TProtocol
    
    Throws:
    
    TException
  - readString
```
public String readString()
                  throws TException
```
    Specified by:
    
    readString in class TProtocol
    
    Throws:
    
    TException
  - readBinary
```
public ByteBuffer readBinary()
                      throws TException
```
    Specified by:
    
    readBinary in class TProtocol
    
    Throws:
    
    TException

Class TTextProtocol

Nested Class Summary

Field Summary

Fields inherited from class org.apache.thrift.protocol.TProtocol

Constructor Summary

Method Summary

Methods inherited from class org.apache.thrift.protocol.TProtocol

Methods inherited from class java.lang.Object

Constructor Detail

TTextProtocol

Method Detail

getScheme

reset

writeMessageBegin

writeMessageEnd

writeStructBegin

writeStructEnd

writeFieldBegin

writeFieldEnd

writeFieldStop

writeMapBegin

writeMapEnd

writeListBegin

writeListEnd

writeSetBegin

writeSetEnd

writeBool

writeByte

writeI16

writeI32

writeI64

writeDouble

writeString

writeBinary

readMessageBegin

readMessageEnd

readStructBegin

readStructEnd

readFieldBegin

readFieldEnd

readMapBegin

readMapEnd

readListBegin

readListEnd

readSetBegin

readSetEnd

readBool

readByte

readI16

readI32

readI64

readDouble

readString

readBinary