Stomp Client

Table of Contents

The Stomp class

Introduction

Represents a connection between PHP and a Stomp compliant Message Broker.

Class synopsis

Stomp
class Stomp {
/* Methods */
public bool abort ( string $transaction_id [, array $headers ] )
public bool ack ( mixed $msg [, array $headers ] )
public bool begin ( string $transaction_id [, array $headers ] )
public bool commit ( string $transaction_id [, array $headers ] )
public __construct ([ string $broker = ini_get("stomp.default_broker_uri") [, string $username [, string $password [, array $headers ]]]] )
public bool __destruct ( void )
public string error ( void )
public array getReadTimeout ( void )
public string getSessionId ( void )
public bool hasFrame ( void )
public stompframe readFrame ([ string $class_name = "stompFrame" ] )
public bool send ( string $destination , mixed $msg [, array $headers ] )
public void setReadTimeout ( int $seconds [, int $microseconds ] )
public bool subscribe ( string $destination [, array $headers ] )
public bool unsubscribe ( string $destination [, array $headers ] )
}

The StompFrame class

Introduction

Represents a message which was sent or received from a Stomp compliant Message Broker.

Class synopsis

StompFrame
class StompFrame {
/* Properties */
public $command ;
public $headers ;
public $body ;
/* Methods */
__construct ([ string $command [, array $headers [, string $body ]]] )
}

Properties

command

Frame command.

headers

Frame headers (array).

body

Frame body.

The StompException class

Introduction

Represents an error raised by the stomp extension. See Exceptions for more information about Exceptions in PHP.

Class synopsis

StompException
class StompException extends Exception {
/* Inherited methods */
final public string Exception::getMessage ( void )
final public Throwable Exception::getPrevious ( void )
final public mixed Exception::getCode ( void )
final public string Exception::getFile ( void )
final public int Exception::getLine ( void )
final public array Exception::getTrace ( void )
final public string Exception::getTraceAsString ( void )
public string Exception::__toString ( void )
final private void Exception::__clone ( void )
/* Methods */
public string getDetails ( void )
}