/usr/share/doc/php-opencloud/api/source-class-OpenCloud.LoadBalancer.Resource.ConnectionThrottle.html is in php-opencloud-doc 1.10.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | <!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="generator" content="ApiGen 2.8.0">
<meta name="robots" content="noindex">
<title>File OpenCloud/LoadBalancer/Resource/ConnectionThrottle.php | PHP OpenCloud API</title>
<script type="text/javascript" src="resources/combined.js?117538352"></script>
<script type="text/javascript" src="elementlist.js?4292216789"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-OpenCloud.html">OpenCloud<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Autoscale.html">Autoscale<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Autoscale.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.CloudMonitoring.html">CloudMonitoring<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.CloudMonitoring.Exception.html">Exception</a>
</li>
<li><a href="namespace-OpenCloud.CloudMonitoring.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Common.html">Common<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Common.Collection.html">Collection</a>
</li>
<li><a href="namespace-OpenCloud.Common.Constants.html">Constants</a>
</li>
<li><a href="namespace-OpenCloud.Common.Exceptions.html">Exceptions</a>
</li>
<li><a href="namespace-OpenCloud.Common.Http.html">Http<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Common.Http.Message.html">Message</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Common.Log.html">Log</a>
</li>
<li><a href="namespace-OpenCloud.Common.Resource.html">Resource</a>
</li>
<li><a href="namespace-OpenCloud.Common.Service.html">Service</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Compute.html">Compute<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Compute.Constants.html">Constants</a>
</li>
<li><a href="namespace-OpenCloud.Compute.Exception.html">Exception</a>
</li>
<li><a href="namespace-OpenCloud.Compute.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Database.html">Database<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Database.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.DNS.html">DNS<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.DNS.Collection.html">Collection</a>
</li>
<li><a href="namespace-OpenCloud.DNS.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Identity.html">Identity<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Identity.Constants.html">Constants</a>
</li>
<li><a href="namespace-OpenCloud.Identity.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Image.html">Image<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Image.Enum.html">Enum</a>
</li>
<li><a href="namespace-OpenCloud.Image.Resource.html">Resource<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Image.Resource.JsonPatch.html">JsonPatch</a>
</li>
<li><a href="namespace-OpenCloud.Image.Resource.Schema.html">Schema</a>
</li>
</ul></li></ul></li>
<li class="active"><a href="namespace-OpenCloud.LoadBalancer.html">LoadBalancer<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.LoadBalancer.Enum.html">Enum</a>
</li>
<li class="active"><a href="namespace-OpenCloud.LoadBalancer.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.ObjectStore.html">ObjectStore<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.ObjectStore.Constants.html">Constants</a>
</li>
<li><a href="namespace-OpenCloud.ObjectStore.Exception.html">Exception</a>
</li>
<li><a href="namespace-OpenCloud.ObjectStore.Resource.html">Resource</a>
</li>
<li><a href="namespace-OpenCloud.ObjectStore.Upload.html">Upload</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Orchestration.html">Orchestration</a>
</li>
<li><a href="namespace-OpenCloud.Queues.html">Queues<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Queues.Exception.html">Exception</a>
</li>
<li><a href="namespace-OpenCloud.Queues.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Volume.html">Volume<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Volume.Resource.html">Resource</a>
</li>
</ul></li></ul></li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-OpenCloud.LoadBalancer.Resource.AbstractResource.html">AbstractResource</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.Access.html">Access</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.Algorithm.html">Algorithm</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.AllowedDomain.html">AllowedDomain</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.ConnectionLogging.html">ConnectionLogging</a></li>
<li class="active"><a href="class-OpenCloud.LoadBalancer.Resource.ConnectionThrottle.html">ConnectionThrottle</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.ContentCaching.html">ContentCaching</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.ErrorPage.html">ErrorPage</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.HealthMonitor.html">HealthMonitor</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.LoadBalancer.html">LoadBalancer</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.Metadata.html">Metadata</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.Node.html">Node</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.NodeEvent.html">NodeEvent</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.NonIdUriResource.html">NonIdUriResource</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.Protocol.html">Protocol</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.ReadOnlyResource.html">ReadOnlyResource</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.SessionPersistence.html">SessionPersistence</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.SSLTermination.html">SSLTermination</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.Stats.html">Stats</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.UsageRecord.html">UsageRecord</a></li>
<li><a href="class-OpenCloud.LoadBalancer.Resource.VirtualIp.html">VirtualIp</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text">
<input type="submit" value="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-OpenCloud.LoadBalancer.Resource.html" title="Summary of OpenCloud\LoadBalancer\Resource"><span>Namespace</span></a>
</li>
<li>
<a href="class-OpenCloud.LoadBalancer.Resource.ConnectionThrottle.html" title="Summary of OpenCloud\LoadBalancer\Resource\ConnectionThrottle"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
<li>
<a href="php-opencloud-api-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
</li>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/**
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Copyright 2012-2014 Rackspace US, Inc.
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> *
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * Licensed under the Apache License, Version 2.0 (the "License");
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * you may not use this file except in compliance with the License.
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * You may obtain a copy of the License at
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> *
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> *
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * distributed under the License is distributed on an "AS IS" BASIS,
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * See the License for the specific language governing permissions and
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * limitations under the License.
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> */</span>
</span><span id="17" class="l"><a class="l" href="#17">17: </a>
</span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-keyword1">namespace</span> OpenCloud\LoadBalancer\Resource;
</span><span id="19" class="l"><a class="l" href="#19">19: </a>
</span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment">/**
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * The connection throttling feature imposes limits on the number of connections
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * per IP address to help mitigate malicious or abusive traffic to your
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * applications. The attributes in the table that follows can be configured
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * based on the traffic patterns for your sites.
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> */</span>
</span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-keyword1">class</span> <a id="ConnectionThrottle" href="#ConnectionThrottle">ConnectionThrottle</a> <span class="php-keyword1">extends</span> NonIdUriResource
</span><span id="27" class="l"><a class="l" href="#27">27: </a>{
</span><span id="28" class="l"><a class="l" href="#28">28: </a> <span class="php-comment">/**
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * Allow at least this number of connections per IP address before applying
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * throttling restrictions. Setting a value of 0 allows unlimited
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * simultaneous connections; otherwise, set a value between 1 and 1000.
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> *
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> * @var int
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> */</span>
</span><span id="35" class="l"><a class="l" href="#35">35: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$minConnections" href="#$minConnections">$minConnections</a></span>;
</span><span id="36" class="l"><a class="l" href="#36">36: </a>
</span><span id="37" class="l"><a class="l" href="#37">37: </a> <span class="php-comment">/**
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> * Maximum number of connections to allow for a single IP address. Setting a
</span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment"> * value of 0 will allow unlimited simultaneous connections; otherwise set a
</span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment"> * value between 1 and 100000.
</span></span><span id="41" class="l"><a class="l" href="#41">41: </a><span class="php-comment"> *
</span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment"> * @var int
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44">44: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$maxConnections" href="#$maxConnections">$maxConnections</a></span>;
</span><span id="45" class="l"><a class="l" href="#45">45: </a>
</span><span id="46" class="l"><a class="l" href="#46">46: </a> <span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47">47: </a><span class="php-comment"> * Maximum number of connections allowed from a single IP address in the
</span></span><span id="48" class="l"><a class="l" href="#48">48: </a><span class="php-comment"> * defined rateInterval. Setting a value of 0 allows an unlimited connection
</span></span><span id="49" class="l"><a class="l" href="#49">49: </a><span class="php-comment"> * rate; otherwise, set a value between 1 and 100000.
</span></span><span id="50" class="l"><a class="l" href="#50">50: </a><span class="php-comment"> *
</span></span><span id="51" class="l"><a class="l" href="#51">51: </a><span class="php-comment"> * @var int
</span></span><span id="52" class="l"><a class="l" href="#52">52: </a><span class="php-comment"> */</span>
</span><span id="53" class="l"><a class="l" href="#53">53: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$maxConnectionRate" href="#$maxConnectionRate">$maxConnectionRate</a></span>;
</span><span id="54" class="l"><a class="l" href="#54">54: </a>
</span><span id="55" class="l"><a class="l" href="#55">55: </a> <span class="php-comment">/**
</span></span><span id="56" class="l"><a class="l" href="#56">56: </a><span class="php-comment"> * Frequency (in seconds) at which the maxConnectionRate is assessed.
</span></span><span id="57" class="l"><a class="l" href="#57">57: </a><span class="php-comment"> * For example, a maxConnectionRate of 30 with a rateInterval of 60 would
</span></span><span id="58" class="l"><a class="l" href="#58">58: </a><span class="php-comment"> * allow a maximum of 30 connections per minute for a single IP address.
</span></span><span id="59" class="l"><a class="l" href="#59">59: </a><span class="php-comment"> * This value must be between 1 and 3600.
</span></span><span id="60" class="l"><a class="l" href="#60">60: </a><span class="php-comment"> *
</span></span><span id="61" class="l"><a class="l" href="#61">61: </a><span class="php-comment"> * @var int
</span></span><span id="62" class="l"><a class="l" href="#62">62: </a><span class="php-comment"> */</span>
</span><span id="63" class="l"><a class="l" href="#63">63: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$rateInterval" href="#$rateInterval">$rateInterval</a></span>;
</span><span id="64" class="l"><a class="l" href="#64">64: </a>
</span><span id="65" class="l"><a class="l" href="#65">65: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$json_name" href="#$json_name">$json_name</a></span> = <span class="php-quote">"connectionThrottle"</span>;
</span><span id="66" class="l"><a class="l" href="#66">66: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$url_resource" href="#$url_resource">$url_resource</a></span> = <span class="php-quote">"connectionthrottle"</span>;
</span><span id="67" class="l"><a class="l" href="#67">67: </a>
</span><span id="68" class="l"><a class="l" href="#68">68: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$createKeys" href="#$createKeys">$createKeys</a></span> = <span class="php-keyword1">array</span>(
</span><span id="69" class="l"><a class="l" href="#69">69: </a> <span class="php-quote">'minConnections'</span>,
</span><span id="70" class="l"><a class="l" href="#70">70: </a> <span class="php-quote">'maxConnections'</span>,
</span><span id="71" class="l"><a class="l" href="#71">71: </a> <span class="php-quote">'maxConnectionRate'</span>,
</span><span id="72" class="l"><a class="l" href="#72">72: </a> <span class="php-quote">'rateInterval'</span>
</span><span id="73" class="l"><a class="l" href="#73">73: </a> );
</span><span id="74" class="l"><a class="l" href="#74">74: </a>
</span><span id="75" class="l"><a class="l" href="#75">75: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_create" href="#_create">create</a>(<span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="76" class="l"><a class="l" href="#76">76: </a> {
</span><span id="77" class="l"><a class="l" href="#77">77: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->update(<span class="php-var">$params</span>);
</span><span id="78" class="l"><a class="l" href="#78">78: </a> }
</span><span id="79" class="l"><a class="l" href="#79">79: </a>}
</span><span id="80" class="l"><a class="l" href="#80">80: </a></span></code></pre>
<div id="footer">
PHP OpenCloud API API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>
|