/awsfiles/awsfiles/AWSforPHP/Amazon/SQS/Interface.php

https://github.com/sergey-gagarin/test02 · PHP · 205 lines · 15 code · 35 blank · 155 comment · 0 complexity · b759bd947ffc98e8bf2655ef1b4a1780 MD5 · raw file

  1. <?php
  2. /**
  3. * PHP Version 5
  4. *
  5. * @category Amazon
  6. * @package Amazon_SQS
  7. * @copyright Copyright 2008 Amazon Technologies, Inc.
  8. * @link http://aws.amazon.com
  9. * @license http://aws.amazon.com/apache2.0 Apache License, Version 2.0
  10. * @version 2009-02-01
  11. */
  12. /*******************************************************************************
  13. * __ _ _ ___
  14. * ( )( \/\/ )/ __)
  15. * /__\ \ / \__ \
  16. * (_)(_) \/\/ (___/
  17. *
  18. * Amazon SQS PHP5 Library
  19. * Generated: Wed Apr 08 20:15:38 PDT 2009
  20. *
  21. */
  22. /**
  23. * Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable hosted queue for storing messages as they travel between computers. By using Amazon SQS, developers can simply move data between distributed application components performing different tasks, without losing messages or requiring each component to be always available. Amazon SQS works by exposing Amazon's web-scale messaging infrastructure as a web service. Any computer on the Internet can add or read messages without any installed software or special firewall configurations. Components of applications using Amazon SQS can run independently, and do not need to be on the same network, developed with the same technologies, or running at the same time.
  24. *
  25. */
  26. interface Amazon_SQS_Interface
  27. {
  28. /**
  29. * Create Queue
  30. * The CreateQueue action creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. If you provide the name of an existing queue, a new queue isn't created and an error isn't returned. Instead, the request succeeds and the queue URL for the existing queue is returned. Exception: if you provide a value for DefaultVisibilityTimeout that is different from the value for the existing queue, you receive an error.
  31. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryCreateQueue.html
  32. * @param mixed $request array of parameters for Amazon_SQS_Model_CreateQueueRequest request
  33. * or Amazon_SQS_Model_CreateQueueRequest object itself
  34. * @see Amazon_SQS_Model_CreateQueueRequest
  35. * @return Amazon_SQS_Model_CreateQueueResponse Amazon_SQS_Model_CreateQueueResponse
  36. *
  37. * @throws Amazon_SQS_Exception
  38. */
  39. public function createQueue($request);
  40. /**
  41. * List Queues
  42. * The ListQueues action returns a list of your queues.
  43. *
  44. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryListQueues.html
  45. * @param mixed $request array of parameters for Amazon_SQS_Model_ListQueuesRequest request
  46. * or Amazon_SQS_Model_ListQueuesRequest object itself
  47. * @see Amazon_SQS_Model_ListQueuesRequest
  48. * @return Amazon_SQS_Model_ListQueuesResponse Amazon_SQS_Model_ListQueuesResponse
  49. *
  50. * @throws Amazon_SQS_Exception
  51. */
  52. public function listQueues($request);
  53. /**
  54. * Add Permission
  55. * Adds the specified permission(s) to a queue for the specified principal(s). This allows for sharing access to the queue.
  56. *
  57. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryAddPermission.html
  58. * @param mixed $request array of parameters for Amazon_SQS_Model_AddPermissionRequest request
  59. * or Amazon_SQS_Model_AddPermissionRequest object itself
  60. * @see Amazon_SQS_Model_AddPermissionRequest
  61. * @return Amazon_SQS_Model_AddPermissionResponse Amazon_SQS_Model_AddPermissionResponse
  62. *
  63. * @throws Amazon_SQS_Exception
  64. */
  65. public function addPermission($request);
  66. /**
  67. * Change Message Visibility
  68. * The ChangeMessageVisibility action extends the read lock timeout of the specified message from the specified queue to the specified value.
  69. *
  70. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryChangeMessageVisibility.html
  71. * @param mixed $request array of parameters for Amazon_SQS_Model_ChangeMessageVisibilityRequest request
  72. * or Amazon_SQS_Model_ChangeMessageVisibilityRequest object itself
  73. * @see Amazon_SQS_Model_ChangeMessageVisibilityRequest
  74. * @return Amazon_SQS_Model_ChangeMessageVisibilityResponse Amazon_SQS_Model_ChangeMessageVisibilityResponse
  75. *
  76. * @throws Amazon_SQS_Exception
  77. */
  78. public function changeMessageVisibility($request);
  79. /**
  80. * Delete Message
  81. * The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.
  82. *
  83. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryDeleteMessage.html
  84. * @param mixed $request array of parameters for Amazon_SQS_Model_DeleteMessageRequest request
  85. * or Amazon_SQS_Model_DeleteMessageRequest object itself
  86. * @see Amazon_SQS_Model_DeleteMessageRequest
  87. * @return Amazon_SQS_Model_DeleteMessageResponse Amazon_SQS_Model_DeleteMessageResponse
  88. *
  89. * @throws Amazon_SQS_Exception
  90. */
  91. public function deleteMessage($request);
  92. /**
  93. * Delete Queue
  94. * This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty.
  95. *
  96. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryDeleteQueue.html
  97. * @param mixed $request array of parameters for Amazon_SQS_Model_DeleteQueueRequest request
  98. * or Amazon_SQS_Model_DeleteQueueRequest object itself
  99. * @see Amazon_SQS_Model_DeleteQueueRequest
  100. * @return Amazon_SQS_Model_DeleteQueueResponse Amazon_SQS_Model_DeleteQueueResponse
  101. *
  102. * @throws Amazon_SQS_Exception
  103. */
  104. public function deleteQueue($request);
  105. /**
  106. * Get Queue Attributes
  107. * Gets one or all attributes of a queue. Queues currently have two attributes you can get: ApproximateNumberOfMessages and VisibilityTimeout.
  108. *
  109. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryGetQueueAttributes.html
  110. * @param mixed $request array of parameters for Amazon_SQS_Model_GetQueueAttributesRequest request
  111. * or Amazon_SQS_Model_GetQueueAttributesRequest object itself
  112. * @see Amazon_SQS_Model_GetQueueAttributesRequest
  113. * @return Amazon_SQS_Model_GetQueueAttributesResponse Amazon_SQS_Model_GetQueueAttributesResponse
  114. *
  115. * @throws Amazon_SQS_Exception
  116. */
  117. public function getQueueAttributes($request);
  118. /**
  119. * Remove Permission
  120. * Removes the permission with the specified statement id from the queue.
  121. *
  122. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryRemovePermission.html
  123. * @param mixed $request array of parameters for Amazon_SQS_Model_RemovePermissionRequest request
  124. * or Amazon_SQS_Model_RemovePermissionRequest object itself
  125. * @see Amazon_SQS_Model_RemovePermissionRequest
  126. * @return Amazon_SQS_Model_RemovePermissionResponse Amazon_SQS_Model_RemovePermissionResponse
  127. *
  128. * @throws Amazon_SQS_Exception
  129. */
  130. public function removePermission($request);
  131. /**
  132. * Receive Message
  133. * Retrieves one or more messages from the specified queue. For each message returned, the response includes the message body; MD5 digest of the message body; receipt handle, which is the identifier you must provide when deleting the message; and message ID of each message. Messages returned by this action stay in the queue until you delete them. However, once a message is returned to a ReceiveMessage request, it is not returned on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout. If you do not specify a VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.
  134. *
  135. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QueryReceiveMessage.html
  136. * @param mixed $request array of parameters for Amazon_SQS_Model_ReceiveMessageRequest request
  137. * or Amazon_SQS_Model_ReceiveMessageRequest object itself
  138. * @see Amazon_SQS_Model_ReceiveMessageRequest
  139. * @return Amazon_SQS_Model_ReceiveMessageResponse Amazon_SQS_Model_ReceiveMessageResponse
  140. *
  141. * @throws Amazon_SQS_Exception
  142. */
  143. public function receiveMessage($request);
  144. /**
  145. * Send Message
  146. * The SendMessage action delivers a message to the specified queue.
  147. *
  148. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QuerySendMessage.html
  149. * @param mixed $request array of parameters for Amazon_SQS_Model_SendMessageRequest request
  150. * or Amazon_SQS_Model_SendMessageRequest object itself
  151. * @see Amazon_SQS_Model_SendMessageRequest
  152. * @return Amazon_SQS_Model_SendMessageResponse Amazon_SQS_Model_SendMessageResponse
  153. *
  154. * @throws Amazon_SQS_Exception
  155. */
  156. public function sendMessage($request);
  157. /**
  158. * Set Queue Attributes
  159. * Sets an attribute of a queue. Currently, you can set only the VisibilityTimeout attribute for a queue.
  160. *
  161. * @see http://docs.amazonwebservices.com/AWSSimpleQueueService/2009-02-01/SQSDeveloperGuide/Query_QuerySetQueueAttributes.html
  162. * @param mixed $request array of parameters for Amazon_SQS_Model_SetQueueAttributesRequest request
  163. * or Amazon_SQS_Model_SetQueueAttributesRequest object itself
  164. * @see Amazon_SQS_Model_SetQueueAttributesRequest
  165. * @return Amazon_SQS_Model_SetQueueAttributesResponse Amazon_SQS_Model_SetQueueAttributesResponse
  166. *
  167. * @throws Amazon_SQS_Exception
  168. */
  169. public function setQueueAttributes($request);
  170. }