java.lang.Object
- io.protostuff.WriteSession
- - io.protostuff.KvpOutput

All Implemented Interfaces:

Output
```
public final class KvpOutput
extends WriteSession
implements Output
```
An output for serializing kvp-encoded messages (from a byte array as source). A kvp encoding is a binary encoding w/c contains a key-value sequence. On the wire, a serialized field (key-value) would look like: [key-len][key][value-len][value]
The keys and values are length-delimited (uint16 little endian).
Note that this encoding does not support nested messages. This encoding is mostly useful for headers w/c contain information about the content it carries (see http://projects.unbit.it/uwsgi/wiki/uwsgiProtocol).

Nested Class Summary
- Nested classes/interfaces inherited from class io.protostuff.WriteSession
  WriteSession.FlushHandler

Field Summary

Fields
Modifier and Type Field Description

(package private) byte[] numBuf

(package private) boolean numeric

private Schema<?> schema
- Fields inherited from class io.protostuff.WriteSession
  flushHandler, head, nextBufferSize, out, sink, size, tail

Constructor Summary

Constructors
Constructor	Description
`KvpOutput(LinkedBuffer head, Schema<?> schema, boolean numeric)`
`KvpOutput(LinkedBuffer head, java.io.OutputStream out, Schema<?> schema, boolean numeric)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`KvpOutput`	`use(Schema<?> schema, boolean clearBuffer)`
`void`	`writeBool(int fieldNumber, boolean value, boolean repeated)`	Writes a boolean field.
`void`	`writeByteArray(int fieldNumber, byte[] value, boolean repeated)`	Writes a byte array field.
`void`	`writeByteRange(boolean utf8String, int fieldNumber, byte[] value, int offset, int length, boolean repeated)`	Writes a binary or a pre-encoded utf8 string.
`void`	`writeBytes(int fieldNumber, ByteString value, boolean repeated)`	Writes a ByteString(wraps byte array) field.
`void`	`writeBytes(int fieldNumber, java.nio.ByteBuffer value, boolean repeated)`	Writes a ByteBuffer field.
`void`	`writeDouble(int fieldNumber, double value, boolean repeated)`	Writes a double field.
`void`	`writeEnum(int fieldNumber, int value, boolean repeated)`	Writes a enum(its number) field.
`private LinkedBuffer`	`writeField(int number, int valueLen, LinkedBuffer lb)`
`private LinkedBuffer`	`writeField(int number, LinkedBuffer lb)`
`void`	`writeFixed32(int fieldNumber, int value, boolean repeated)`	Writes a fixed int(4 bytes) field.
`void`	`writeFixed64(int fieldNumber, long value, boolean repeated)`	Writes a fixed long(8 bytes) field.
`void`	`writeFloat(int fieldNumber, float value, boolean repeated)`	Writes a float field.
`void`	`writeInt32(int fieldNumber, int value, boolean repeated)`	Writes a variable int field.
`void`	`writeInt64(int fieldNumber, long value, boolean repeated)`	Writes a variable long field.
`<T> void`	`writeObject(int fieldNumber, T value, Schema<T> schema, boolean repeated)`	Writes an object(using its schema) field.
`void`	`writeSFixed32(int fieldNumber, int value, boolean repeated)`	Writes a signed+fixed int(4 bytes) field.
`void`	`writeSFixed64(int fieldNumber, long value, boolean repeated)`	Writes a signed+fixed long(8 bytes) field.
`void`	`writeSInt32(int fieldNumber, int value, boolean repeated)`	Writes a signed int field.
`void`	`writeSInt64(int fieldNumber, long value, boolean repeated)`	Writes a signed long field.
`void`	`writeString(int fieldNumber, java.lang.CharSequence value, boolean repeated)`	Writes a String field.
`void`	`writeUInt32(int fieldNumber, int value, boolean repeated)`	Writes an unsigned int field.
`void`	`writeUInt64(int fieldNumber, long value, boolean repeated)`	Writes an unsigned long field.

Methods inherited from class io.protostuff.WriteSession
clear, flush, flush, flush, getSize, reset, toByteArray

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

Field Detail

numBuf
```
final byte[] numBuf
```

numeric
```
final boolean numeric
```

schema
```
private Schema<?> schema
```

Constructor Detail

KvpOutput

public KvpOutput(LinkedBuffer head,
                 Schema<?> schema,
                 boolean numeric)

KvpOutput

public KvpOutput(LinkedBuffer head,
                 java.io.OutputStream out,
                 Schema<?> schema,
                 boolean numeric)

Method Detail

use

public KvpOutput use(Schema<?> schema,
                     boolean clearBuffer)

writeField

private LinkedBuffer writeField(int number,
                                LinkedBuffer lb)
                         throws java.io.IOException

Throws:: java.io.IOException

writeField

private LinkedBuffer writeField(int number,
                                int valueLen,
                                LinkedBuffer lb)
                         throws java.io.IOException

Throws:: java.io.IOException