Overview

Packages

  • sae

Classes

  • SaeTaskQueuePublic
  • Overview
  • Package
  • Class

Class SaeTaskQueuePublic

SAE TaskQueuePublic
任务队列服务

<?php
$queue = new SaeTaskQueuePublic('test');
$queue->setAuth('appName', 'accessKey', 'secretKey', 'appVersion');

//添加单个任务
$queue->addTask("/page1.php");
$queue->addTask("/page2.php", "key=value", true);

//批量添加任务
$array = array();
$array[] = array('url'=>"/page3.php", "postdata"=>"act=test");
$array[] = array('url'=>"/page4.php", "postdata"=>"act=test", "prior"=>true);
$queue->addTask($array);

//将任务推入队列
$ret = $queue->push();

//任务添加失败时输出错误码和错误信息
if ($ret === false)
       var_dump($queue->errno(), $queue->errmsg());
?>

错误码参考: - errno: 0 成功 - errno: 1 认证失败 - errno: 3 参数错误 - errno: 10 队列不存在 - errno: 11 队列已满或剩余长度不足 - errno: 500 服务内部错误 - errno: 999 未知错误 - errno: 403 权限不足或超出配额

Package: sae
Author: lazypeople
Located at saetaskqueuepublic.class.php
Methods summary
public
# __construct( string $queue_name )

构造对象

构造对象

Parameters

$queue_name
队列名称
public boolean
# addTask( string|array $tasks, string $postdata = NULL, boolean $prior = false, array $options = array() )

添加任务

添加任务

Parameters

$tasks

任务要访问的URL或以数组方式传递的多条任务。添加多条任务时的数组格式:

<?php
$tasks = array( array("url" => "/test.php", //只支持相对URL,且"/"开头
                      "postdata" => "data", //要POST的数据。可选
                      "prior" => false,  //是否优先执行,默认为false,如果设为true,则将此任务插入到队列最前面。可选
                      "options" => array('key1' => 'value1', ....),  //附加参数,可选。
), ................);
?>
$postdata
要POST的数据。可选,且仅当$tasks为URL时有效
$prior
是否优先执行,默认为false,如果设为true,则将此任务插入到队列最前面。可选,且仅当$tasks为URL时有效
$options

附加参数,可选,且仅当$tasks为URL时有效。目前支持的参数: - delay, 延时执行,单位秒,最大延时600秒。

Returns

boolean

Author

Elmer Zhang
public integer
# errno( )

取得错误码

取得错误码

Returns

integer

Author

Elmer Zhang
public string
# errmsg( )

取得错误信息

取得错误信息

Returns

string

Author

Elmer Zhang
public boolean
# setAuth( $appname, $accesskey, $secretkey, boolean $appversion = false )

设置应用的授权信息

设置应用的授权信息

Parameters

$appname
应用名
$accesskey
应用的accessKey
$secretkey
应用的secretKey
$appversion
, 应有的版本

Returns

boolean
public boolean
# push( )

将任务列表推入队列

将任务列表推入队列

Returns

boolean

Author

Elmer Zhang
public integer
# leftLength( )

查询队列剩余长度(可再添加的任务数)

查询队列剩余长度(可再添加的任务数)

Returns

integer

Author

Elmer Zhang
public integer
# curLength( )

查询队列当前长度(剩余未执行的任务数)

查询队列当前长度(剩余未执行的任务数)

Returns

integer

Author

Elmer Zhang
API documentation generated by ApiGen