NyLPC_cMiMicIpUdpSocket_protected.h

00001 /*
00002  * NyLPC_cUdpSocket.h
00003  *
00004  *  Created on: 2013/05/20
00005  *      Author: nyatla
00006  */
00007 
00008 #ifndef NYLPC_CUDPSOCKET_PROTECTED_H_
00009 #define NYLPC_CUDPSOCKET_PROTECTED_H_
00010 #include "NyLPC_cMiMicIpUdpSocket.h"
00011 #include "NyLPC_cIPv4Payload.h"
00012 #include "../NyLPC_cIPv4Config.h"
00013 
00014 #ifdef __cplusplus
00015 extern "C" {
00016 #endif /* __cplusplus */
00017 
00018 
00019 
00020 
00021 
00022 /**
00023  * この関数は、rxパケットを処理して、ソケットの状態を更新します。
00024  * uipサービスタスクが実行する関数です。
00025  */
00026 NyLPC_TBool NyLPC_cMiMicIpUdpSocket_parseRx(
00027     NyLPC_TcMiMicIpUdpSocket_t* i_inst,
00028     const NyLPC_TcIPv4Payload_t* i_ipp);
00029 
00030 /**
00031  * uipサービスタスクが実行する関数です。
00032  * サービスの開始を通知します。
00033  * この関数は他のAPIが非同期に実行されないことが保証される状況で使用する必要があります。
00034  */
00035 void NyLPC_cMiMicIpUdpSocket_startService(NyLPC_TcMiMicIpUdpSocket_t* i_inst,const NyLPC_TcIPv4Config_t* i_config);
00036 
00037 /**
00038  * uipサービスタスクが実行する関数です。
00039  * サービスの停止を通知します。
00040  * この関数は他のAPIが非同期に実行されないことが保証される状況で使用する必要があります。
00041  */
00042 void NyLPC_cMiMicIpUdpSocket_stopService(NyLPC_TcMiMicIpUdpSocket_t* i_inst);
00043 
00044 
00045 /**
00046  * 定期的に実行する関数。最低でも1s単位で実行してください。
00047  * uipサービスタスクが実行する関数です。
00048  */
00049 #define NyLPC_cMiMicIpUdpSocket_periodic(i_inst) if((i_inst)->as_handler.periodic!=NULL){(i_inst)->as_handler.periodic((NyLPC_TiUdpSocket_t*)(i_inst));}
00050 #ifdef __cplusplus
00051 }
00052 #endif /* __cplusplus */
00053 
00054 
00055 #endif /* NYLPC_CUDPSOCKET_H_ */
00056