lib/src/net/upnp/NyLPC_cSsdpSocket.h

   1 /*\r
   2  * NyLPC_cSsdpSocket.h\r
   3  *\r
   4  *  Created on: 2013/07/26\r
   5  *      Author: nyatla\r
   6  */\r
   7 \r
   8 #ifndef NYLPC_CSSDPSOCKET_H_\r
   9 #define NYLPC_CSSDPSOCKET_H_\r
  10 #include "NyLPC_netif.h"\r
  11 #include "NyLPC_UPnP_types.h"\r
  12 \r
  13 #ifdef __cplusplus\r
  14 extern "C" {\r
  15 #endif /* __cplusplus */\r
  16 \r
  17 /**\r
  18  * DeviceDescriptionに含まれる最大デバイス数\r
  19  */\r
  20 #define NyLPC_TcSsdpSocket_MAX_DEVICES 5\r
  21 \r
  22 /**\r
  23  * @bug\r
  24  * TTLが64(4であるべき)\r
  25  */\r
  26 typedef struct NyLPC_TcSsdpSocket NyLPC_TcSsdpSocket_t;\r
  27 \r
  28 struct NyLPC_TcSsdpSocket\r
  29 {\r
  30         NyLPC_TiUdpSocket_t* _socket;\r
  31         NyLPC_TcStopwatch_t _periodic_sw;\r
  32         /**\r
  33          * locationパス\r
  34          */\r
  35         const NyLPC_TChar* location_path;\r
  36         /**\r
  37          * DeviceDescriptionをホストするサーバアドレス\r
  38          */\r
  39         NyLPC_TUInt16 location_port;\r
  40         NyLPC_TUInt8 number_of_device;\r
  41         /**\r
  42          * bit0:SSDPサービスの開始要求\r
  43          * bit1:SSDPサービスの停止要求\r
  44          * bit2:SSDPサービスの実行状態(1:start,0:stop)\r
  45          */\r
  46          volatile NyLPC_TUInt8 _flags;\r
  47         /**\r
  48          * デバイスレコードの配列へのポインタ。\r
  49          * この値は、initialize関数でセットされたrootdeviceを水平展開したものです。\r
  50          * 0番目のレコードはルートデバイスです。\r
  51          */\r
  52         const struct NyLPC_TUPnPDevDescDevice* ref_device_record[NyLPC_TcSsdpSocket_MAX_DEVICES];\r
  53 };\r
  54 \r
  55 /**\r
  56  * DeviceRecordを参照したSSDPソケットインスタンスを生成します。\r
  57  * この関数はuipServiceが開始する前に実行してください。\r
  58  * @param　i_inst\r
  59  * @param i_ref_dev_record\r
  60  * 0番目のデバイスがルートデバイス、以降は embeddedデバイスになります。\r
  61  * このオブジェクトはインスタンスが破棄されるまでの間維持してください。\r
  62  * @param i_number_of_devices\r
  63  * @param i_server_port\r
  64  * @param i_ref_location_path\r
  65  * deviceDescriptionのホストパスを設定します。\r
  66  * 例えば"upnp"の場合、locationはhttp://[:ip:]:[:port:]/upnp/ddesc.xmlとなります。\r
  67  */\r
  68 void NyLPC_cSsdpSocket_initialize(\r
  69                 NyLPC_TcSsdpSocket_t* i_inst,\r
  70                 const struct NyLPC_TUPnPDevDescDevice* i_ref_dev_record,\r
  71                 NyLPC_TUInt16 i_server_port,const NyLPC_TChar* i_ref_location_path);\r
  72 \r
  73 void NyLPC_cSsdpSocket_finalize(NyLPC_TcSsdpSocket_t* i_inst);\r
  74 /**\r
  75  * SSDPサービスを開始します。\r
  76  */\r
  77 void NyLPC_cSsdpSocket_start(NyLPC_TcSsdpSocket_t* i_inst);\r
  78 /**\r
  79  * SSDPサービスを停止します。\r
  80  */\r
  81 void NyLPC_cSsdpSocket_stop(NyLPC_TcSsdpSocket_t* i_inst);\r
  82 \r
  83 \r
  84 #ifdef __cplusplus\r
  85 }\r
  86 #endif /* __cplusplus */\r
  87 \r
  88 \r
  89 \r
  90 \r
  91 \r
  92 \r
  93 \r
  94 \r
  95 \r
  96 \r
  97 \r
  98 \r
  99 \r
 100 #endif /* NYLPC_CSSDPSOCKET_H_ */\r