PhutilJSONProtocolChannel.php
View Options

	<?php

	/**
	* Channel that transmits dictionaries of primitives using JSON serialization.
	* This channel is not binary safe.
	*
	* This protocol is implemented by the Phabricator Aphlict realtime notification
	* server.
	*
	* @task protocol Protocol Implementation
	*/
	final class PhutilJSONProtocolChannel extends PhutilProtocolChannel {

	const MODE_LENGTH = 'length';
	const MODE_OBJECT = 'object';

	/**
	* Size of the "length" frame of the protocol in bytes.
	*/
	const SIZE_LENGTH = 8;

	private $mode = self::MODE_LENGTH;
	private $byteLengthOfNextChunk = self::SIZE_LENGTH;
	private $buf = '';


	/* -( Protocol Implementation )-------------------------------------------- */


	/**
	* Encode a message for transmission over the channel. The message should
	* be any serializable as JSON.
	*
	* Objects are transmitted as:
	*
	* <len><json>
	*
	* ...where <len> is an 8-character, zero-padded integer written as a string.
	* For example, this is a valid message:
	*
	* 00000015{"key":"value"}
	*
	* @task protocol
	*/
	protected function encodeMessage($message) {
	if (!is_array($message)) {
	throw new Exception(
	pht(
	'JSON protocol message must be an array, got some other '.
	'type ("%s").',
	phutil_describe_type($message)));
	}

	$message = phutil_json_encode($message);

	$len = sprintf(
	'%0'.self::SIZE_LENGTH.'.'.self::SIZE_LENGTH.'d',
	strlen($message));
	return "{$len}{$message}";
	}


	/**
	* Decode a message received from the other end of the channel. Messages are
	* decoded as associative arrays.
	*
	* @task protocol
	*/
	protected function decodeStream($data) {
	$this->buf .= $data;

	$objects = array();
	while (strlen($this->buf) >= $this->byteLengthOfNextChunk) {
	switch ($this->mode) {
	case self::MODE_LENGTH:
	$len = substr($this->buf, 0, self::SIZE_LENGTH);
	$this->buf = substr($this->buf, self::SIZE_LENGTH);

	if (!preg_match('/^\d+\z/', $len)) {
	$full_buffer = $len.$this->buf;
	$full_length = strlen($full_buffer);

	throw new Exception(
	pht(
	'Protocol channel expected %s-character, zero-padded '.
	'numeric frame length, got something else ("%s"). Full '.
	'buffer (of length %s) begins: %s',
	new PhutilNumber(self::SIZE_LENGTH),
	phutil_encode_log($len),
	new PhutilNumber($full_length),
	phutil_encode_log(substr($len.$this->buf, 0, 128))));
	}

	$this->mode = self::MODE_OBJECT;
	$this->byteLengthOfNextChunk = (int)$len;
	break;
	case self::MODE_OBJECT:
	$data = substr($this->buf, 0, $this->byteLengthOfNextChunk);
	$this->buf = substr($this->buf, $this->byteLengthOfNextChunk);

	try {
	$objects[] = phutil_json_decode($data);
	} catch (PhutilJSONParserException $ex) {
	throw new PhutilProxyException(
	pht('Failed to decode JSON object.'),
	$ex);
	}

	$this->mode = self::MODE_LENGTH;
	$this->byteLengthOfNextChunk = self::SIZE_LENGTH;
	break;
	}
	}

	return $objects;
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Sun, Jan 19, 18:44 (1 w, 4 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1115315
Default Alt Text: PhutilJSONProtocolChannel.php (3 KB)

PhutilJSONProtocolChannel.php
No OneTemporary
Actions

PhutilJSONProtocolChannel.php
View Options

File Metadata

Event Timeline

PhutilJSONProtocolChannel.phpNo OneTemporaryActions

PhutilJSONProtocolChannel.phpView Options

File Metadata

Event Timeline

PhutilJSONProtocolChannel.php
No OneTemporary
Actions

PhutilJSONProtocolChannel.php
View Options