The Stomp class
Introduction
(PECL stomp >= 0.1.0)
Represents a connection between PHP and a Stomp compliant Message Broker.
Class synopsis
Stomp {
/* Methods */
public abort ( string $transaction_id [, array $headers ] ) : bool
public ack ( mixed $msg [, array $headers ] ) : bool
public begin ( string $transaction_id [, array $headers ] ) : bool
public commit ( string $transaction_id [, array $headers ] ) : bool
public __construct ([ string $broker = ini_get("stomp.default_broker_uri") [, string $username [, string $password [, array $headers ]]]] ) public __destruct ( ) : bool
public error ( ) : string
public getReadTimeout ( ) : array
public getSessionId ( ) : string|false
public hasFrame ( ) : bool
public readFrame ([ string $class_name = "stompFrame" ] ) : stompframe
public send ( string $destination , mixed $msg [, array $headers ] ) : bool
public setReadTimeout ( int $seconds [, int $microseconds ] ) : void
public subscribe ( string $destination [, array $headers ] ) : bool
public unsubscribe ( string $destination [, array $headers ] ) : bool}
Table of Contents
- Stomp::abort — Rolls back a transaction in progress
- Stomp::ack — Acknowledges consumption of a message
- Stomp::begin — Starts a transaction
- Stomp::commit — Commits a transaction in progress
- Stomp::__construct — Opens a connection
- Stomp::__destruct — Closes stomp connection
- Stomp::error — Gets the last stomp error
- Stomp::getReadTimeout — Gets read timeout
- Stomp::getSessionId — Gets the current stomp session ID
- Stomp::hasFrame — Indicates whether or not there is a frame ready to read
- Stomp::readFrame — Reads the next frame
- Stomp::send — Sends a message
- Stomp::setReadTimeout — Sets read timeout
- Stomp::subscribe — Registers to listen to a given destination
- Stomp::unsubscribe — Removes an existing subscription
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.stomp.php