File "ConsumerStrategies_SocketConsumer.html"
Full Path: /home/tekvhqgl/public_html/wp-content/plugins/wp-smushit/vendor/mixpanel/mixpanel-php/docs/classes/ConsumerStrategies_SocketConsumer.html
File size: 49.49 KB
MIME-type: text/html
Charset: utf-8
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>API Documentation</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">API Documentation</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i> Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">16</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">0</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1590462518"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1590462518" class="accordion-body collapse in">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Base_MixpanelBase.html">Base_MixpanelBase</a></li>
<li class="class"><a href="../classes/ConsumerStrategies_AbstractConsumer.html">ConsumerStrategies_AbstractConsumer</a></li>
<li class="class"><a href="../classes/ConsumerStrategies_CurlConsumer.html">ConsumerStrategies_CurlConsumer</a></li>
<li class="class"><a href="../classes/ConsumerStrategies_FileConsumer.html">ConsumerStrategies_FileConsumer</a></li>
<li class="class"><a href="../classes/ConsumerStrategies_SocketConsumer.html">ConsumerStrategies_SocketConsumer</a></li>
<li class="class"><a href="../classes/Mixpanel.html">Mixpanel</a></li>
<li class="class"><a href="../classes/Producers_MixpanelBaseProducer.html">Producers_MixpanelBaseProducer</a></li>
<li class="class"><a href="../classes/Producers_MixpanelEvents.html">Producers_MixpanelEvents</a></li>
<li class="class"><a href="../classes/Producers_MixpanelPeople.html">Producers_MixpanelPeople</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\</small>ConsumerStrategies_SocketConsumer</h1>
<p><em>Consumes messages and writes them to host/endpoint using a persistent socket</em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/ConsumerStrategies_SocketConsumer.html#method___construct" class="">__construct()</a><br />
<a href="../classes/ConsumerStrategies_AbstractConsumer.html#method_getNumThreads" class="">getNumThreads()</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#method_persist" class="">persist()</a><br />
</section>
<section class="span4">
<em>No public properties found</em>
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<a href="../classes/ConsumerStrategies_AbstractConsumer.html#method__encode" class="">_encode()</a><br />
<a href="../classes/ConsumerStrategies_AbstractConsumer.html#method__handleError" class="">_handleError()</a><br />
<a href="../classes/Base_MixpanelBase.html#method__log" class="">_log()</a><br />
<a href="../classes/Base_MixpanelBase.html#method__debug" class="">_debug()</a><br />
</section>
<section class="span4">
<a href="../classes/Base_MixpanelBase.html#property__options" class="">$_options</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<a href="../classes/ConsumerStrategies_SocketConsumer.html#method__getSocket" class="">_getSocket()</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#method__createSocket" class="">_createSocket()</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#method__destroySocket" class="">_destroySocket()</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#method__write" class="">_write()</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#method_handleResponse" class="">handleResponse()</a><br />
</section>
<section class="span4">
<a href="../classes/Base_MixpanelBase.html#property__defaults" class="">$_defaults</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#property__host" class="">$_host</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#property__endpoint" class="">$_endpoint</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#property__connect_timeout" class="">$_connect_timeout</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#property__protocol" class="">$_protocol</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#property__socket" class="">$_socket</a><br />
<a href="../classes/ConsumerStrategies_SocketConsumer.html#property__async" class="">$_async</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/ConsumerStrategies.SocketConsumer.html"><div class="path-wrapper">ConsumerStrategies/SocketConsumer.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">Default</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper"><a href="../classes/Base_MixpanelBase.html">\Base_MixpanelBase</a></div>
<div class="namespace-wrapper"><a href="../classes/ConsumerStrategies_AbstractConsumer.html">\ConsumerStrategies_AbstractConsumer</a></div>
<div class="namespace-wrapper">\ConsumerStrategies_SocketConsumer</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="properties" name="properties"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Properties</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__options" name="property__options" class="anchor"></a>
<article class="property">
<h3 class="protected ">$_options</h3>
<pre class="signature">$_options : array</pre>
<p><em>An array of options to be used by the Mixpanel library.</em></p>
<h4>Type</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Base_MixpanelBase.html"><div class="path-wrapper">\Base_MixpanelBase</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__defaults" name="property__defaults" class="anchor"></a>
<article class="property">
<h3 class="private ">$_defaults</h3>
<pre class="signature">$_defaults : array</pre>
<p><em>Default options that can be overridden via the $options constructor arg</em></p>
<h4>Type</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Base_MixpanelBase.html"><div class="path-wrapper">\Base_MixpanelBase</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__host" name="property__host" class="anchor"></a>
<article class="property">
<h3 class="private ">$_host</h3>
<pre class="signature">$_host : string</pre>
<p><em></em></p>
<h4>Type</h4>
string
— the host to connect to (e.g. api.mixpanel.com) </article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__endpoint" name="property__endpoint" class="anchor"></a>
<article class="property">
<h3 class="private ">$_endpoint</h3>
<pre class="signature">$_endpoint : string</pre>
<p><em></em></p>
<h4>Type</h4>
string
— the host-relative endpoint to write to (e.g. /engage) </article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__connect_timeout" name="property__connect_timeout" class="anchor"></a>
<article class="property">
<h3 class="private ">$_connect_timeout</h3>
<pre class="signature">$_connect_timeout : integer</pre>
<p><em></em></p>
<h4>Type</h4>
integer
— connect_timeout the socket connection timeout in seconds </article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__protocol" name="property__protocol" class="anchor"></a>
<article class="property">
<h3 class="private ">$_protocol</h3>
<pre class="signature">$_protocol : string</pre>
<p><em></em></p>
<h4>Type</h4>
string
— the protocol to use for the socket connection </article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__socket" name="property__socket" class="anchor"></a>
<article class="property">
<h3 class="private ">$_socket</h3>
<pre class="signature">$_socket : resource</pre>
<p><em></em></p>
<h4>Type</h4>
resource
— holds the socket resource </article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__async" name="property__async" class="anchor"></a>
<article class="property">
<h3 class="private ">$_async</h3>
<pre class="signature">$_async : boolean</pre>
<p><em></em></p>
<h4>Type</h4>
boolean
— whether or not to wait for a response </article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method___construct" name="method___construct" class="anchor"></a>
<article class="method">
<h3 class="public ">__construct()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">__construct(array <span class="argument">$options = array()</span>) </pre>
<p><em>Creates a new SocketConsumer and assigns properties from the $options array</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$options </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getNumThreads" name="method_getNumThreads" class="anchor"></a>
<article class="method">
<h3 class="public ">getNumThreads()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getNumThreads() : integer</pre>
<p><em>Number of requests/batches that will be processed in parallel.</em></p>
<h4>Returns</h4>
integer
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/ConsumerStrategies_AbstractConsumer.html"><div class="path-wrapper">\ConsumerStrategies_AbstractConsumer</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_persist" name="method_persist" class="anchor"></a>
<article class="method">
<h3 class="public ">persist()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">persist(array <span class="argument">$batch</span>) : boolean</pre>
<p><em>Write using a persistent socket connection.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$batch </td>
<td><p>an array of messages to consume</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__encode" name="method__encode" class="anchor"></a>
<article class="method">
<h3 class="protected ">_encode()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_encode(array <span class="argument">$params</span>) : string</pre>
<p><em>Encode an array to be persisted</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$params </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/ConsumerStrategies_AbstractConsumer.html"><div class="path-wrapper">\ConsumerStrategies_AbstractConsumer</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__handleError" name="method__handleError" class="anchor"></a>
<article class="method">
<h3 class="protected ">_handleError()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_handleError( <span class="argument">$code</span>, <span class="argument">$msg</span>) </pre>
<p><em>Handles errors that occur in a consumer</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$code </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$msg </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/ConsumerStrategies_AbstractConsumer.html"><div class="path-wrapper">\ConsumerStrategies_AbstractConsumer</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__log" name="method__log" class="anchor"></a>
<article class="method">
<h3 class="protected ">_log()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_log( <span class="argument">$msg</span>) </pre>
<p><em>Log a message to PHP's error log</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$msg </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Base_MixpanelBase.html"><div class="path-wrapper">\Base_MixpanelBase</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__debug" name="method__debug" class="anchor"></a>
<article class="method">
<h3 class="protected ">_debug()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_debug() : boolean</pre>
<p><em>Returns true if in debug mode, false if in production mode</em></p>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Base_MixpanelBase.html"><div class="path-wrapper">\Base_MixpanelBase</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__getSocket" name="method__getSocket" class="anchor"></a>
<article class="method">
<h3 class="private ">_getSocket()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_getSocket() : boolean|resource</pre>
<p><em>Return cached socket if open or create a new persistent socket</em></p>
<h4>Returns</h4>
boolean|resource
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__createSocket" name="method__createSocket" class="anchor"></a>
<article class="method">
<h3 class="private ">_createSocket()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_createSocket(boolean <span class="argument">$retry = true</span>) : boolean|resource</pre>
<p><em>Attempt to open a new socket connection, cache it, and return the resource</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$retry </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean|resource
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__destroySocket" name="method__destroySocket" class="anchor"></a>
<article class="method">
<h3 class="private ">_destroySocket()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_destroySocket() </pre>
<p><em>Attempt to close and dereference a socket resource</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__write" name="method__write" class="anchor"></a>
<article class="method">
<h3 class="private ">_write()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_write( <span class="argument">$socket</span>, <span class="argument">$data</span>, boolean <span class="argument">$retry = true</span>) : boolean</pre>
<p><em>Write $data through the given $socket</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$socket </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$data </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$retry </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_handleResponse" name="method_handleResponse" class="anchor"></a>
<article class="method">
<h3 class="private ">handleResponse()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">handleResponse( <span class="argument">$response</span>) : array</pre>
<p><em>Parse the response from a socket write (only used for debugging)</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$response </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">SocketConsumer.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/ConsumerStrategies/SocketConsumer.php.txt" class="language-php line-numbers"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on July 8th, 2019 at 22:37.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>