1. class
  2. Google
  3. \
  4. ApiCore
  5. \
  6. Transport
  7. \
  8. Rest
  9. \
  10. JsonStreamDecoder

JsonStreamDecoder

class JsonStreamDecoder (View source)

Constants

ESCAPE_CHAR

Methods

__construct(StreamInterface $stream, string $decodeType, array $options = [])

JsonStreamDecoder is a HTTP-JSON response stream decoder for JSON-ecoded protobuf messages. The response stream must be a JSON array, where the first byte is the opening of the array (i.e. '['), and the last byte is the closing of the array (i.e. ']'). Each array item must be a JSON object and comma separated.

Generator
decode()

Begins decoding the configured response stream. It is a generator which yields messages of the given decode type from the stream until the stream completes. Throws an Exception if the stream is closed before the closing byte is read or if it encounters an error while decoding a message.

void
close()

Closes the underlying stream. If the stream is actively being decoded, an exception will not be thrown due to the interruption.

Details

at line 89
__construct(StreamInterface $stream, string $decodeType, array $options = [])

JsonStreamDecoder is a HTTP-JSON response stream decoder for JSON-ecoded protobuf messages. The response stream must be a JSON array, where the first byte is the opening of the array (i.e. '['), and the last byte is the closing of the array (i.e. ']'). Each array item must be a JSON object and comma separated.

Parameters

StreamInterface $stream

The stream to decode.
string $decodeType

The type name of response messages to decode.
array $options

{ An array of optional arguments.

@type bool $ignoreUnknown
      Toggles whether or not to throw an exception when an unknown field
      is encountered in a response message. The default is true.
@type int $readChunkSizeBytes
      The upper size limit in bytes that can be read at a time from the
      response stream. The default is 1 KB.

}

at line 111
Generator decode()

Begins decoding the configured response stream. It is a generator which yields messages of the given decode type from the stream until the stream completes. Throws an Exception if the stream is closed before the closing byte is read or if it encounters an error while decoding a message.

Return Value

Generator

Exceptions

RuntimeException

at line 252
void close()

Closes the underlying stream. If the stream is actively being decoded, an exception will not be thrown due to the interruption.

Return Value

void