API Documentation

Gdata/HttpAdapterStreamingSocket.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
Gdata  
version
$Id: HttpAdapterStreamingSocket.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Gdata_HttpAdapterStreamingSocket

Extends the default HTTP adapter to handle streams instead of discrete body strings.

Extends from
\Zend_Http_Client_Adapter_Socket
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
Gdata  

Constants

Constantinteger  CHUNK_SIZE = '1024'

The amount read from a stream source at a time.

integer

Methods

methodpublic__construct( ) : void

Adapter constructor, currently empty. Config is set using setConfig()

Inherited from: \Zend_Http_Client_Adapter_Socket::__construct()
methodpublic__destruct( ) : void

Destructor: make sure the socket is disconnected

Inherited from: \Zend_Http_Client_Adapter_Socket::__destruct()

If we are in persistent TCP mode, will not close the connection

methodprotected_checkSocketReadTimeout( ) : void

Check if the socket has timed out - if so close connection and throw an exception

Inherited from: \Zend_Http_Client_Adapter_Socket::_checkSocketReadTimeout()
Throws
Exception Description
\Zend_Http_Client_Adapter_Exception with READ_TIMEOUT code
methodpublicclose( ) : void

Close the connection to the server

Inherited from: \Zend_Http_Client_Adapter_Socket::close()
methodpublicconnect( string $host, int $port = 80, boolean $secure = false ) : void

Connect to the remote server

Inherited from: \Zend_Http_Client_Adapter_Socket::connect()
Parameters
Name Type Description
$host string
$port int
$secure boolean
methodpublicgetConfig( ) : array

Retrieve the array of all configuration options

Inherited from: \Zend_Http_Client_Adapter_Socket::getConfig()
Returns
Type Description
array
methodpublicgetStreamContext( ) : resource

Get the stream context for the TCP connection to the server.

Inherited from: \Zend_Http_Client_Adapter_Socket::getStreamContext()

If no stream context is set, will create a default one.

Returns
Type Description
resource
methodpublicread( ) : string

Read response from server

Inherited from: \Zend_Http_Client_Adapter_Socket::read()
Returns
Type Description
string
methodpublicsetConfig( \Zend_Config $config = array ) : void

Set the configuration array for the adapter

Inherited from: \Zend_Http_Client_Adapter_Socket::setConfig()
Parameters
Name Type Description
$config \Zend_Config

| array $config

methodpublicsetOutputStream( resource $stream ) : \Zend_Http_Client_Adapter_Socket

Set output stream for the response

Inherited from: \Zend_Http_Client_Adapter_Socket::setOutputStream()

This function sets output stream where the result will be stored.

Parameters
Name Type Description
$stream resource
Returns
Type Description
\Zend_Http_Client_Adapter_Socket
methodpublicsetStreamContext( mixed $context ) : \Zend_Http_Client_Adapter_Socket

Set the stream context for the TCP connection to the server

Inherited from: \Zend_Http_Client_Adapter_Socket::setStreamContext()

Can accept either a pre-existing stream context resource, or an array of stream options, similar to the options array passed to the stream_context_create() PHP function. In such case a new stream context will be created using the passed options.

Parameters
Name Type Description
$context mixed Stream context or array of context options
Returns
Type Description
\Zend_Http_Client_Adapter_Socket
Details
since
Zend Framework 1.9  
methodpublicwrite( string $method, \Zend_Uri_Http $uri, string $http_ver = 1.1, array $headers = array, string $body ) : string

Send request to the remote server with streaming support.

Parameters
Name Type Description
$method string
$uri \Zend_Uri_Http
$http_ver string
$headers array
$body string
Returns
Type Description
string Request as string
Documentation was generated by DocBlox 0.13.3.