Zend_Queue-Adapters.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <!-- EN-Revision: 16641 -->
  4. <sect1 id="zend.queue.adapters">
  5. <title>アダプタ</title>
  6. <para>
  7. <classname>Zend_Queue</classname>は、
  8. インターフェース<classname>Zend_Queue_Adapter_AdapterInterface</classname>を実装する
  9. すべての待ち行列をサポートします。
  10. 以下のメッセージ待ち行列サービスがサポートされます:
  11. </para>
  12. <itemizedlist>
  13. <listitem>
  14. <para>
  15. <ulink url="http://activemq.apache.org/">ApacheMQ</ulink>.
  16. </para>
  17. </listitem>
  18. <listitem>
  19. <para>
  20. <classname>Zend_Db</classname>を経たデータベースによる待ち行列
  21. </para>
  22. </listitem>
  23. <listitem>
  24. <para>
  25. <classname>Memcache</classname>による
  26. <ulink url="http://memcachedb.org/memcacheq/">MemcacheQ</ulink>待ち行列
  27. </para>
  28. </listitem>
  29. <listitem>
  30. <para>
  31. 内部配列。ユニットテストに役立ちます。
  32. </para>
  33. </listitem>
  34. </itemizedlist>
  35. <note id="zend.queue.adapters.limitations">
  36. <title>限定事項</title>
  37. <para>
  38. メッセージ・トランザクション処理は、サポートされません。
  39. </para>
  40. </note>
  41. <sect2 id="zend.queue.adapters.configuration">
  42. <title>固有のアダプタ - 設定の構成</title>
  43. <para>
  44. デフォルトの設定が示される場合は、パラメータは任意です。
  45. デフォルトの設定が指定されない場合は、パラメータが必要です。
  46. </para>
  47. <sect3 id="zend.queue.adapters.configuration.Apachemq">
  48. <title>ApacheMQ - Zend_Queue_Adapter_Apachemq</title>
  49. <para>
  50. ここでリストされたオプションは、既知の必須条件です。
  51. すべてのメッセージ発信サーバが、
  52. ユーザー名またはパスワードを必要とするというわけではありません。
  53. </para>
  54. <itemizedlist>
  55. <listitem>
  56. <para>
  57. <emphasis>$options['name'] = '/temp/queue1';</emphasis>
  58. </para>
  59. <para>
  60. これは、使い始めたい待ち行列の名前です。(必須)
  61. </para>
  62. </listitem>
  63. <listitem>
  64. <para>
  65. <emphasis>$options['driverOptions']['host'] = 'host.domain.tld';</emphasis>
  66. </para>
  67. <para>
  68. <emphasis>$options['driverOptions']['host'] = '127.0.0.1';</emphasis>
  69. </para>
  70. <para>
  71. ホストをIPアドレスまたはホスト名にセットするかもしれません。
  72. </para>
  73. <para>
  74. ホストのデフォルトの設定は '127.0.0.1' です。
  75. </para>
  76. </listitem>
  77. <listitem>
  78. <para>
  79. <emphasis>$options['driverOptions']['port'] = 61613;</emphasis>
  80. </para>
  81. <para>ポートのデフォルトの設定は 61613 です。</para>
  82. </listitem>
  83. <listitem>
  84. <para>
  85. <emphasis>$options['driverOptions']['username'] = 'username';</emphasis>
  86. </para>
  87. <para>
  88. 一部のメッセージ発信サーバのために選択できます。
  89. メッセージ発信サーバのためのマニュアルを読んでください。
  90. </para>
  91. </listitem>
  92. <listitem>
  93. <para>
  94. <emphasis>$options['driverOptions']['password'] = 'password';</emphasis>
  95. </para>
  96. <para>
  97. 一部のメッセージ発信サーバのために選択できます。
  98. メッセージ発信サーバのためのマニュアルを読んでください。
  99. </para>
  100. </listitem>
  101. <listitem>
  102. <para>
  103. <emphasis>$options['driverOptions']['timeout_sec'] = 2;</emphasis>
  104. </para>
  105. <para>
  106. <emphasis>$options['driverOptions']['timeout_usec'] = 0;</emphasis>
  107. </para>
  108. <para>
  109. これは、<classname>Zend_Queue_Adapter_Activemq</classname>がメッセージを返さない前に
  110. ソケットで読み取り活動を待つ時間です。
  111. </para>
  112. </listitem>
  113. </itemizedlist>
  114. </sect3>
  115. <sect3 id="zend.queue.adapters.configuration.Db">
  116. <title>Db - Zend_Queue_Adapter_Db</title>
  117. <para>
  118. ドライバオプションは、多少の必須のオプションのためにチェックされます。
  119. (例えば<emphasis>type</emphasis>、<emphasis>host</emphasis>、<emphasis>username</emphasis>、
  120. <emphasis>password</emphasis>と<emphasis>dbname</emphasis>)
  121. <varname>$options['driverOptions']</varname>でパラメータとして、
  122. <methodname>Zend_DB::factory()</methodname>のために付加パラメータに沿って渡すかもしれません。
  123. ここでは一覧に示されていませんが、
  124. 渡すことができる付加的なオプションは<emphasis>port</emphasis>でしょう。
  125. </para>
  126. <programlisting language="php"><![CDATA[
  127. $options = array(
  128. 'driverOptions' => array(
  129. 'host' => 'db1.domain.tld',
  130. 'username' => 'my_username',
  131. 'password' => 'my_password',
  132. 'dbname' => 'messaging',
  133. 'type' => 'pdo_mysql',
  134. 'port' => 3306, // optional parameter.
  135. ),
  136. 'options' => array(
  137. // 更新のためにZend_Db_Selectを使います。
  138. // 全てのデータベースがこのフィーチャをサポートできるわけではありません。
  139. Zend_Db_Select::FOR_UPDATE => true
  140. )
  141. );
  142. // データベース待ち行列を作成
  143. $queue = Zend_Queue::factory('Db', $options);
  144. ]]></programlisting>
  145. <itemizedlist>
  146. <listitem>
  147. <para>
  148. <emphasis>$options['name'] = 'queue1';</emphasis>
  149. </para>
  150. <para>
  151. これは、使い始めたい待ち行列の名前です。(必須)
  152. </para>
  153. </listitem>
  154. <listitem>
  155. <para>
  156. <emphasis>$options['driverOptions']['type'] = 'Pdo';</emphasis>
  157. </para>
  158. <para>
  159. <emphasis>type</emphasis>は、
  160. <methodname>Zend_Db::factory()</methodname>を
  161. 使ってもらいたいアダプタです。
  162. これは、<methodname>Zend_Db::factory()</methodname>
  163. クラス・メソッド呼び出しの最初のパラメータです。
  164. </para>
  165. </listitem>
  166. <listitem>
  167. <para>
  168. <emphasis>$options['driverOptions']['host'] = 'host.domain.tld';</emphasis>
  169. </para>
  170. <para>
  171. <emphasis>$options['driverOptions']['host'] = '127.0.0.1';</emphasis>
  172. </para>
  173. <para>ホストをIPアドレスまたはホスト名にセットするかもしれません。</para>
  174. <para>ホストのデフォルトの設定は '127.0.0.1' です。</para>
  175. </listitem>
  176. <listitem>
  177. <para>
  178. <emphasis>$options['driverOptions']['username'] = 'username';</emphasis>
  179. </para>
  180. </listitem>
  181. <listitem>
  182. <para>
  183. <emphasis>$options['driverOptions']['password'] = 'password';</emphasis>
  184. </para>
  185. </listitem>
  186. <listitem>
  187. <para>
  188. <emphasis>$options['driverOptions']['dbname'] = 'dbname';</emphasis>
  189. </para>
  190. <para>
  191. 必須のテーブルを作成したデータベース名。
  192. 下記の注意部分を見てください。
  193. </para>
  194. </listitem>
  195. </itemizedlist>
  196. </sect3>
  197. <sect3 id="zend.queue.adapters.configuration.memcacheq">
  198. <title>MemcacheQ - Zend_Queue_Adapter_Memcacheq</title>
  199. <itemizedlist>
  200. <listitem>
  201. <para>
  202. <emphasis>$options['name'] = 'queue1';</emphasis>
  203. </para>
  204. <para>
  205. これは、使い始めたい待ち行列の名前です。(必須)
  206. </para>
  207. </listitem>
  208. <listitem>
  209. <para>
  210. <emphasis>$options['driverOptions']['host'] = 'host.domain.tld';</emphasis>
  211. </para>
  212. <para>
  213. <emphasis>$options['driverOptions']['host'] = '127.0.0.1;'</emphasis>
  214. </para>
  215. <para>ホストをIPアドレスまたはホスト名にセットするかもしれません。</para>
  216. <para>ホストのデフォルトの設定は '127.0.0.1' です。</para>
  217. </listitem>
  218. <listitem>
  219. <para>
  220. <emphasis>$options['driverOptions']['port'] = 22201;</emphasis>
  221. </para>
  222. <para>ポートのデフォルトの設定は 22201 です。</para>
  223. </listitem>
  224. </itemizedlist>
  225. </sect3>
  226. <sect3 id="zend.queue.adapters.configuration.array">
  227. <title>配列 - Zend_Queue_Adapter_Array</title>
  228. <itemizedlist>
  229. <listitem>
  230. <para>
  231. <emphasis>$options['name'] = 'queue1';</emphasis>
  232. </para>
  233. <para>
  234. これは、使い始めたい待ち行列の名前です。(必須)
  235. </para>
  236. </listitem>
  237. </itemizedlist>
  238. </sect3>
  239. </sect2>
  240. <sect2 id="zend.queue.adapters.notes">
  241. <title>アダプタ固有の注意</title>
  242. <para>下記のアダプタには注意があります:</para>
  243. <sect3 id="zend.queue.adapters.notes.activemq">
  244. <title>ActiveMQ</title>
  245. <para>
  246. <classname>Zend_Queue_Adapter_ActiveMQ</classname>のための可視性期間は利用できません。
  247. </para>
  248. <para>
  249. ApacheのActiveMQが複数のサブスクリプションをサポートするのに対して、
  250. <classname>Zend_Queue</classname>はそうしません。
  251. それぞれのサブスクリプションのために
  252. 新しい<classname>Zend_Queue</classname>オブジェクトを作成しなければなりません。
  253. </para>
  254. <para>
  255. ActiveMQの待ち行列または項目の名前は下記のうちの一つで始めなくてはいけません:
  256. </para>
  257. <itemizedlist>
  258. <listitem>
  259. <para>
  260. <filename>/queue/</filename>
  261. </para>
  262. </listitem>
  263. <listitem>
  264. <para>
  265. <filename>/topic/</filename>
  266. </para>
  267. </listitem>
  268. <listitem>
  269. <para>
  270. <filename>/temp-queue/</filename>
  271. </para>
  272. </listitem>
  273. <listitem>
  274. <para>
  275. <filename>/temp-topic/</filename>
  276. </para>
  277. </listitem>
  278. </itemizedlist>
  279. <para>
  280. 例えば: <filename>/queue/testing</filename>
  281. </para>
  282. <para>
  283. 下記の関数はサポートされません:
  284. </para>
  285. <itemizedlist>
  286. <listitem>
  287. <para>
  288. <methodname>create()</methodname> - 待ち行列の作成。
  289. この関数を呼ぶと例外を発生します。
  290. </para>
  291. </listitem>
  292. <listitem>
  293. <para>
  294. <methodname>delete()</methodname> - 待ち行列の削除。
  295. この関数を呼ぶと例外を発生します。
  296. </para>
  297. </listitem>
  298. <listitem>
  299. <para>
  300. <methodname>getQueues()</methodname> - 待ち行列の一覧。
  301. この関数を呼ぶと例外を発生します。
  302. </para>
  303. </listitem>
  304. </itemizedlist>
  305. </sect3>
  306. <sect3 id="zend.queue.adapters.notes.zend_db">
  307. <title>Zend_Db</title>
  308. <para>
  309. データベース<emphasis>CREATE TABLE ( ... )</emphasis> <acronym>SQL</acronym>
  310. 文が<filename>Zend/Queue/Adapter/Db/queue.sql</filename>にあります。
  311. </para>
  312. </sect3>
  313. <sect3 id="zend.queue.adapters.notes.memcacheQ">
  314. <title>MemcacheQ</title>
  315. <para>
  316. Memcacheは<ulink
  317. url="http://www.danga.com/memcached/">http://www.danga.com/memcached/</ulink>
  318. からダウンロードできます。
  319. </para>
  320. <para>
  321. MemcacheQは<ulink
  322. url="http://memcachedb.org/memcacheq/">http://memcachedb.org/memcacheq/</ulink>
  323. からダウンロードできます。
  324. </para>
  325. <itemizedlist>
  326. <listitem>
  327. <para>
  328. <methodname>deleteMessage()</methodname> -
  329. メッセージは、待ち行列から受信と同時に削除されます。
  330. この関数を呼んでも効果がありません。
  331. この関数を呼ぶとエラーを発生します。
  332. </para>
  333. </listitem>
  334. <listitem>
  335. <para>
  336. <methodname>count()</methodname>または<methodname>count($adapter)</methodname>
  337. - MemcacheQは、待ち行列で件数を数えるためのメソッドをサポートしません。
  338. この関数を呼ぶとエラーを発生します。
  339. </para>
  340. </listitem>
  341. </itemizedlist>
  342. </sect3>
  343. <sect3 id="zend.queue.adapters.notes.array">
  344. <title>配列 (内部)</title>
  345. <para>
  346. 配列待ち行列はローカルメモリ上の<acronym>PHP</acronym> <methodname>array()</methodname>です。
  347. <classname>Zend_Queue_Adapter_Array</classname>はユニットテスト用に適しています。
  348. </para>
  349. </sect3>
  350. </sect2>
  351. </sect1>