Stomp::send

stomp_send

(PECL stomp >= 0.1.0)

Stomp::send -- stomp_send — Sends a message

Description

Object-oriented style (method):

public function Stomp::send(string $destination, mixed $msg, array $headers = ?): bool

Procedural style:

function stomp_send(
    resource $link,
    string $destination,
    mixed $msg,
    array $headers = ?
): bool

Sends a message to the Message Broker.

Parameters

link: Procedural style only: The stomp link identifier returned by stomp_connect().
destination: Where to send the message
msg: Message to send.
headers: Associative array containing the additional headers (example: receipt).

Return Values

Returns true on success or false on failure.

Examples

See stomp_ack().

Notes

Note:
A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.

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.