Docs For Class HTTP_Request2

$connectionWarnings = array()

[line 68]

PHP warning messages raised during stream_socket_client() call

Access: protected

Type:

array

[ Top ]

$deadline =

[line 80]

Sum of start time and global timeout, exception will be thrown if request continues past this time

Access: protected

Type:

integer

[ Top ]

$socket =

[line 74]

Connected socket

Access: protected

Type:

resource

[ Top ]

$timeout =

[line 86]

Global timeout value, mostly for exception messages

Access: protected

Type:

integer

[ Top ]

__construct (Constructor) [line 99]

HTTP_Request2_SocketWrapper __construct(
string
$address, int
$timeout, [
$sslOptions = array()])

Class constructor, tries to establish connection

Throws: HTTP_Request2_ConnectionException
Throws: HTTP_Request2_LogicException
Access: public

Overridden in child classes as:

HTTP_Request2_SOCKS5::__construct(): Constructor, tries to connect and authenticate to a SOCKS5 proxy

Parameters:

string	`$address`	—	Address for stream_socket_client() call, e.g. 'tcp://localhost:80'
int	`$timeout`	—	Connection timeout (seconds)
array	`$sslOptions`	—	SSL context options

[ Top ]

__destruct (Destructor) [line 125]

void __destruct(
)

Destructor, disconnects socket

Access: public

[ Top ]

checkTimeout [line 250]

void checkTimeout(
)

Throws an Exception if stream timed out

Throws: HTTP_Request2_MessageException
Access: protected

[ Top ]

connectionWarningsHandler [line 275]

bool connectionWarningsHandler(
int
$errno, string
$errstr)

Error handler to use during stream_socket_client() call

One stream_socket_client() call may produce *multiple* PHP warnings (especially OpenSSL-related), we keep them in an array to later use for the message of HTTP_Request2_ConnectionException

Access: protected

Parameters:

int	`$errno`	—	error level
string	`$errstr`	—	error message

[ Top ]

enableCrypto [line 226]

void enableCrypto(
)

Turns on encryption on a socket

Throws: HTTP_Request2_ConnectionException
Access: public

[ Top ]

eof [line 202]

bool eof(
)

Tests for end-of-file on a socket

Access: public

[ Top ]

read [line 138]

string read(
int
$length)

Wrapper around fread(), handles global request timeout

Return: Data read from socket
Throws: HTTP_Request2_MessageException In case of timeout
Access: public

Parameters:

int $length — Reads up to this number of bytes

[ Top ]

readLine [line 159]

string readLine(
int
$bufferSize)

Reads until either the end of the socket or a newline, whichever comes first

Strips the trailing newline from the returned data, handles global request timeout. Method idea borrowed from Net_Socket PEAR package.

Return: Available data up to the newline (not including newline)
Throws: HTTP_Request2_MessageException In case of timeout
Access: public

Parameters:

int $bufferSize — buffer size to use for reading

[ Top ]

setDeadline [line 215]

void setDeadline(
int
$deadline, int
$timeout)

Sets request deadline

Access: public

Parameters:

int	`$deadline`	—	Exception will be thrown if request continues past this time
int	`$timeout`	—	Original request timeout value, to use in Exception message

[ Top ]

write [line 183]

int write(
string
$data)

Wrapper around fwrite(), handles global request timeout

Throws: HTTP_Request2_MessageException
Access: public

Parameters:

string $data — String to be written

[ Top ]

Class: HTTP_Request2_SocketWrapper

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$connectionWarnings = array()

$deadline =

$socket =

$timeout =

Method Detail

__construct (Constructor) [line 99]

Parameters:

__destruct (Destructor) [line 125]

checkTimeout [line 250]

connectionWarningsHandler [line 275]

Parameters:

enableCrypto [line 226]

eof [line 202]

read [line 138]

Parameters:

readLine [line 159]

Parameters:

setDeadline [line 215]

Parameters:

write [line 183]

Parameters: