File: muscat.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (140 lines) | stat: -rw-r--r-- 4,736 bytes parent folder | download
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
133
134
135
136
137
138
139
140
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
 <reference id="ref.muscat">
  <title>muscat関数</title>
  <titleabbrev>muscat関数</titleabbrev>

  <partintro>
   <para>
   </para>
  </partintro>

  <refentry id="function.muscat-setup">
   <refnamediv>
    <refname>muscat_setup</refname>
    <refpurpose>muscatセッションを新規に作成し、ハンドルを返す</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>resource</type><methodname>muscat_setup</methodname>
      <methodparam><type>int</type><parameter>size</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>muscat_dir</parameter></methodparam>
     </methodsynopsis>
     &warn.experimental.func;
    <para>
     muscatセッションを新規に作成し、ハンドルを返します。
     <parameter>size</parameter>はmuscat用に確保するメモリサイズです。
     <parameter>muscat_dir</parameter>は、muscatのインストールディレク
     トリで、例えば、"/usr/local/empower"となります。デフォルトは、コ
     ンパイル時のmuscatディレクトリです。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.muscat-setup-net">
   <refnamediv>
    <refname>muscat_setup_net</refname>
    <refpurpose>新規muscatセッションを作成しハンドルを返す</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>resource</type><methodname>muscat_setup_net</methodname>
      <methodparam><type>string</type><parameter>muscat_host</parameter></methodparam>
      <methodparam><type>int</type><parameter>port</parameter></methodparam>
     </methodsynopsis>
     &warn.experimental.func;
    <para>
     新規 muscatセッションを作成しハンドルを返します。
     <parameter>muscat_host</parameter>は接続先のホスト名、
     <parameter>port</parameter>は接続先のポート番号です。
     引数の仕様は、fsockopenと全く同じです。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.muscat-give">
   <refnamediv>
    <refname>muscat_give</refname>
    <refpurpose>コアmuscat APIに文字列を送信する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>muscat_give</methodname>
      <methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
      <methodparam><type>string</type><parameter>string</parameter></methodparam>
     </methodsynopsis>
     &warn.experimental.func;
    <para>
     &warn.undocumented.func;
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.muscat-get">
   <refnamediv>
    <refname>muscat_get</refname>
    <refpurpose>コアmuscat APIから1行分のデータを取得する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>muscat_get</methodname>
      <methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
     </methodsynopsis>
     &warn.experimental.func;
    <para>
     コアmuscat APIから1行分のデータを取得します。取得するデータがない
     場合には、(""の替わりに)リテラル&false;を返します。これを確認するに
     は、=== FALSE または !== FALSE を使用して下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.muscat-close">
   <refnamediv>
    <refname>muscat_close</refname>
    <refpurpose>
     muscatセッションをシャットダウンし、全てのメモリをPHPに解放する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>muscat_close</methodname>
      <methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
     </methodsynopsis>
     &warn.experimental.func;
    <para>
     muscatセッションをシャットダウンし、全てのメモリをPHPに解放します。
     解放したメモリをシステムに返すわけではないことに注意して下さい。
    </para>
   </refsect1>
  </refentry>

 </reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->