「ping（内部関数説明）」の編集履歴（バックアップ）一覧に戻る

ping（内部関数説明） - (2007/01/26 (金) 21:38:33) のソース

* ping内の各関数について
まずは「[[ping]] XXX.XXX.XXX.XXX」の形で実行し、そのとき呼ばれる関数についてそれぞれ具体的なインタフェース・処理内容を記述します。

記述ルールはmanの結果と同じです([[例>http://www.linux.or.jp/JM/html/LDP_man-pages/man2/socket.2.html]])。ただしmanのように外部仕様だけ書くのではなく、内部の処理内容についても記述するようにしてください。

* 関数詳細
** main()
***概要
|ファイル|ping/ping.c|
|引数|int argc：コマンドオプションの個数|
||char** argv：コマンドに渡された文字列|
|返戻値|関数ポインタ変数ping_typeの返戻値に依存|
|説明|pingコマンドのエントリポイント。コマンドの解析を行い、必要な関数を起動する。|

***説明
<どういう処理を行っているかを記述します>

***副作用
<本関数内で変更されるグローバル変数と変更理由、送信されるパケットの内容など、外部に影響を与える処理があれば記述します>

** init_data_buffer()
***概要
|ファイル||
|引数|<各引数>|
|返戻値||
|説明|<簡単な説明を書いてください>|

***説明
<どういう処理を行っているかを記述します>

***副作用
<本関数内で変更されるグローバル変数と変更理由、送信されるパケットの内容など、外部に影響を与える処理があれば記述します>

** ping_echo()
***概要
|ファイル||
|引数|<各引数>|
|返戻値||
|説明|<簡単な説明を書いてください>|

***説明
<どういう処理を行っているかを記述します>

***副作用
<本関数内で変更されるグローバル変数と変更理由、送信されるパケットの内容など、外部に影響を与える処理があれば記述します>

** ping_run()
***概要
|ファイル||
|引数|<各引数>|
|返戻値||
|説明|<簡単な説明を書いてください>|

***説明
<どういう処理を行っているかを記述します>

***副作用
<本関数内で変更されるグローバル変数と変更理由、送信されるパケットの内容など、外部に影響を与える処理があれば記述します>

** send_echo()
***概要
|ファイル||
|引数|<各引数>|
|返戻値||
|説明|<簡単な説明を書いてください>|

***説明
<どういう処理を行っているかを記述します>

***副作用
<本関数内で変更されるグローバル変数と変更理由、送信されるパケットの内容など、外部に影響を与える処理があれば記述します>

** sig_int()
***概要
|ファイル||
|引数|<各引数>|
|返戻値||
|説明|<簡単な説明を書いてください>|

***説明
<どういう処理を行っているかを記述します>

***副作用
<本関数内で変更されるグローバル変数と変更理由、送信されるパケットの内容など、外部に影響を与える処理があれば記述します>