google/appengine/api/taskqueue/PushQueue.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\appengine\api\taskqueue\PushQueue

Package: Default
A PushQueue executes PushTasks by sending the task back to the application in the form of an HTTP request to one of the application's handlers.

Constants

>VConstant  MAX_TASKS_PER_ADD = 100
The maximum number of tasks in a single call addTasks.

Methods

methodpublic__construct(string $name = 'default') : void

Construct a PushQueue

Parameters
NameTypeDescription
$namestring

The name of the queue.

methodpublicaddTasks(\google\appengine\api\taskqueue\PushTask[] $tasks) : \google\appengine\api\taskqueue\An

Add tasks to the queue.

Parameters
NameTypeDescription
$tasks\google\appengine\api\taskqueue\PushTask[]

The tasks to be added to the queue.

Returns
TypeDescription
\google\appengine\api\taskqueue\Anarray containing the name of each task added, with the same ordering as $tasks.
Throws
ExceptionDescription
\google\appengine\api\taskqueue\TaskAlreadyExistsExceptionif a task of the same name already exists in the queue. If this exception is raised, the caller can be guaranteed that all tasks were successfully added either by this call or a previous call. Another way to express it is that, if any task failed to be added for a different reason, a different exception will be thrown.
\google\appengine\api\taskqueue\TaskQueueExceptionif there was a problem using the service.
methodpublicgetName() : string

Return the queue's name.

Returns
TypeDescription
stringThe queue's name.
Documentation was generated by phpDocumentor 2.0.0a12.