Skip to content

Commit f59d19b

Browse files
authored
Merge pull request dist-sys#7 from dist-sys/update_document_v0.6.1
Update document v0.6.1
2 parents e390731 + aabed93 commit f59d19b

15 files changed

+200
-6
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@ It supports both MQTT v5.0 and v3.1.1.
55
- [Usage (English)](https://github.com/dist-sys/mqttloader/blob/master/doc/usage_en.md)
66
- [Usage (Japanese)](https://github.com/dist-sys/mqttloader/blob/master/doc/usage_jp.md)
77

8+
MQTTLoader is licensed under the Apache License, Version2.0.
9+
810
## Contact
911
https://www.banno-lab.net/en/contact/

doc/usage_en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ To build MQTTLoader, JDK and Gradle with the following versions are required.
181181

182182
Older versions might work, but are not tested.
183183

184-
## 5-b. Download
184+
### 5-b. Download
185185
Clone the MQTTLoader repository from GitHub: `$ git clone [email protected]:dist-sys/mqttloader.git`
186186
The structure of the directories/files is as follows:
187187

@@ -196,7 +196,7 @@ mqttloader
196196

197197
Hereafter, the name of the root directory, where the file `build.gradle` exists, is denoted as *\<ROOT_DIR\>*.
198198

199-
## 5-c. Build
199+
### 5-c. Build
200200
Open a terminal software (e.g., xterm, command prompt, etc.) and you can build by the following Gradle command.
201201
```
202202
$ cd <ROOT_DIR>
@@ -215,7 +215,7 @@ You can find *distributions* directory under the *build* directory.
215215
```
216216
By extracting the archive file (tar or zip), you can get the binary files of MQTTLoader.
217217

218-
## 5-d. Run MQTTLoader with Gradle
218+
### 5-d. Run MQTTLoader with Gradle
219219
You can run MQTTLoader by using Gradle command.
220220

221221
In *\<ROOT_DIR\>/build.gradle*, the execution parameters are stated in the following part:

doc/usage_jp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ MQTTLoaderのビルドには、以下バージョンのJDKとGradleが必要で
184184

185185
上記より前のバージョンでの動作は未確認です。
186186

187-
## 5-b. ダウンロード
187+
### 5-b. ダウンロード
188188
GitHubからクローンしてください: `$ git clone [email protected]:dist-sys/mqttloader.git`
189189
リポジトリのディレクトリ構造は下記のようになっています。
190190

@@ -199,7 +199,7 @@ mqttloader
199199

200200
以降、ルートディレクトリ(`build.gradle`が置いてあるディレクトリ)を *\<ROOT_DIR\>* と表記します。
201201

202-
## 5-c. ビルド
202+
### 5-c. ビルド
203203
ターミナル(xterm、コマンドプロンプト等)で以下のように *\<ROOT_DIR\>* に移動してコマンドを打つことで、ビルドできます。
204204

205205
```
@@ -219,7 +219,7 @@ $ gradle build
219219

220220
*distributions* ディレクトリに入っているアーカイブファイル(tar または zip)を解凍することで、MQTTLoaderのバイナリが得られます。
221221

222-
## 5-d. GradleによるMQTTLoaderの実行
222+
### 5-d. GradleによるMQTTLoaderの実行
223223
Gradleコマンドを使ってMQTTLoaderを実行することもできます。
224224

225225
*\<ROOT_DIR\>/build.gradle* 内の以下の箇所に、実行時オプションが記述されています。

src/main/java/mqttloader/Constants.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2020 Distributed Systems Group
3+
*
4+
* <p>Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* <p>http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* <p>Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
package mqttloader;
218

319
public class Constants {

src/main/java/mqttloader/Loader.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2020 Distributed Systems Group
3+
*
4+
* <p>Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* <p>http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* <p>Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
package mqttloader;
218

319
import static mqttloader.Constants.Opt;

src/main/java/mqttloader/LogFormatter.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2020 Distributed Systems Group
3+
*
4+
* <p>Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* <p>http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* <p>Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
package mqttloader;
218

319
import java.text.SimpleDateFormat;

src/main/java/mqttloader/RecvTimeoutTask.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2020 Distributed Systems Group
3+
*
4+
* <p>Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* <p>http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* <p>Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
package mqttloader;
218

319
import static mqttloader.Loader.countDownLatch;

src/main/java/mqttloader/Util.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2020 Distributed Systems Group
3+
*
4+
* <p>Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* <p>http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* <p>Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
package mqttloader;
218

319
import java.io.BufferedWriter;

src/main/java/mqttloader/client/IClient.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2020 Distributed Systems Group
3+
*
4+
* <p>Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* <p>http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* <p>Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
package mqttloader.client;
218

319
import java.util.ArrayList;

src/main/java/mqttloader/client/Publisher.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2020 Distributed Systems Group
3+
*
4+
* <p>Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* <p>http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* <p>Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
package mqttloader.client;
218

319
import static mqttloader.Constants.PUB_CLIENT_ID_PREFIX;

0 commit comments

Comments
 (0)