[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/Amazon/ -> Sqs.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 444 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Service_Amazon_Sqs:: (12 methods):
  __construct()
  create()
  delete()
  getQueues()
  count()
  send()
  receive()
  deleteMessage()
  getAttribute()
  _makeRequest()
  addRequiredParameters()
  _signParameters()


Class: Zend_Service_Amazon_Sqs  - X-Ref

Class for connecting to the Amazon Simple Queue Service (SQS)

__construct($accessKey = null, $secretKey = null, $region = null)   X-Ref
Constructor

param: string $accessKey
param: string $secretKey
param: string $region

create($queue_name, $timeout = null)   X-Ref
Create a new queue

Visibility timeout is how long a message is left in the queue "invisible"
to other readers.  If the message is acknowleged (deleted) before the
timeout, then the message is deleted.  However, if the timeout expires
then the message will be made available to other queue readers.

param: string  $queue_name queue name
param: integer $timeout    default visibility timeout
return: string|boolean

delete($queue_url)   X-Ref
Delete a queue and all of it's messages

Returns false if the queue is not found, true if the queue exists

param: string  $queue_url queue URL
return: boolean

getQueues()   X-Ref
Get an array of all available queues

return: array

count($queue_url)   X-Ref
Return the approximate number of messages in the queue

param: string  $queue_url Queue URL
return: integer

send($queue_url, $message)   X-Ref
Send a message to the queue

param: string $queue_url Queue URL
param: string $message   Message to send to the queue
return: string            Message ID

receive($queue_url, $max_messages = null, $timeout = null)   X-Ref
Get messages in the queue

param: string  $queue_url    Queue name
param: integer $max_messages Maximum number of messages to return
param: integer $timeout      Visibility timeout for these messages
return: array

deleteMessage($queue_url, $handle)   X-Ref
Delete a message from the queue

Returns true if the message is deleted, false if the deletion is
unsuccessful.

param: string $queue_url  Queue URL
param: string $handle     Message handle as returned by SQS
return: boolean

getAttribute($queue_url, $attribute = 'All')   X-Ref
Get the attributes for the queue

param: string $queue_url  Queue URL
param: string $attribute
return: string

_makeRequest($queue_url, $action, $params = array()   X-Ref
Make a request to Amazon SQS

param: string           $queue  Queue Name
param: string           $action SQS action
param: array            $params
return: SimpleXMLElement

addRequiredParameters($queue_url, array $parameters)   X-Ref
Adds required authentication and version parameters to an array of
parameters

The required parameters are:
- AWSAccessKey
- SignatureVersion
- Timestamp
- Version and
- Signature

If a required parameter is already set in the <tt>$parameters</tt> array,
it is overwritten.

param: string $queue_url  Queue URL
param: array  $parameters the array to which to add the required
return: array

_signParameters($queue_url, array $paramaters)   X-Ref
Computes the RFC 2104-compliant HMAC signature for request parameters

This implements the Amazon Web Services signature, as per the following
specification:

1. Sort all request parameters (including <tt>SignatureVersion</tt> and
excluding <tt>Signature</tt>, the value of which is being created),
ignoring case.

2. Iterate over the sorted list and append the parameter name (in its
original case) and then its value. Do not URL-encode the parameter
values before constructing this string. Do not use any separator
characters when appending strings.

param: string $queue_url  Queue URL
param: array  $parameters the parameters for which to get the signature.
return: string the signed data.



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1