Stomp::begin

stomp_begin

Starts a transaction

Description

Object-oriented style (method):

public bool Stomp::begin(string $transaction_id, array $headers = ?)

Procedural style:

bool stomp_begin(resource $link, string $transaction_id, array $headers = ?)

Starts a transaction.

Parameters

link: Procedural style only: The stomp link identifier returned by stomp_connect.
transaction_id: The transaction id.
headers: Associative array containing the additional headers (example: receipt).

Return Values

Returns true on success or false on failure.

Examples

See stomp_commit or stomp_abort.

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.