Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 4b137326f38b5adf1f9ffd3dbbb48a7b > files > 95

deltacloud-core-doc-0.4.0-4.fc15.noarch.rpm

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Module: CloudClient</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Module</strong></td>
          <td class="class-name-in-header">CloudClient</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../files/lib/deltacloud/drivers/opennebula/cloud_client_rb.html">
                lib/deltacloud/drivers/opennebula/cloud_client.rb
                </a>
        <br />
            </td>
        </tr>

        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
The <a href="CloudClient.html">CloudClient</a> module contains general
functionality to implement a Cloud Client
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000061">get_one_auth</a>&nbsp;&nbsp;
      <a href="#M000062">http_start</a>&nbsp;&nbsp;
      <a href="#M000063">is_error?</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">

    <div id="class-list">
      <h3 class="section-bar">Classes and Modules</h3>

      Class <a href="CloudClient/Error.html" class="link">CloudClient::Error</a><br />

    </div>

    <div id="constants-list">
      <h3 class="section-bar">Constants</h3>

      <div class="name-list">
        <table summary="Constants">
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">DEFAULT_AUTH_FILE</td>
          <td>=</td>
          <td class="context-item-value">ENV[&quot;HOME&quot;]+&quot;/.one/one_auth&quot;</td>
          <td width="3em">&nbsp;</td>
          <td class="context-item-desc">
#########################################################################
Default location for the authentication file
#########################################################################

</td>
        </tr>
        </table>
      </div>
    </div>



      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000061" class="method-detail">
        <a name="M000061"></a>

        <div class="method-heading">
          <a href="CloudClient.src/M000061.html" target="Code" class="method-signature"
            onclick="popupCode('CloudClient.src/M000061.html');return false;">
          <span class="method-name">get_one_auth</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
#########################################################################
Gets authorization credentials from ONE_AUTH or default auth file.
</p>
<p>
Raises an error if authorization is not found
#########################################################################
</p>
        </div>
      </div>

      <div id="method-M000062" class="method-detail">
        <a name="M000062"></a>

        <div class="method-heading">
          <a href="CloudClient.src/M000062.html" target="Code" class="method-signature"
            onclick="popupCode('CloudClient.src/M000062.html');return false;">
          <span class="method-name">http_start</span><span class="method-args">(url, &amp;block)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
#########################################################################
Starts an http connection and calls the block provided. SSL flag is set if
needed.
#########################################################################
</p>
        </div>
      </div>

      <div id="method-M000063" class="method-detail">
        <a name="M000063"></a>

        <div class="method-heading">
          <a href="CloudClient.src/M000063.html" target="Code" class="method-signature"
            onclick="popupCode('CloudClient.src/M000063.html');return false;">
          <span class="method-name">is_error?</span><span class="method-args">(value)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
#########################################################################
Returns true if the object returned by a method of the OpenNebula library
is an <a href="CloudClient/Error.html">Error</a>
#########################################################################
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>