Current File : /home/graphicd/www/vebto/vendor/rackspace/php-opencloud/doc/_build/doctrees/debugging.doctree
�cdocutils.nodes
document
q)�q}q(U nametypesq}q(X debuggingqNX add to your clientqNX an example with swiftqNX strategy 2: wire loggingq NX install the pluginq
NX) strategy 1: meaningful exception handlingq NuUsubstitution_defsq }q
Uparse_messagesq]qUcurrent_sourceqNU
decorationqNUautofootnote_startqKUnameidsq}q(hU debuggingqhUadd-to-your-clientqhUan-example-with-swiftqh Ustrategy-2-wire-loggingqh
Uinstall-the-pluginqh U(strategy-1-meaningful-exception-handlingquUchildrenq]q cdocutils.nodes
section
q )�q }q (U rawsourceq U Uparentq!hUsourceq"X2 /Users/jamie/projects/php/v1-sdk/doc/debugging.rstq#Utagnameq$Usectionq%U
attributesq&}q'(Udupnamesq(]Uclassesq)]Ubackrefsq*]Uidsq+]q,haUnamesq-]q.hauUlineq/KUdocumentq0hh]q1(cdocutils.nodes
title
q2)�q3}q4(h X Debuggingq5h!h h"h#h$Utitleq6h&}q7(h(]h)]h*]h+]h-]uh/Kh0hh]q8cdocutils.nodes
Text
q9X Debuggingq:��q;}q<(h h5h!h3ubaubcdocutils.nodes
paragraph
q=)�q>}q?(h Xf There are two important debugging strategies to use when encountering
problems with HTTP transactions.q@h!h h"h#h$U paragraphqAh&}qB(h(]h)]h*]h+]h-]uh/Kh0hh]qCh9Xf There are two important debugging strategies to use when encountering
problems with HTTP transactions.qD��qE}qF(h h@h!h>ubaubh )�qG}qH(h U h!h h"h#h$h%h&}qI(h(]h)]h*]h+]qJhah-]qKh auh/Kh0hh]qL(h2)�qM}qN(h X) Strategy 1: Meaningful exception handlingqOh!hGh"h#h$h6h&}qP(h(]h)]h*]h+]h-]uh/Kh0hh]qQh9X) Strategy 1: Meaningful exception handlingqR��qS}qT(h hOh!hMubaubh=)�qU}qV(h X� If the API returns a ``4xx`` or ``5xx`` status code, it indicates that
there was an error with the sent request, meaning that the transaction
cannot be adequately completed.h!hGh"h#h$hAh&}qW(h(]h)]h*]h+]h-]uh/K
h0hh]qX(h9X If the API returns a qY��qZ}q[(h X If the API returns a h!hUubcdocutils.nodes
literal
q\)�q]}q^(h X ``4xx``h&}q_(h(]h)]h*]h+]h-]uh!hUh]q`h9X 4xxqa��qb}qc(h U h!h]ubah$Uliteralqdubh9X or qe��qf}qg(h X or h!hUubh\)�qh}qi(h X ``5xx``h&}qj(h(]h)]h*]h+]h-]uh!hUh]qkh9X 5xxql��qm}qn(h U h!hhubah$hdubh9X� status code, it indicates that
there was an error with the sent request, meaning that the transaction
cannot be adequately completed.qo��qp}qq(h X� status code, it indicates that
there was an error with the sent request, meaning that the transaction
cannot be adequately completed.h!hUubeubh=)�qr}qs(h X� The Guzzle HTTP component, which forms the basis of our SDK's transport
layer, utilizes `numerous exception
classes <https://github.com/guzzle/guzzle/tree/master/src/Guzzle/Http/Exception>`__
to handle this error logic.h!hGh"h#h$hAh&}qt(h(]h)]h*]h+]h-]uh/Kh0hh]qu(h9XX The Guzzle HTTP component, which forms the basis of our SDK's transport
layer, utilizes qv��qw}qx(h XX The Guzzle HTTP component, which forms the basis of our SDK's transport
layer, utilizes h!hrubcdocutils.nodes
reference
qy)�qz}q{(h Xg `numerous exception
classes <https://github.com/guzzle/guzzle/tree/master/src/Guzzle/Http/Exception>`__h&}q|(UnameX numerous exception classesUrefuriq}XF https://github.com/guzzle/guzzle/tree/master/src/Guzzle/Http/Exceptionh+]h*]h(]h)]h-]uh!hrh]q~h9X numerous exception
classesq��q�}q�(h U h!hzubah$U referenceq�ubh9X
to handle this error logic.q���q�}q�(h X
to handle this error logic.h!hrubeubh=)�q�}q�(h X* The two most common exception classes are:q�h!hGh"h#h$hAh&}q�(h(]h)]h*]h+]h-]uh/Kh0hh]q�h9X* The two most common exception classes are:q���q�}q�(h h�h!h�ubaubcdocutils.nodes
bullet_list
q�)�q�}q�(h U h!hGh"h#h$U bullet_listq�h&}q�(Ubulletq�X -h+]h*]h(]h)]h-]uh/Kh0hh]q�(cdocutils.nodes
list_item
q�)�q�}q�(h Xg ``Guzzle\Http\Exception\ClientErrorResponseException``, which is
thrown when a ``4xx`` response occurs
h!h�h"h#h$U list_itemq�h&}q�(h(]h)]h*]h+]h-]uh/Nh0hh]q�h=)�q�}q�(h Xf ``Guzzle\Http\Exception\ClientErrorResponseException``, which is
thrown when a ``4xx`` response occursh!h�h"h#h$hAh&}q�(h(]h)]h*]h+]h-]uh/Kh]q�(h\)�q�}q�(h X6 ``Guzzle\Http\Exception\ClientErrorResponseException``h&}q�(h(]h)]h*]h+]h-]uh!h�h]q�h9X2 Guzzle\Http\Exception\ClientErrorResponseExceptionq���q�}q�(h U h!h�ubah$hdubh9X , which is
thrown when a q���q�}q�(h X , which is
thrown when a h!h�ubh\)�q�}q�(h X ``4xx``h&}q�(h(]h)]h*]h+]h-]uh!h�h]q�h9X 4xxq���q�}q�(h U h!h�ubah$hdubh9X response occursq���q�}q�(h X response occursh!h�ubeubaubh�)�q�}q�(h Xg ``Guzzle\Http\Exception\ServerErrorResponseException``, which is
thrown when a ``5xx`` response occurs
h!h�h"h#h$h�h&}q�(h(]h)]h*]h+]h-]uh/Nh0hh]q�h=)�q�}q�(h Xf ``Guzzle\Http\Exception\ServerErrorResponseException``, which is
thrown when a ``5xx`` response occursh!h�h"h#h$hAh&}q�(h(]h)]h*]h+]h-]uh/Kh]q�(h\)�q�}q�(h X6 ``Guzzle\Http\Exception\ServerErrorResponseException``h&}q�(h(]h)]h*]h+]h-]uh!h�h]q�h9X2 Guzzle\Http\Exception\ServerErrorResponseExceptionq���q�}q�(h U h!h�ubah$hdubh9X , which is
thrown when a q �q�}q�(h X , which is
thrown when a h!h�ubh\)�q�}q�(h X ``5xx``h&}q�(h(]h)]h*]h+]h-]uh!h�h]q�h9X 5xxqɅ�q�}q�(h U h!h�ubah$hdubh9X response occursq̅�q�}q�(h X response occursh!h�ubeubaubeubh=)�q�}q�(h XE Both of these classes extend the base ``BadResponseException`` class.q�h!hGh"h#h$hAh&}q�(h(]h)]h*]h+]h-]uh/Kh0hh]q�(h9X& Both of these classes extend the base qԅ�q�}q�(h X& Both of these classes extend the base h!h�ubh\)�q�}q�(h X ``BadResponseException``h&}q�(h(]h)]h*]h+]h-]uh!h�h]q�h9X BadResponseExceptionqۅ�q�}q�(h U h!h�ubah$hdubh9X class.qޅ�q�}q�(h X class.h!h�ubeubh=)�q�}q�(h XO This provides you with the granularity you need to debug and handle
exceptions.q�h!hGh"h#h$hAh&}q�(h(]h)]h*]h+]h-]uh/K h0hh]q�h9XO This provides you with the granularity you need to debug and handle
exceptions.q慁q�}q�(h h�h!h�ubaubh )�q�}q�(h U h!hGh"h#h$h%h&}q�(h(]h)]h*]h+]q�hah-]q�hauh/K!h0hh]q�(h2)�q�}q�(h X An example with Swiftq�h!h�h"h#h$h6h&}q�(h(]h)]h*]h+]h-]uh/K!h0hh]q�h9X An example with Swiftq�q�}q�(h h�h!h�ubaubh=)�q�}q�(h X� If you're trying to retrieve a Swift resource, such as a Data Object,
and you're not completely certain that it exists, it makes sense to wrap
your call in a try/catch block:q�h!h�h"h#h$hAh&}q�(h(]h)]h*]h+]h-]uh/K#h0hh]q�h9X� If you're trying to retrieve a Swift resource, such as a Data Object,
and you're not completely certain that it exists, it makes sense to wrap
your call in a try/catch block:q���q�}q�(h h�h!h�ubaubcdocutils.nodes
literal_block
q�)�r }r (h XU use Guzzle\Http\Exception\ClientErrorResponseException;
try {
return $service->getObject('foo.jpg');
} catch (ClientErrorResponseException $e) {
if ($e->getResponse()->getStatusCode() == 404) {
// Okay, the resource does not exist
return false;
}
} catch (\Exception $e) {
// Some other exception was thrown...
}h!h�h"h#h$U
literal_blockr h&}r (Ulinenosr �Ulanguager X phpU xml:spacer Upreserver h+]h*]h(]h)]h-]uh/K'h0hh]r h9XU use Guzzle\Http\Exception\ClientErrorResponseException;
try {
return $service->getObject('foo.jpg');
} catch (ClientErrorResponseException $e) {
if ($e->getResponse()->getStatusCode() == 404) {
// Okay, the resource does not exist
return false;
}
} catch (\Exception $e) {
// Some other exception was thrown...
}r ��r
}r (h U h!j ubaubh=)�r }r
(h X� Both ``ClientErrorResponseException`` and
``ServerErrorResponseException`` have two methods that allow you to
access the HTTP transaction:h!h�h"h#h$hAh&}r (h(]h)]h*]h+]h-]uh/K7h0hh]r (h9X Both r ��r }r (h X Both h!j ubh\)�r }r (h X ``ClientErrorResponseException``h&}r (h(]h)]h*]h+]h-]uh!j h]r h9X ClientErrorResponseExceptionr ��r }r (h U h!j ubah$hdubh9X and
r ��r }r (h X and
h!j ubh\)�r }r (h X ``ServerErrorResponseException``h&}r (h(]h)]h*]h+]h-]uh!j h]r h9X ServerErrorResponseExceptionr! ��r" }r# (h U h!j ubah$hdubh9X@ have two methods that allow you to
access the HTTP transaction:r$ ��r% }r& (h X@ have two methods that allow you to
access the HTTP transaction:h!j ubeubh�)�r' }r( (h X� // Find out the faulty request
$request = $e->getRequest();
// Display everything by casting as string
echo (string) $request;
// Find out the HTTP response
$response = $e->getResponse();
// Output that too
echo (string) $response;h!h�h"h#h$j h&}r) (j �j X phpj j h+]h*]h(]h)]h-]uh/K;h0hh]r* h9X� // Find out the faulty request
$request = $e->getRequest();
// Display everything by casting as string
echo (string) $request;
// Find out the HTTP response
$response = $e->getResponse();
// Output that too
echo (string) $response;r+ ��r, }r- (h U h!j' ubaubeubeubh )�r. }r/ (h U h!h h"h#h$h%h&}r0 (h(]h)]h*]h+]r1 hah-]r2 h auh/KKh0hh]r3 (h2)�r4 }r5 (h X Strategy 2: Wire loggingr6 h!j. h"h#h$h6h&}r7 (h(]h)]h*]h+]h-]uh/KKh0hh]r8 h9X Strategy 2: Wire loggingr9 ��r: }r; (h j6 h!j4 ubaubh=)�r< }r= (h X� Guzzle provides a `Log
plugin <http://docs.guzzlephp.org/en/latest/plugins/log-plugin.html>`__
that allows you to log everything over the wire, which is useful if you
don't know what's going on.h!j. h"h#h$hAh&}r> (h(]h)]h*]h+]h-]uh/KMh0hh]r? (h9X Guzzle provides a r@ ��rA }rB (h X Guzzle provides a h!j< ubhy)�rC }rD (h XL `Log
plugin <http://docs.guzzlephp.org/en/latest/plugins/log-plugin.html>`__h&}rE (UnameX
Log pluginh}X; http://docs.guzzlephp.org/en/latest/plugins/log-plugin.htmlh+]h*]h(]h)]h-]uh!j< h]rF h9X
Log
pluginrG ��rH }rI (h U h!jC ubah$h�ubh9Xd
that allows you to log everything over the wire, which is useful if you
don't know what's going on.rJ ��rK }rL (h Xd
that allows you to log everything over the wire, which is useful if you
don't know what's going on.h!j< ubeubh=)�rM }rN (h X Here's how you enable it:rO h!j. h"h#h$hAh&}rP (h(]h)]h*]h+]h-]uh/KRh0hh]rQ h9X Here's how you enable it:rR ��rS }rT (h jO h!jM ubaubh )�rU }rV (h U h!j. h"h#h$h%h&}rW (h(]h)]h*]h+]rX hah-]rY h
auh/KUh0hh]rZ (h2)�r[ }r\ (h X Install the pluginr] h!jU h"h#h$h6h&}r^ (h(]h)]h*]h+]h-]uh/KUh0hh]r_ h9X Install the pluginr` ��ra }rb (h j] h!j[ ubaubh�)�rc }rd (h X composer require guzzle/guzzleh!jU h"h#h$j h&}re (j �j X bashj j h+]h*]h(]h)]h-]uh/KWh0hh]rf h9X composer require guzzle/guzzlerg ��rh }ri (h U h!jc ubaubeubh )�rj }rk (h U h!j. h"h#h$h%h&}rl (h(]h)]h*]h+]rm hah-]rn hauh/K]h0hh]ro (h2)�rp }rq (h X Add to your clientrr h!jj h"h#h$h6h&}rs (h(]h)]h*]h+]h-]uh/K]h0hh]rt h9X Add to your clientru ��rv }rw (h jr h!jp ubaubh�)�rx }ry (h XV use Guzzle\Plugin\Log\LogPlugin;
$client->addSubscriber(LogPlugin::getDebugPlugin());h!jj h"h#h$j h&}rz (j �j X phpj j h+]h*]h(]h)]h-]uh/K_h0hh]r{ h9XV use Guzzle\Plugin\Log\LogPlugin;
$client->addSubscriber(LogPlugin::getDebugPlugin());r| ��r} }r~ (h U h!jx ubaubh=)�r }r� (h Xu The above will add a generic logging subscriber to your client, which
will output every HTTP transaction to `STDOUT`.h!jj h"h#h$hAh&}r� (h(]h)]h*]h+]h-]uh/Kfh0hh]r� (h9Xl The above will add a generic logging subscriber to your client, which
will output every HTTP transaction to r� ��r� }r� (h Xl The above will add a generic logging subscriber to your client, which
will output every HTTP transaction to h!j ubcdocutils.nodes
title_reference
r� )�r� }r� (h X `STDOUT`h&}r� (h(]h)]h*]h+]h-]uh!j h]r� h9X STDOUTr� ��r� }r� (h U h!j� ubah$Utitle_referencer� ubh9X .��r� }r� (h X .h!j ubeubeubeubeubah U U transformerr� NU
footnote_refsr� }r� Urefnamesr� }r� Usymbol_footnotesr� ]r� Uautofootnote_refsr� ]r� Usymbol_footnote_refsr� ]r� U citationsr� ]r� h0hU current_liner� NUtransform_messagesr� ]r� Ureporterr� NUid_startr� KU
autofootnotesr� ]r� U
citation_refsr� }r� Uindirect_targetsr� ]r� Usettingsr� (cdocutils.frontend
Values
r� or� }r� (Ufootnote_backlinksr� KUrecord_dependenciesr� NU rfc_base_urlr� Uhttp://tools.ietf.org/html/r� U tracebackr� �Upep_referencesr� NUstrip_commentsr� NU
toc_backlinksr� Uentryr� U
language_coder� Uenr� U datestampr� NU report_levelr� KU _destinationr� NU
halt_levelr� KU
strip_classesr� Nh6NU error_encoding_error_handlerr� Ubackslashreplacer� Udebugr� NUembed_stylesheetr� �U output_encoding_error_handlerr� Ustrictr� U
sectnum_xformr� KUdump_transformsr� NU
docinfo_xformr� KUwarning_streamr� NUpep_file_url_templater� Upep-%04dr� Uexit_status_levelr� KUconfigr� NUstrict_visitorr� NUcloak_email_addressesr� �U trim_footnote_reference_spacer� �Uenvr� NUdump_pseudo_xmlr� NUexpose_internalsr� NUsectsubtitle_xformr� �U source_linkr� NUrfc_referencesr� NUoutput_encodingr� Uutf-8r� U
source_urlr� NUinput_encodingr� U utf-8-sigr� U_disable_configr� NU id_prefixr� U U tab_widthr� KUerror_encodingr� UUTF-8r� U_sourcer� h#Ugettext_compactr� �U generatorr� NUdump_internalsr� NU smart_quotesr� �U pep_base_urlr� U http://www.python.org/dev/peps/r� Usyntax_highlightr� Ulongr� U input_encoding_error_handlerr� j� Uauto_id_prefixr� Uidr� Udoctitle_xformr� �Ustrip_elements_with_classesr� NU
_config_filesr� ]Ufile_insertion_enabledr� �U raw_enabledr� KU
dump_settingsr� NubUsymbol_footnote_startr� K Uidsr� }r� (hh hhGhjj hj. hjU hh�uUsubstitution_namesr� }r� h$h0h&}r� (h(]h+]h*]Usourceh#h)]h-]uU footnotesr� ]r� Urefidsr� }r� ub.
Mini Shell