Microsoft_WindowsAzure
[ class tree: Microsoft_WindowsAzure ] [ index: Microsoft_WindowsAzure ] [ all elements ]

Source for file RetryPolicy.php

Documentation is available at RetryPolicy.php

  1. <?php
  2. /**
  3.  * Copyright (c) 2009, RealDolmen
  4.  * All rights reserved.
  5.  *
  6.  * Redistribution and use in source and binary forms, with or without
  7.  * modification, are permitted provided that the following conditions are met:
  8.  *     * Redistributions of source code must retain the above copyright
  9.  *       notice, this list of conditions and the following disclaimer.
  10.  *     * Redistributions in binary form must reproduce the above copyright
  11.  *       notice, this list of conditions and the following disclaimer in the
  12.  *       documentation and/or other materials provided with the distribution.
  13.  *     * Neither the name of RealDolmen nor the
  14.  *       names of its contributors may be used to endorse or promote products
  15.  *       derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY RealDolmen ''AS IS'' AND ANY
  18.  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19.  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20.  * DISCLAIMED. IN NO EVENT SHALL RealDolmen BE LIABLE FOR ANY
  21.  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22.  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  26.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  *
  28.  * @category   Microsoft
  29.  * @package    Microsoft_WindowsAzure
  30.  * @subpackage RetryPolicy
  31.  * @version    $Id: RetryPolicy.php 28585 2009-09-07 12:12:56Z unknown $
  32.  * @copyright  Copyright (c) 2009, RealDolmen (http://www.realdolmen.com)
  33.  * @license    http://phpazure.codeplex.com/license
  34.  */
  35.  
  36. /**
  37.  * @see Microsoft_WindowsAzure_Exception
  38.  */
  39. require_once 'Microsoft/WindowsAzure/Exception.php';
  40.  
  41. /**
  42.  * @see Microsoft_WindowsAzure_RetryPolicy_NoRetry
  43.  */
  44. require_once 'Microsoft/WindowsAzure/RetryPolicy/NoRetry.php';
  45.  
  46. /**
  47.  * @see Microsoft_WindowsAzure_RetryPolicy_RetryN
  48.  */
  49. require_once 'Microsoft/WindowsAzure/RetryPolicy/RetryN.php';
  50.  
  51. /**
  52.  * @category   Microsoft
  53.  * @package    Microsoft_WindowsAzure
  54.  * @subpackage RetryPolicy
  55.  * @copyright  Copyright (c) 2009, RealDolmen (http://www.realdolmen.com)
  56.  * @license    http://phpazure.codeplex.com/license
  57.  */
  58. {
  59.     /**
  60.      * Execute function under retry policy
  61.      * 
  62.      * @param string|array$function       Function to execute
  63.      * @param array        $parameters     Parameters for function call
  64.      * @return mixed 
  65.      */
  66.     public abstract function execute($function$parameters array());
  67.     
  68.     /**
  69.      * Create a Microsoft_WindowsAzure_RetryPolicy_NoRetry instance
  70.      * 
  71.      * @return Microsoft_WindowsAzure_RetryPolicy_NoRetry 
  72.      */
  73.     public static function noRetry()
  74.     {
  75.         return new Microsoft_WindowsAzure_RetryPolicy_NoRetry();
  76.     }
  77.     
  78.     /**
  79.      * Create a Microsoft_WindowsAzure_RetryPolicy_RetryN instance
  80.      * 
  81.      * @param int $count                    Number of retries
  82.      * @param int $intervalBetweenRetries   Interval between retries (in milliseconds)
  83.      * @return Microsoft_WindowsAzure_RetryPolicy_RetryN 
  84.      */
  85.     public static function retryN($count 1$intervalBetweenRetries 0)
  86.     {
  87.         return new Microsoft_WindowsAzure_RetryPolicy_RetryN($count$intervalBetweenRetries);
  88.     }
  89. }

Documentation generated on Thu, 26 Nov 2009 08:05:16 +0100 by phpDocumentor 1.4.3