summaryrefslogtreecommitdiff
path: root/qpid/packaging/windows/INSTALL_NOTES.html
blob: 0eda0aa2fea8e2b484e2676eb2711a141cb17d0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<html>
<head>
<title>Apache Qpid C++ 0.6 Installation Notes</title>
</head>
<body>
<H1>Apache Qpid C++ 0.6 Installation Notes</H1>

<p>Thank you for installing the Apache Qpid version 0.6 for Windows kit.
If the requisite features were installed, you can now run a broker,
use the example programs, and design your own messaging programs while
reading the Qpid C++ API reference documentation.</p>

<H2>Running a Message Broker</H2>
<p>
In AMQP, programs that send and receive messages are clients. The agents
that route and queue messages to and from clients are brokers. In order to
use any Qpid-based messaging program there must be at least one broker
running which the client(s) can communicate with. The broker need not execute
on the same system as the client, but it must be reachable using TCP/IP.</p>

<p>The broker executable is installed in the <code>bin</code> subdirectory
of your Qpid installation directory. The broker program is
<code>qpidd.exe</code>. The simplest way to experiment with the
broker is to open a command prompt window, cd to the installation
directory, and execute the broker:
<pre>
cd "C:\Program Files\Apache\qpidc-0.6\bin"
qpidd
</pre>
A small amount of information will be displayed to let you know the broker
is running and listening for client connections.</p>
<p>To stop the broker, you can simply type <code>^C</code> in the
command prompt window where the broker is running.</p>

<p>For a full list of options for the broker, you can use the
<code>--help</code> option.</p>

<H2>Using the Example Programs</H2>

<p>The example programs are located in the <code>examples</code> subdirectory
of the Qpid installation directory. There are a number of examples, each with
its own subdirectory under <code>examples</code>. You can use the examples to
<ul>
<li>Study to learn Qpid programming techniques you may want to use</li>
<li>Build and run to observe and test Qpid features</li>
</ul>
Each example's directory contains source code and Visual Studio 2008 project
files you can use to build the examples.</p>

<H2>Reading the C++ API Reference Documentation</H2>
<p>The C++ API reference documentation is HTML and can be viewed using
your web browser. It is located in the <code>docs\api\html</code> subdirectory
of the installation directory, but there is also a shortcut to the
documentation in <i>Start > All Programs > Apache Qpid > Qpid C++ Reference
Documentation</i>. Selecting that menu item will launch the documentation's
main page in your default web browser.</p>

<H2>Complete Source Code is Available</H2>
<p>If you wish to view Qpid's source code, please visit
<a href="http://qpid.apache.org/download.html">
http://qpid.apache.org/download.html</a>. The source components used to build
this installed kit are "C++ broker &amp; client" and "C# (.NET, WCF) WCF
channel (C++ Broker Compatible)."</p>

<H1>Notes</H1>
<p>Please read the following sections for important notes regarding this
release.</p>
<H2>WCF Channel</H2>
<p>This release includes a new .NET WCF Channel implementation. The WCF DLL
is named <code>Apache.Qpid.Channel.dll</code> located in the <code>bin</code>
directory under the Qpid installation location.</p>
<p>WCF Channel programming examples are located in the
<code>examples\Channel</code> under the installation directory.</p>
<p>The WCF Channel DLLs are not loaded into the Global Assembly Cache (GAC)
at install time; therefore, they must be referenced explicitly from the install
location.</p>
<p>If you wish to install the WCF Channel DLLs into the GAC, you can use the
following commands (assuming the Qpid install location is
<code>C:\Program Files\Apache\qpidc-0.6</code>):</p>
<pre>
gacutil -I "C:\Program Files\Apache\qpidc-0.6\bin\Apache.Qpid.Channel.dll"
gacutil -I "C:\Program Files\Apache\qpidc-0.6\bin\Apache.Qpid.Interop.dll"
</pre>
<p>To remove the DLLs from the GAC:</p>
<pre>
gacutil /u "Apache.Qpid.Channel"
gacutil /u "Apache.Qpid.Interop"
</pre>
To use transactions with the WCF channel, you must enable the Microsoft Distributed Transaction Coordinator service and configure it to find and use the Qpid XA transaction module.
<ul>
<li>
Update the PATH environment variable for services:
right click <i>Computer</i>, select <i>Properties > Advanced System
Settings > Environment Variables > System Variables</i> and add
"C:\Program Files\Apache\qpidc-0.6\bin" to the PATH variable.
<li>
Following the instructions in
<a href="http://support.microsoft.com/kb/817066">
http://support.microsoft.com/kb/817066</a>,
update the MSDTC security settings to allow XA transactions, and
create an XADLL registry entry for "qpidxarm" with string (REG_SZ)
value "C:\Program Files\Apache\qpidc-0.6\bin\qpidxarm.dll"
<li>
Open <i>Control Panel > Administrative Tools > Services</i> and start
(or restart) the DTC service and make sure that the DTC service is set
to start automatically when the system reboots.
</ul>

<H2>Broker Persistence Module</H2>
<p>This release includes a new persistence module. The broker can use this
module to facilitate durable queues, exchanges, bindings, configuration, and
messages. The persistence module uses SQL Server Express (or SQL Server) 2005
or newer. The persistence module is a Qpid broker plugin. It is not loaded by
default; therefore, to gain support for durable items the persistence plugin
must be loaded into the broker. This can be done using the
<code>--module-dir</code> option to load all available plugins. For example:
<pre>
cd "C:\Program Files\Apache\qpidc-0.6"
bin\qpidd.exe --module-dir plugins\broker
</pre>
The <code>--module-dir</code> option can also take a full path. The option
can also be included in the broker configuration file. A sample is located
in the <code>conf\qpidd.conf</code> file under the installation directory.</p>

<H1>For More Information</H1>
<p>For more information on Apache Qpid, please visit the web site
<a href="http://qpid.apache.org/">http://qpid.apache.org/</a>.</p>

<p>The Qpid site contains more information about Qpid and AMQP as well as
directions for joining and reading the Qpid-related email lists.</p>
</body>
</html>