SAM Functions
Predefined Classes
SAMConnection
Object representing a connection to a Messaging Server
Constructor
-
new SAMConnection - construct a new connection object to allow connection to a messaging infrastructure.
Methods
-
commit - a method that commits (successfully completes) an in-flight unit of work.
-
connect - a method that connects a PHP script to a messaging server.
-
disconnect - a method that disconnects a PHP script from a messaging server.
-
isConnected - a method that checks whether a PHP script is connected to a messaging server.
-
peek - a method that receives a message from a queue without removing it from the queue.
-
peekAll - a method that receives one or messages from a queue without removing them from the queue.
-
receive - a method that receives a message from a queue or subscription.
-
remove - a method that removes a message from a queue.
-
rollback - a method that cancels (rolls back) an in-flight unit of work.
-
send - a method that sends a message to a queue or posts to a topic
-
setDebug - a method that switches additional debugging output on or off
-
subscribe - a method that creates a subscription to one or more topics
-
unsubscribe - a method that destroys a subscription to one or more topics
SAMMessage
Object representing a message to be sent or received
Table of Contents
- SAMConnection::commit — Commits (completes) the current unit of work
- SAMConnection::connect — Establishes a connection to a Messaging Server
- SAMConnection::__construct — Creates a new connection to a Messaging Server
- SAMConnection::disconnect — Disconnects from a Messaging Server
- SAMConnection::errno — Contains the unique numeric error code of the last executed SAM operation
- SAMConnection::error — Contains the text description of the last failed SAM operation
- SAMConnection::isConnected — Queries whether a connection is established to a Messaging Server
- SAMConnection::peek — Read a message from a queue without removing it from the queue
- SAMConnection::peekAll — Read one or more messages from a queue without removing it from the queue
- SAMConnection::receive — Receive a message from a queue or subscription
- SAMConnection::remove — Remove a message from a queue
- SAMConnection::rollback — Cancels (rolls back) an in-flight unit of work
- SAMConnection::send — Send a message to a queue or publish an item to a topic
- SAMConnection::setDebug — Turn on or off additional debugging output
- SAMConnection::subscribe — Create a subscription to a specified topic
- SAMConnection::unsubscribe — Cancel a subscription to a specified topic
- SAMMessage::body — The body of the message
- SAMMessage::__construct — Creates a new Message object
- SAMMessage::header — The header properties of the message
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-ref.sam.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
