<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>SAM Functions</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sam.errors.html">Error handling</a></div>
<div class="next" style="text-align: right; float: right;"><a href="samconnection.commit.html">SAMConnection::commit</a></div>
<div class="up"><a href="book.sam.html">SAM</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ref.sam" class="reference">
<h1 class="title">SAM Functions</h1>
<div class="partintro">
<div class="section" id="sam.classes">
<h2 class="title">Predefined Classes</h2>
<div class="section" id="class.samconnection">
<h2 class="title"><strong class="classname">SAMConnection</strong></h2>
<p class="para">
Object representing a connection to a Messaging Server
</p>
<div class="section">
<h2 class="title">Constructor</h2>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<a href="samconnection.construct.html" class="link">new SAMConnection</a> - construct a new connection object to allow connection to a messaging infrastructure.
</p>
</li>
</ul>
</div>
<div class="section">
<h2 class="title">Methods</h2>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<a href="samconnection.commit.html" class="link">commit</a>
- a method that commits (successfully completes) an in-flight unit
of work.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.connect.html" class="link">connect</a>
- a method that connects a PHP script to a messaging server.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.disconnect.html" class="link">disconnect</a>
- a method that disconnects a PHP script from a messaging server.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.isconnected.html" class="link">isConnected</a>
- a method that checks whether a PHP script is connected to a
messaging server.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.peek.html" class="link">peek</a>
- a method that receives a message from a queue without removing it
from the queue.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.peekall.html" class="link">peekAll</a>
- a method that receives one or messages from a queue without
removing them from the queue.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.receive.html" class="link">receive</a>
- a method that receives a message from a queue or subscription.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.remove.html" class="link">remove</a>
- a method that removes a message from a queue.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.rollback.html" class="link">rollback</a>
- a method that cancels (rolls back) an in-flight unit of work.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.send.html" class="link">send</a>
- a method that sends a message to a queue or posts to a topic
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.setdebug.html" class="link">setDebug</a>
- a method that switches additional debugging output on or off
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.subscribe.html" class="link">subscribe</a>
- a method that creates a subscription to one or more topics
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.unsubscribe.html" class="link">unsubscribe</a>
- a method that destroys a subscription to one or more topics
</p>
</li>
</ul>
</div>
<div class="section">
<h2 class="title">Properties</h2>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<a href="samconnection.errno.html" class="link">errno</a> - the
numeric error code for the last encountered error on this
connection. This property is set to 0 if the last operation was
successful.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="samconnection.error.html" class="link">error</a> - the
text description for the last encountered error on this connection
</p>
</li>
</ul>
</div>
</div>
<div class="section" id="class.sammessage">
<h2 class="title"><strong class="classname">SAMMessage</strong></h2>
<p class="para">
Object representing a message to be sent or received
</p>
<div class="section">
<h2 class="title">Constructor</h2>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<a href="sammessage.construct.html" class="link">new SAMMessage</a> - construct a
new message.
</p>
</li>
</ul>
</div>
<div class="section">
<h2 class="title">Properties</h2>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<a href="sammessage.body.html" class="link">body</a> - the body of
the message.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sammessage.header.html" class="link">header</a> - the
header properties of the message.
</p>
</li>
</ul>
</div>
</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="samconnection.commit.html">SAMConnection::commit</a> — Commits (completes) the current unit of work.</li><li><a href="samconnection.connect.html">SAMConnection::connect</a> — Establishes a connection to a Messaging Server</li><li><a href="samconnection.construct.html">SAMConnection::__construct</a> — Creates a new connection to a Messaging Server</li><li><a href="samconnection.disconnect.html">SAMConnection::disconnect</a> — Disconnects from a Messaging Server</li><li><a href="samconnection.errno.html">SAMConnection::errno</a> — Contains the unique numeric error code of the last executed SAM operation.</li><li><a href="samconnection.error.html">SAMConnection::error</a> — Contains the text description of the last failed SAM operation.</li><li><a href="samconnection.isconnected.html">SAMConnection::isConnected</a> — Queries whether a connection is established to a Messaging Server</li><li><a href="samconnection.peek.html">SAMConnection::peek</a> — Read a message from a queue without removing it from the queue.</li><li><a href="samconnection.peekall.html">SAMConnection::peekAll</a> — Read one or more messages from a queue without removing it from the queue.</li><li><a href="samconnection.receive.html">SAMConnection::receive</a> — Receive a message from a queue or subscription.</li><li><a href="samconnection.remove.html">SAMConnection::remove</a> — Remove a message from a queue.</li><li><a href="samconnection.rollback.html">SAMConnection::rollback</a> — Cancels (rolls back) an in-flight unit of work.</li><li><a href="samconnection.send.html">SAMConnection::send</a> — Send a message to a queue or publish an item to a topic.</li><li><a href="samconnection.setdebug.html">SAMConnection::setDebug</a> — Turn on or off additional debugging output.</li><li><a href="samconnection.subscribe.html">SAMConnection::subscribe</a> — Create a subscription to a specified topic.</li><li><a href="samconnection.unsubscribe.html">SAMConnection::unsubscribe</a> — Cancel a subscription to a specified topic.</li><li><a href="sammessage.body.html">SAMMessage::body</a> — The body of the message.</li><li><a href="sammessage.construct.html">SAMMessage::__construct</a> — Creates a new Message object</li><li><a href="sammessage.header.html">SAMMessage::header</a> — The header properties of the message.</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sam.errors.html">Error handling</a></div>
<div class="next" style="text-align: right; float: right;"><a href="samconnection.commit.html">SAMConnection::commit</a></div>
<div class="up"><a href="book.sam.html">SAM</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
