lib/src/uip/NyLPC_cUdpSocket_protected.h

   1 /*\r
   2  * NyLPC_cUdpSocket.h\r
   3  *\r
   4  *  Created on: 2013/05/20\r
   5  *      Author: nyatla\r
   6  */\r
   7 \r
   8 #ifndef NYLPC_CUDPSOCKET_PROTECTED_H_\r
   9 #define NYLPC_CUDPSOCKET_PROTECTED_H_\r
  10 #include "NyLPC_cUdpSocket.h"\r
  11 #include "NyLPC_cIPv4Payload.h"\r
  12 #include "NyLPC_cIPv4Config.h"\r
  13 \r
  14 #ifdef __cplusplus\r
  15 extern "C" {\r
  16 #endif /* __cplusplus */\r
  17 \r
  18 \r
  19 /**\r
  20  * この関数は、rxパケットを処理して、ソケットの状態を更新します。\r
  21  * uipサービスタスクが実行する関数です。\r
  22  */\r
  23 NyLPC_TBool NyLPC_cUdpSocket_parseRx(\r
  24         NyLPC_TcUdpSocket_t* i_inst,\r
  25         const NyLPC_TcIPv4Payload_t* i_ipp);\r
  26 \r
  27 /**\r
  28  * uipサービスタスクが実行する関数です。\r
  29  * サービスの開始を通知します。\r
  30  * この関数は他のAPIが非同期に実行されないことが保証される状況で使用する必要があります。\r
  31  */\r
  32 void NyLPC_cUdpSocket_startService(NyLPC_TcUdpSocket_t* i_inst,const NyLPC_TcIPv4Config_t* i_config);\r
  33 \r
  34 /**\r
  35  * uipサービスタスクが実行する関数です。\r
  36  * サービスの停止を通知します。\r
  37  * この関数は他のAPIが非同期に実行されないことが保証される状況で使用する必要があります。\r
  38  */\r
  39 void NyLPC_cUdpSocket_stopService(NyLPC_TcUdpSocket_t* i_inst);\r
  40 \r
  41 \r
  42 /**\r
  43  * 定期的に実行する関数。最低でも1s単位で実行してください。\r
  44  * uipサービスタスクが実行する関数です。\r
  45  */\r
  46 #define NyLPC_cUdpSocket_periodic(i_inst) if((i_inst)->as_handler.periodic!=NULL){(i_inst)->as_handler.periodic(i_inst);}\r
  47 \r
  48 #ifdef __cplusplus\r
  49 }\r
  50 #endif /* __cplusplus */\r
  51 \r
  52 \r
  53 #endif /* NYLPC_CUDPSOCKET_H_ */\r