Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)



google/appengine/runtime/proto/ProtocolMessage.php

Table of Contents
Copyright 2007 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

\google\net\ProtocolMessage

Package: Default
The parent class of all protocol buffers.

Subclasses are automatically generated by php protocol buffer compiler. Encoding methods can raise ProtocolBufferEncodeError if a value for an integer or long field is too large, or if any required field is not set. Decoding methods can raise ProtocolBufferDecodeError if they couldn't decode correctly, or the decoded message doesn't have all required fields.

Methods

method public byteSizePartial () : void
abstract

method public checkInitialized () : void
abstract

method public clear () : void
abstract

method public copyFrom (mixed $pb) : void

Copies data from another protocol buffer into this protocol buffer.

Parameters
Name Type Description
$pb mixed

The protocol buffer to copy from.

method public equals ( $proto) : void
abstract

Parameters
Name Type Description
$proto
method public isInitialized () : bool

Checks if this protocol message has all of the requried fields initialized.

Returns
Type Description
bool true if all fields are initialized, false otherwise.
method public mergeFrom ( $proto) : void
abstract

Parameters
Name Type Description
$proto
method public mergeFromString (string $s) : void

Like parseFromString, fills the message with a protocol buffer parsed from the given input string.

Parameters
Name Type Description
$s string

The string containing a serialized protocol buffer.

Throws
Exception Description
\google\net\ProtocolBufferDecodeError If the result message is not correctly initialized.
method public mergePartialFromString (string $s) : void

Like parsePartialFromString, fills the message with a protocol buffer parsed from the given input string.

Will not fail if the resulting protocol buffer is not fully initialized.

Parameters
Name Type Description
$s string

The string containing a serialized protocol buffer.

method public outputPartial ( $encoder) : void
abstract

Parameters
Name Type Description
$encoder
method public parseFromString (string $s) : void

Fills the message with a protocol buffer parsed from the given input string.

Parameters
Name Type Description
$s string

The string containing a serialized protocol buffer.

Throws
Exception Description
\google\net\ProtocolBufferDecodeError If the result message is not correctly initialized.
method public parsePartialFromString (string $s) : void

Fills the message with a protocol buffer parsed from the given input string.

Will not fail if the resulting protocol buffer is not fully initialized.

Parameters
Name Type Description
$s string

The string containing a serialized protocol buffer.

method public serializePartialToString () : string

Serializes a protocol buffer that might not have all of the required fields set.

Returns
Type Description
string The serialized protocol buffer.
method public serializeToString () : string

Serializes the message and return it as a string.

Returns
Type Description
string The serialized protocol buffer.
Throws
Exception Description
\google\net\ProtocolBufferEncodeError If the protocol buffer is not initialized.
method public shortDebugString () : void
abstract

method public tryMerge ( $decoder) : void
abstract

Parameters
Name Type Description
$decoder
Documentation was generated by phpDocumentor 2.0.0a12 .