Stomp Client

はじめに
インストール/設定
例
Stomp 関数
- stomp_connect_error — Returns a string description of the last connect error
- stomp_version — Gets the current stomp extension version
Stomp — The Stomp class
- 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
StompFrame — The StompFrame class
- StompFrame::__construct — Constructor
StompException — The StompException class
- StompException::getDetails — Get exception details

The Stomp class

はじめに

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

クラス概要

Stomp

class Stomp {

/* メソッド */

public __construct(
    string $broker = ini_get("stomp.default_broker_uri"),
    string $username = ?,
    string $password = ?,
    array $headers = ?
)

public bool abort(string $transaction_id, array $headers = ?)

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

public bool ack(mixed $msg, array $headers = ?)

bool stomp_ack(resource $link, mixed $msg, array $headers = ?)

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

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

public bool commit(string $transaction_id, array $headers = ?)

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

resource stomp_connect(
    string $broker = ini_get("stomp.default_broker_uri"),
    string $username = ?,
    string $password = ?,
    array $headers = ?
)

bool stomp_close(resource $link)

public string error()

string stomp_error(resource $link)

public array getReadTimeout()

array stomp_get_read_timeout(resource $link)

public stringfalse getSessionId()

stringfalse stomp_get_session_id(resource $link)

public bool hasFrame()

bool stomp_has_frame(resource $link)

public stompframe readFrame(string $class_name = "stompFrame")

array stomp_read_frame(resource $link)

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

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

public void setReadTimeout(int $seconds, int $microseconds = ?)

void stomp_set_read_timeout(resource $link, int $seconds, int $microseconds = ?)

public bool subscribe(string $destination, array $headers = ?)

bool stomp_subscribe(resource $link, string $destination, array $headers = ?)

public bool unsubscribe(string $destination, array $headers = ?)

bool stomp_unsubscribe(resource $link, string $destination, array $headers = ?)

public __destruct()

}

The StompFrame class

はじめに

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

クラス概要

StompFrame

class StompFrame {

/* プロパティ */

public $command;

public $headers;

public $body;

/* メソッド */

__construct(string $command = ?, array $headers = ?, string $body = ?)

}

プロパティ

command: Frame command.
headers: Frame headers (array).
body: Frame body.

The StompException class

はじめに

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

クラス概要

StompException

class StompException extends Exception {

/* 継承したメソッド */

final public string Exception::getMessage()

final public Throwablenull Exception::getPrevious()

final public int Exception::getCode()

final public string Exception::getFile()

final public int Exception::getLine()

final public array Exception::getTrace()

final public string Exception::getTraceAsString()

public string Exception::__toString()

private void Exception::__clone()

/* メソッド */

public string getDetails()

}