File: CTCP.html

package info (click to toggle)
tiarra 20100212-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 2,732 kB
  • ctags: 1,712
  • sloc: perl: 32,032; lisp: 193; sh: 109; makefile: 10
file content (218 lines) | stat: -rw-r--r-- 8,831 bytes parent folder | download | duplicates (4)
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
	  PUBLIC "-//W3C//DTD XHTML 1.1//EN"
	  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<!-- $Id: contents.html 11393 2008-05-11 06:56:12Z topia $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>CTCP 関係のモジュール - Tiarra Documentation</title>
    <link rel="stylesheet" type="text/css" href="../default.css" />
  </head>
  <body>
    <div class="header">
      <h1>CTCP 関係のモジュール</h1>
    </div>

    <hr class="sep" />

    <div class="pane-main">
      
      <div id="module-CTCP::ClientInfo" class="module">
        <div class="module-header"><h2 title="CTCP CLIENTINFOに応答する。">CTCP::ClientInfo</h2>
          <span class="description">CTCP CLIENTINFOに応答する。</span></div>
        <div class="content">
	  <p class="comment">
CTCP::Versionのintervalと同じ。<br />
</p>
<div class="element"><span class="key">interval</span>:<span class="value">3</span></div>

        </div>
      </div>

      
      <hr class="sep" />
      
      
      <div id="module-CTCP::DCC::RewriteAddress" class="module">
        <div class="module-header"><h2 title="クライアントが送信した CTCP DCC のアドレスを変換する。">CTCP::DCC::RewriteAddress</h2>
          <span class="description">クライアントが送信した CTCP DCC のアドレスを変換する。</span></div>
        <div class="content">
	  <p class="comment">
&nbsp;CTCP DCC に指定されているアドレスを、 Tiarra で取得したものに<br />
&nbsp;書き換えます。(EXPERIMENTAL)<br />
<br />
&nbsp;IPv4 のみサポートしています。<br />
<br />
&nbsp;このモジュールは一旦 CTCP DCC メッセージを破棄するので、<br />
&nbsp;別のクライアントには送信されません。<br />
</p>
<p class="comment">
変換する DCC タイプ。 [デフォルト値: CHAT SEND]<br />
</p>
<div class="element"><span class="key">type</span>:<span class="value">CHAT SEND</span></div>
<p class="comment">
変換用アドレスの取得方法を選択する。デフォルト値はありません。<br />
以下の取得方法(server-socket client-socket dns http)から<br />
必要なもの(複数可)を指定してください。<br />
</p>
<div class="element"><span class="key">resolver</span>:<span class="value">client-socket server-socket dns http</span></div>
<p class="comment">
取得方法と設定<br />
なにも設定がないときはブロック自体を省略することもできます。<br />
</p>
<div class="block element"><span class="block key">server-socket</span>
<div class="block content">
<p class="comment">
サーバソケットのローカルアドレスを取ります。<br />
client &lt;-&gt; tiarra[this address] &lt;-&gt; server<br />
</p>
</div></div>
<div class="block element"><span class="block key">client-socket</span>
<div class="block content">
<p class="comment">
クライアントソケットのリモートアドレスを取ります。<br />
client [this address]&lt;-&gt; Tiarra &lt;-&gt; server<br />
</p>
</div></div>
<div class="block element"><span class="block key">dns</span>
<div class="block content">
<p class="comment">
DNS を引いて決定します。IPアドレスの指定も可能です。<br />
</p>
<div class="element"><span class="key">host</span>:<span class="value">example.com</span></div>
</div></div>
<div class="block element"><span class="block key">http</span>
<div class="block content">
<p class="comment">
現状では単純な GET しかサポートしていません。<br />
</p>
<p class="comment">
アクセス先 URL<br />
</p>
<div class="element"><span class="key">url</span>:<span class="value">http://checkip.dyndns.org/</span></div>
<p class="comment">
IP アドレス取得用 regex<br />
</p>
<div class="element"><span class="key">regex</span>:<span class="value">Current IP Address: (\d+\.\d+\.\d+\.\d+)</span></div>
</div></div>
<p class="comment">
&nbsp;リゾルバの選び方<br />
<br />
&nbsp;&nbsp;* Tiarra を動作させているサーバとインターネットの間にルータ等があり、<br />
&nbsp;&nbsp;&nbsp;&nbsp;グローバルアドレスがない場合<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*-socket は役に立ちません。 http を利用してください。<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;適当な DDNS を持っていればdns も良いでしょう。<br />
<br />
&nbsp;&nbsp;* Tiarra がレンタルサーバなどLAN上にないサーバで動作している場合<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server-socket, http は役に立ちません。<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;client-socket がお勧めです。<br />
<br />
&nbsp;&nbsp;* Tiarra がLAN上にあり、グローバルアドレスのついているホストで<br />
&nbsp;&nbsp;&nbsp;&nbsp;動作している場合<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;client-socket は役に立ちません。<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server-socket がお勧めです。<br />
</p>

        </div>
      </div>

      
      <hr class="sep" />
      
      
      <div id="module-CTCP::Ping" class="module">
        <div class="module-header"><h2 title="CTCP PINGに応答する。">CTCP::Ping</h2>
          <span class="description">CTCP PINGに応答する。</span></div>
        <div class="content">
	  <p class="comment">
