166 lines
4.0 KiB
PHP
166 lines
4.0 KiB
PHP
<?php
|
|
|
|
class Stomp {
|
|
|
|
/**
|
|
* Connect to server
|
|
*
|
|
* @param string $broker Broker URI
|
|
* @param string $username The username
|
|
* @param string $password The password
|
|
*/
|
|
public function __construct($broker = null, $username = null, $password = null) {
|
|
}
|
|
|
|
/**
|
|
* Get the current stomp session ID
|
|
*
|
|
* @return string stomp session ID if it exists, or FALSE otherwise
|
|
*/
|
|
public function getSessionId() {
|
|
}
|
|
|
|
/**
|
|
* Close stomp connection
|
|
*
|
|
* @return boolean TRUE on success, or FALSE on failure
|
|
*/
|
|
public function disconnect() {
|
|
}
|
|
|
|
/**
|
|
* Sends a message to a destination in the messaging system
|
|
*
|
|
* @param string $destination indicates where to send the message
|
|
* @param string|StompFrame $msg message to be sent
|
|
* @param array $properties extra properties (example: receipt, transaction)
|
|
* @return boolean TRUE on success, or FALSE on failure
|
|
*/
|
|
public function send($destination, $msg, array $properties = array()) {
|
|
}
|
|
|
|
/**
|
|
* Register to listen to a given destination
|
|
*
|
|
* @param string $destination indicates which destination to subscribe to
|
|
* @param array $properties extra properties (example: receipt, transaction, id)
|
|
* @return boolean TRUE on success, or FALSE on failure
|
|
*/
|
|
public function subscribe($destination, array $properties = array()) {
|
|
}
|
|
|
|
/**
|
|
* Remove an existing subscription
|
|
*
|
|
* @param string $destination indicates which subscription to remove
|
|
* @param array $properties extra properties (example: receipt, transaction, id)
|
|
* @return boolean TRUE on success, or FALSE on failure
|
|
*/
|
|
public function unsubscribe($destination, array $properties = array()) {
|
|
}
|
|
|
|
/**
|
|
* Indicate whether or not there is a frame ready to read
|
|
*
|
|
* @return boolean TRUE if there is one, or FALSE otherwise
|
|
*/
|
|
public function hasFrame() {
|
|
}
|
|
|
|
/**
|
|
* Read the next frame
|
|
*
|
|
* @return StompFrame on success, or FALSE on failure
|
|
*/
|
|
public function readFrame() {
|
|
}
|
|
|
|
/**
|
|
* Start a transaction
|
|
*
|
|
* @param string $transaction_id transaction id
|
|
* @return boolean TRUE on success, or FALSE on failure
|
|
*/
|
|
public function begin($transaction_id) {
|
|
}
|
|
|
|
/**
|
|
* Commit a transaction in progress
|
|
*
|
|
* @param string $transaction_id transaction id
|
|
* @return boolean TRUE on success, or FALSE on failure
|
|
*/
|
|
public function commit($transaction_id) {
|
|
}
|
|
|
|
/**
|
|
* Roll back a transaction in progress
|
|
*
|
|
* @param string $transaction_id transaction id
|
|
* @return boolean TRUE on success, or FALSE on failure
|
|
*/
|
|
public function abort($transaction_id) {
|
|
}
|
|
|
|
/**
|
|
* Acknowledge consumption of a message from a subscription using client acknowledgment
|
|
*
|
|
* @param string|StompFrame $msg message/messageId to be acknowledged
|
|
* @param array $properties extra properties (example: receipt, transaction)
|
|
* @return boolean TRUE on success, or FALSE on failure
|
|
*/
|
|
public function ack($msg, array $properties = array()) {
|
|
}
|
|
|
|
/**
|
|
* Get the last stomp error
|
|
*
|
|
* @return string Error message, or FALSE if no error
|
|
*/
|
|
public function error() {
|
|
}
|
|
|
|
/**
|
|
* Set timeout
|
|
*
|
|
* @param int $seconds the seconds part of the timeout to be set
|
|
* @param int $microseconds the microseconds part of the timeout to be set
|
|
* @return void
|
|
*/
|
|
public function setTimeout($seconds, $microseconds = 0) {
|
|
}
|
|
|
|
/**
|
|
* Get timeout
|
|
*
|
|
* @return array Array with timeout informations
|
|
*/
|
|
public function getTimeout() {
|
|
}
|
|
|
|
}
|
|
|
|
class StompFrame {
|
|
|
|
/**
|
|
* Frame Command
|
|
* @var String
|
|
*/
|
|
public $command;
|
|
|
|
/**
|
|
* Frame headers
|
|
* @var Array
|
|
*/
|
|
public $headers;
|
|
|
|
/**
|
|
* Frame body
|
|
* @var String
|
|
*/
|
|
public $body;
|
|
}
|
|
|
|
class StompException extends Exception {
|
|
}
|