HttpRequestPool

class HttpRequestPool implements Countable, Iterator (View source)

Methods

__construct(HttpRequest|null $request = null)

(PECL pecl_http >= 0.10.0)
HttpRequestPool constructor

void
__destruct()

(PECL pecl_http >= 0.10.0)
HttpRequestPool destructor

bool
attach(HttpRequest $request)

(PECL pecl_http >= 0.10.0)
Attach HttpRequest

bool
detach(HttpRequest $request)

(PECL pecl_http >= 0.10.0)
Detach HttpRequest

bool
send()

(PECL pecl_http >= 0.10.0)
Send all requests

void
reset()

(PECL pecl_http >= 0.10.0)
Reset request pool

bool
socketPerform()

(PECL pecl_http >= 0.15.0)
Perform socket actions

bool
socketSelect()

(PECL pecl_http >= 0.10.0)
Perform socket select

bool
valid()

Checks if current position is valid

mixed
current()

Return the current element

mixed
key()

Return the key of the current element

void
next()

Move forward to next element

void
rewind()

Rewind the Iterator to the first element

int
count()

Count elements of an object

array
getAttachedRequests()

(PECL pecl_http >= 0.16.0)
Get attached requests

array
getFinishedRequests()

(PECL pecl_http >= 0.16.0)
Get finished requests

enablePipelining($enable)

No description

enableEvents($enable)

No description

Details

at line 1556
__construct(HttpRequest|null $request = null)

(PECL pecl_http >= 0.10.0)
HttpRequestPool constructor

Parameters

HttpRequest|null $request

[optional]

HttpRequest object to attach

at line 1564
void __destruct()

(PECL pecl_http >= 0.10.0)
HttpRequestPool destructor

Return Value

void

at line 1575
bool attach(HttpRequest $request)

(PECL pecl_http >= 0.10.0)
Attach HttpRequest

Parameters

HttpRequest $request

an HttpRequest object not already attached to any HttpRequestPool object

Return Value

bool

true on success or false on failure.

at line 1586
bool detach(HttpRequest $request)

(PECL pecl_http >= 0.10.0)
Detach HttpRequest

Parameters

HttpRequest $request

an HttpRequest object attached to this HttpRequestPool object

Return Value

bool

true on success or false on failure.

at line 1594
bool send()

(PECL pecl_http >= 0.10.0)
Send all requests

Return Value

bool

true on success or false on failure.

at line 1602
void reset()

(PECL pecl_http >= 0.10.0)
Reset request pool

Return Value

void

at line 1610
protected bool socketPerform()

(PECL pecl_http >= 0.15.0)
Perform socket actions

Return Value

bool

TRUE until each request has finished its transaction.

at line 1618
protected bool socketSelect()

(PECL pecl_http >= 0.10.0)
Perform socket select

Return Value

bool

true on success or false on failure.

at line 1620
bool valid()

Checks if current position is valid

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 1622
mixed current()

Return the current element

Return Value

mixed

Can return any type.

at line 1624
mixed key()

Return the key of the current element

Return Value

mixed

TKey on success, or null on failure.

at line 1626
void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

at line 1628
void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.

at line 1630
int count()

Count elements of an object

Return Value

int

The custom count as an integer.

The return value is cast to an integer.

at line 1638
array getAttachedRequests()

(PECL pecl_http >= 0.16.0)
Get attached requests

Return Value

array

an array containing all currently attached HttpRequest objects.

at line 1647
array getFinishedRequests()

(PECL pecl_http >= 0.16.0)
Get finished requests

Return Value

array

an array containing all attached HttpRequest objects that already have finished their work.

at line 1653
enablePipelining($enable)

No description

Parameters

$enable [optional]

at line 1658
enableEvents($enable)

No description

Parameters

$enable [optional]