The CurlRequest class is a simple wrapper to CURL functions. Not only does
this permit stubbing of the interface as described under the HttpRequest
interface, it could potentially allow us to replace the interface methods
with other function calls in the future. It contains common code for error handling as well as service functions that
are useful. Because it is an abstract class, it cannot be called directly,
and it has no publicly-visible properties.
Executes the current request This method actually performs the request using the values set
previously. It throws a OpenCloud\HttpError exception on
any CURL error.
Return value
Type
Description
\OpenCloud\Common\Request\OpenCloud\HttpResponse
Tags
Name
Description
throws
ReturnHeaders(
)
:
n/a
Description
Returns the headers as an array
Return value
Type
Description
n/a
n/a
SetConnectTimeout(
integer
$value,
)
:
n/a
Description
Explicit method for setting the connect timeout The connect timeout is the time it takes for the initial connection
request to be established. It is different than the HTTP timeout, which
is the time for the entire request to be serviced.
Arguments
Name
Type
Description
Default
$value
integer
The connection timeout in seconds.
Use 0 to wait indefinitely (NOT recommended)
Return value
Type
Description
n/a
n/a
SetHeader(
string
$name,
mixed
$value,
)
:
n/a
Description
Sets a single header For example, to set the content type to JSON:
`$request->SetHeader('Content-Type','application/json');`
Arguments
Name
Type
Description
Default
$name
string
The name of the header
$value
mixed
The value of the header
Return value
Type
Description
n/a
n/a
SetHttpTimeout(
integer
$value,
)
:
n/a
Description
Explicit method for setting the HTTP timeout The HTTP timeout is the time it takes for the HTTP request to be
serviced. This value is usually larger than the connect timeout
value.
Arguments
Name
Type
Description
Default
$value
integer
the number of seconds to wait before timing out
the HTTP request.
This is a callback method used to handle the returned HTTP headers
Arguments
Name
Type
Description
Default
$ch
mixed
a CURL handle
$header
string
the header string in its entirety
Return value
Type
Description
n/a
n/a
close(
)
:
n/a
Description
Closes the HTTP request
Return value
Type
Description
n/a
n/a
errno(
)
:
n/a
Description
returns the most recent CURL error number
Return value
Type
Description
n/a
n/a
error(
)
:
n/a
Description
returns the most recent CURL error string
Return value
Type
Description
n/a
n/a
info(
)
:
n/a
Description
returns an array of information about the request
Return value
Type
Description
n/a
n/a
setheaders(
$array,
)
:
n/a
Description
Simplified method for setting lots of headers at once This method takes an associative array of header/value pairs and calls
the setheader() method on each of them.
Metadata The Metadata class represents either Server or Image metadata
Nova Nova is an abstraction layer for the OpenStack compute service.
ObjectStore Intermediate (abstract) class to implement shared
features of all object-storage classes
PersistentObject represents an object that has the ability to be
retrieved, created, updated, and deleted.
Service This class defines a "service"—a relationship between a specific OpenStack
and a provided service, represented by a URL in the service catalog.
ServiceCatalogItem Holds information on a single service from the Service Catalog
Curl The CurlRequest class is a simple wrapper to CURL functions. Not only does
this permit stubbing of the interface as described under the HttpRequest
interface, it could potentially allow us to replace the interface methods
with other function calls in the future.
HttpRequestInterface The HttpRequest interface defines methods for wrapping CURL; this allows
those methods to be stubbed out for unit testing, thus allowing us to
test without actually making live calls.
Response
Blank The HttpResponse returns an object with status information, separated
headers, and any response body necessary.
Http The HttpResponse returns an object with status information, separated
headers, and any response body necessary.
Compute
Flavor The Flavor class represents a flavor defined by the Compute service
Image The Image class represents a stored machine image returned by the
Compute service.
Network The Network class represents a single virtual network
Server The Server class represents a single server node.
Record The Record class represents a single domain record
Service This class defines a "service"—a relationship between a specific OpenStack
and a provided service, represented by a URL in the service catalog.
Subdomain The Subdomain is basically another domain, albeit one that is a child of
a parent domain. In terms of the code involved, the JSON is slightly
different than a top-level domain, and the parent is a domain instead of
the DNS service itself.
Database
Database This class represents a Database in the Rackspace "Red Dwarf"
database-as-a-service product.
Instance Instance represents an instance of DbService, similar to a Server in a
Compute service
Service The Rackspace Database As A Service (aka "Red Dwarf")
User This class represents a User in the Rackspace "Red Dwarf"
database-as-a-service product.
LoadBalancer
Algorithm sub-resource to manage algorithms (read-only)
AllowedDomain sub-resource to manage allowed domains
BillableLoadBalancer used to get a list of billable load balancers for a specific date range
LoadBalancer The LoadBalancer class represents a single load balancer
Protocol sub-resource to manage protocols (read-only)
Node information on a single node in the load balancer
NodeEvent a single node event, usually called as part of a Collection
Readonly This defines a read-only SubResource - one that cannot be created, updated,
or deleted. Many subresources are like this, and this simplifies their
class definitions.
Stats Stats returns statistics about the load balancer
SubResource SubResource is an abstract class that handles subresources of a
LoadBalancer object; for example, the
`/loadbalancers/{id}/errorpage`. Since most of the subresources are
handled in a similar manner, this consolidates the functions.
Curl The CurlRequest class is a simple wrapper to CURL functions. Not only does
this permit stubbing of the interface as described under the HttpRequest
interface, it could potentially allow us to replace the interface methods
with other function calls in the future.
DataObject A DataObject is an object in the ObjectStore
Database This class represents a Database in the Rackspace "Red Dwarf"
database-as-a-service product.
HttpRequestInterface The HttpRequest interface defines methods for wrapping CURL; this allows
those methods to be stubbed out for unit testing, thus allowing us to
test without actually making live calls.
Rackspace Rackspace extends the OpenStack class with support for Rackspace's
API key and tenant requirements.
Readonly This defines a read-only SubResource - one that cannot be created, updated,
or deleted. Many subresources are like this, and this simplifies their
class definitions.
Service This class defines a "service"—a relationship between a specific OpenStack
and a provided service, represented by a URL in the service catalog.
Service The Compute class represents the OpenStack Nova service.
Service The Rackspace Database As A Service (aka "Red Dwarf")
Service This class defines a "service"—a relationship between a specific OpenStack
and a provided service, represented by a URL in the service catalog.
Stack The Stack class requires a CloudFormation template and may contain additional
parameters for that template.
Stats Stats returns statistics about the load balancer
SubResource SubResource is an abstract class that handles subresources of a
LoadBalancer object; for example, the
`/loadbalancers/{id}/errorpage`. Since most of the subresources are
handled in a similar manner, this consolidates the functions.
Subdomain The Subdomain is basically another domain, albeit one that is a child of
a parent domain. In terms of the code involved, the JSON is slightly
different than a top-level domain, and the parent is a domain instead of
the DNS service itself.
