This is Webservice SDK for mbed. LPCXpresso1769/LPC1768/FRDM-K64F/LPC4088
Dependents: MbedFileServer_1768MiniDK2 RedWireBridge IssueDebug_gcc MiMicRemoteMCU-for-Mbed ... more
NyLPC_cIPv4.h File Reference
このファイルは、NyLPC_cIPv4IPv4クラスを定義します。 More...
Go to the source code of this file.
Data Structures | |
struct | NyLPC_TcIPv4 |
NyLPC_TcIPv4クラスの構造体です。 More... | |
Functions | |
void | NyLPC_cIPv4_initialize (NyLPC_TcIPv4_t *i_inst) |
コンストラクタです。インスタンスを初期化します。 | |
void | NyLPC_cIPv4_finalize (NyLPC_TcIPv4_t *i_inst) |
デストラクタです。インスタンスを破棄して、確保している動的リソースを元に戻します。 | |
void | NyLPC_cIPv4_start (NyLPC_TcIPv4_t *i_inst, const NyLPC_TcIPv4Config_t *i_ref_configlation) |
この関数は、インスタンスにTCP/IP処理の準備をするように伝えます。 | |
void | NyLPC_cIPv4_stop (NyLPC_TcIPv4_t *i_inst) |
この関数はTCP/IP処理を停止することを伝えます。 | |
void * | NyLPC_cIPv4_rx (NyLPC_TcIPv4_t *i_inst, const void *i_rx, NyLPC_TUInt16 i_rx_size) |
この関数は、RxIPパケットを処理して、管理下のインスタンスに処理を依頼します。 現在の関数は、i_rxに最大64バイトの応答パケットのイメージを格納することがあります。 応答パケットは、RXに対するACKパケットです。 格納の有無は戻り値を確認することで判ります。 この関数はstart-stopの間だけコールすることが出来ます。start,stopと非同期に実行しないでください。 | |
void | NyLPC_cIPv4_periodec (NyLPC_TcIPv4_t *i_inst) |
この関数は、定期的にインスタンスへ実行機会を与える関数です。 TCPの再送、無通信タイムアウトなどを処理します。 約1秒おきに呼び出してください。 | |
NyLPC_TUInt16 | NyLPC_cIPv4_getNewPortNumber (NyLPC_TcIPv4_t *i_inst) |
ポート0で使用するポート番号を返します。 |
Detailed Description
このファイルは、NyLPC_cIPv4IPv4クラスを定義します。
Definition in file NyLPC_cIPv4.h.
Function Documentation
void NyLPC_cIPv4_finalize | ( | NyLPC_TcIPv4_t * | i_inst ) |
デストラクタです。インスタンスを破棄して、確保している動的リソースを元に戻します。
- Parameters:
-
i_inst 破棄するインスタンス initializeが成功したインスタンスだけが指定できます。
Definition at line 104 of file NyLPC_cIPv4.c.
NyLPC_TUInt16 NyLPC_cIPv4_getNewPortNumber | ( | NyLPC_TcIPv4_t * | i_inst ) |
ポート0で使用するポート番号を返します。
- Returns:
- 49152 - (49152+0x0ffff)番までのポートのうち、使用中でないポート番号を返します。 エラー時は0です。
Definition at line 191 of file NyLPC_cIPv4.c.
void NyLPC_cIPv4_initialize | ( | NyLPC_TcIPv4_t * | i_inst ) |
void NyLPC_cIPv4_periodec | ( | NyLPC_TcIPv4_t * | i_inst ) |
この関数は、定期的にインスタンスへ実行機会を与える関数です。 TCPの再送、無通信タイムアウトなどを処理します。 約1秒おきに呼び出してください。
- Parameters:
-
i_inst 操作するインスタンスです。
Definition at line 145 of file NyLPC_cIPv4.c.
void* NyLPC_cIPv4_rx | ( | NyLPC_TcIPv4_t * | i_inst, |
const void * | i_rx, | ||
NyLPC_TUInt16 | i_rx_size | ||
) |
この関数は、RxIPパケットを処理して、管理下のインスタンスに処理を依頼します。 現在の関数は、i_rxに最大64バイトの応答パケットのイメージを格納することがあります。 応答パケットは、RXに対するACKパケットです。 格納の有無は戻り値を確認することで判ります。 この関数はstart-stopの間だけコールすることが出来ます。start,stopと非同期に実行しないでください。
- Parameters:
-
i_inst 操作するインスタンスです。 i_rx RXパケットを格納したメモリアドレスです。 最低でも、64バイト以上のサイズが必要です。 i_rx_size i_rxに格納したデータのサイズです。
- Returns:
- 応答パケットを格納したメモリです。
この関数は、RxIPパケットを処理して、管理下のインスタンスに処理を依頼します。 現在の関数は、i_rxに最大64バイトの応答パケットのイメージを格納することがあります。 応答パケットは、RXに対するACKパケットです。 格納の有無は戻り値を確認することで判ります。 この関数はstart-stopの間だけコールすることが出来ます。start,stopと非同期に実行しないでください。
- Parameters:
-
i_rx 先頭ポインタ。
- Returns:
- TRUEなら、i_rxに応答パケットをセットして返します。
Definition at line 159 of file NyLPC_cIPv4.c.
void NyLPC_cIPv4_start | ( | NyLPC_TcIPv4_t * | i_inst, |
const NyLPC_TcIPv4Config_t * | i_ref_configlation | ||
) |
この関数は、インスタンスにTCP/IP処理の準備をするように伝えます。
- Parameters:
-
i_inst 操作するインスタンス i_ref_configlation IPの環境値をセットしたオブジェクトを指定します。 この値は、stop関数を実行するまでの間、維持してください。
Definition at line 115 of file NyLPC_cIPv4.c.
void NyLPC_cIPv4_stop | ( | NyLPC_TcIPv4_t * | i_inst ) |
この関数はTCP/IP処理を停止することを伝えます。
- Parameters:
-
i_inst 操作するインスタンス。 startで開始済みで無ければなりません。
- Note:
- 現在、接続中の接続に対する保障は未実装です。安全に使用することが出来ません。
Definition at line 130 of file NyLPC_cIPv4.c.
Generated on Tue Jul 12 2022 15:46:17 by 1.7.2