Stomp::subscribe

stomp_subscribe

Registers to listen to a given destination

Description

Object-oriented style (method):

public bool Stomp::subscribe(string $destination, array $headers = ?)

Procedural style:

bool stomp_subscribe(resource $link, string $destination, array $headers = ?)

Registers to listen to a given destination.

Parameters

link

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

destination

Destination to subscribe to.

headers

Associative array containing the additional headers (example: receipt).

Return Values

Returns true on success or false on failure.

Examples

See stomp_ack.

Notes

Tip

Stomp is inherently asynchronous. Synchronous communication can be implemented adding a receipt header. This will cause methods to not return anything until the server has acknowledged receipt of the message or until read timeout was reached.