Stomp::hasFrame

stomp_has_frame

(PECL stomp >= 0.1.0)

Stomp::hasFrame -- stomp_has_frameIndicates whether or not there is a frame ready to read

Description

Object-oriented style (method):

public Stomp::hasFrame(): bool

Procedural style:

stomp_has_frame(resource $link): bool

Indicates whether or not there is a frame ready to read.

Parameters

link

Procedural style only: The stomp link identifier returned by stomp_connect().

Return Values

Returns true if a frame is ready to read, or false otherwise.

add a note

User Contributed Notes 1 note

up
-1
ricks at panamax dot com
7 years ago
Be aware that this function/method will block the caller, unless a frame is currently ready to be read. The duration of the block is the currently set read timeout.

The installation default for PECL Stomp read timeout is two seconds. Unless the associated ini file has been modified to override this value, or you have used the "set read timeout" function/method, the block time will be two seconds.
To Top