Source of: /manual/en/function.samconnection-connect.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sam.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.samconnection-connect.php',
1 => 'SAMConnection->connect',
),
'up' =>
array (
0 => 'ref.sam.php',
1 => 'SAM Functions',
),
'prev' =>
array (
0 => 'function.samconnection-commit.php',
1 => 'SAMConnection->commit',
),
'next' =>
array (
0 => 'function.samconnection-constructor.php',
1 => 'SAMConnection->__construct',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.samconnection-connect" class="refentry">
<div class="refnamediv">
<h1 class="refname">SAMConnection->connect</h1>
<p class="verinfo">(PECL sam >= 0.1.0)</p><p class="refpurpose"><span class="refname">SAMConnection->connect</span> — <span class="dc-title">
Establishes a connection to a Messaging Server
</span></p>
</div>
<a name="function.samconnection-connect.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="classsynopsis">
<div class="ooclass"><b class="classname">SAMConnection</b></div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>connect</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$protocol</tt></span>
[, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$properties</tt></span>
] )</div>
</div>
<p class="para">
Calling the "connect" method on a SAMConnection object connects the PHP
script to a messaging server. No messages can be sent or received until a
connection is made.
</p>
</div>
<a name="function.samconnection-connect.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p>
</div>
<a name="function.samconnection-connect.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This method returns <b><tt class="constant">FALSE</tt></b> if an error occurs.
</p>
</div>
<a name="function.samconnection-connect.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1
Creating a connection to a Messaging Server using the IBM MQSeries
protocol (WMQ)
</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">connect</span><span style="color: #007700">(</span><span style="color: #0000BB">SAM_WMQ</span><span style="color: #007700">, array(</span><span style="color: #0000BB">SAM_HOST </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Myhost.myco.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">SAM_PORT </span><span style="color: #007700">=> </span><span style="color: #0000BB">1506</span><span style="color: #007700">, </span><span style="color: #0000BB">SAM_BROKER </span><span style="color: #007700">=> </span><span style="color: #DD0000">'MyBroker'</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
<p class="para">
</p><div class="example">
<p><b>Example #2
Creating a connection with application transaction control and default
host and port values
</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">connect</span><span style="color: #007700">(</span><span style="color: #0000BB">SAM_WMQ</span><span style="color: #007700">, array(</span><span style="color: #0000BB">SAM_BROKER </span><span style="color: #007700">=> </span><span style="color: #DD0000">'MyBroker'</span><span style="color: #007700">, </span><span style="color: #0000BB">SAM_TRANSACTIONS </span><span style="color: #007700">=> </span><span style="color: #0000BB">SAM_MANUAL</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
<p class="para">
</p><div class="example">
<p><b>Example #3
Creating a connection to a Messaging Server using the IBM WebSphere
Platform Messaging protocol (WPM)
</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">connect</span><span style="color: #007700">(</span><span style="color: #0000BB">SAM_WPM</span><span style="color: #007700">, array(</span><span style="color: #0000BB">SAM_ENDPOINTS </span><span style="color: #007700">=> </span><span style="color: #DD0000">'localhost:7278:BootstrapBasicMessaging'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">SAM_BUS </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Bus1'</span><span style="color: #007700">, </span><span style="color: #0000BB">SAM_TARGETCHAIN </span><span style="color: #007700">=> </span><span style="color: #DD0000">'InboundBasicMessaging'</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.samconnection-connect.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.samconnection-isconnected.php" class="xref">SAMConnection->isConnected</a></li>
<li class="member"><a href="function.samconnection-disconnect.php" class="xref">SAMConnection->disconnect</a></li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