CTCP::Versionのintervalと同じ。<br />
</p>
<div class="element"><span class="key">interval</span>:<span class="value">3</span></div>

        </div>
      </div>

      
      <hr class="sep" />
      
      
      <div id="module-CTCP::Time" class="module">
        <div class="module-header"><h2 title="CTCP TIMEに応答する。">CTCP::Time</h2>
          <span class="description">CTCP TIMEに応答する。</span></div>
        <div class="content">
	  <p class="comment">
CTCP::Versionのintervalと同じ。<br />
</p>
<div class="element"><span class="key">interval</span>:<span class="value">3</span></div>

        </div>
      </div>

      
      <hr class="sep" />
      
      
      <div id="module-CTCP::UserInfo" class="module">
        <div class="module-header"><h2 title="CTCP USERINFOに応答する。">CTCP::UserInfo</h2>
          <span class="description">CTCP USERINFOに応答する。</span></div>
        <div class="content">
	  <p class="comment">
CTCP::Versionのintervalと同じ。<br />
</p>
<div class="element"><span class="key">interval</span>:<span class="value">3</span></div>
<p class="comment">
USERINFOとして返すメッセージ。<br />
</p>
<div class="element"><span class="key">message</span>:<span class="value">テスト</span></div>

        </div>
      </div>

      
      <hr class="sep" />
      
      
      <div id="module-CTCP::Version" class="module">
        <div class="module-header"><h2 title="CTCP VERSIONに応答する。">CTCP::Version</h2>
          <span class="description">CTCP VERSIONに応答する。</span></div>
        <div class="content">
	  <p class="comment">
&nbsp;連続したCTCPリクエストに対する応答の間隔。単位は秒。<br />
&nbsp;例えば3秒に設定した場合、一度応答してから3秒間は<br />
&nbsp;CTCPに一切応答しなくなる。デフォルトは3。<br />
<br />
&nbsp;なお、CTCP受信時刻の記録は、全てのCTCPモジュールで共有される。<br />
&nbsp;例えばCTCP VERSIONを送った直後にCTCP CLIENTINFOを送ったとしても、<br />
&nbsp;CTCP::ClientInfoのintervalで設定された時間を過ぎていなければ<br />
&nbsp;後者は応答しない。<br />
</p>
<div class="element"><span class="key">interval</span>:<span class="value">3</span></div>

        </div>
      </div>

      
      
    </div>

    <div class="pane-sidebar">
      <ul class="menu">
        
        <li><a href="#module-CTCP::ClientInfo" title="CTCP CLIENTINFOに応答する。">CTCP::ClientInfo</a></li>
        
        <li><a href="#module-CTCP::DCC::RewriteAddress" title="クライアントが送信した CTCP DCC のアドレスを変換する。">CTCP::DCC::RewriteAddress</a></li>
        
        <li><a href="#module-CTCP::Ping" title="CTCP PINGに応答する。">CTCP::Ping</a></li>
        
        <li><a href="#module-CTCP::Time" title="CTCP TIMEに応答する。">CTCP::Time</a></li>
        
        <li><a href="#module-CTCP::UserInfo" title="CTCP USERINFOに応答する。">CTCP::UserInfo</a></li>
        
        <li><a href="#module-CTCP::Version" title="CTCP VERSIONに応答する。">CTCP::Version</a></li>
        
        <li><a href="../module-toc.html">モジュール一覧に戻る</a></li>
      </ul>
    </div>
  </body>
</html>