Eric Jung / GMMP_mbed_Ethernet_Reinit

Dependents:   ThingPlug_Ethernet_Example

Fork of GMMP_mbed by Eric Jung

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers Struct_Control.h Source File

Struct_Control.h

Go to the documentation of this file.
00001  /** GMMP Operation 중 제어 명령에 사용되는 구조체
00002  * @file Struct_Control.h
00003  * @date 2013/11/21
00004  * @version 0.0.0.1
00005  * @ref GMMPHeader참조
00006  **/
00007 
00008 #ifndef STRUCT_CONTROL_H_
00009 #define STRUCT_CONTROL_H_
00010 
00011 #include "Define.h"
00012 #include "Struct_Common.h"
00013 #include "Struct_Control_Opt.h"
00014 
00015 #pragma pack(1)
00016 
00017 /**
00018  * @struct stControlReqHdr
00019  * @brief GMMP TCP Packet  구조 중 Request 수행 시 Message Header와 Message Body 영역
00020  * OMP에서 제어 명령 메시지를 전송하여 GMMP Lib에서 해당 메시지를 수신한다.
00021   */
00022 typedef struct {
00023 /**
00024 *@var usDomainCode
00025 *@brief 서비스 영역별 구분 코드\n
00026 - AlphaNumeric : 문자,숫자 조합, 특수문자제외, SPACE 허용 안하며 빈자리는 0x00(NULL)로 채운다.\n
00027 */
00028 /**
00029 *@var usGWID
00030 *@brief M2M GW ID
00031 */
00032 /**
00033 *@var usDeviceID
00034 *@brief M2M Device ID, 값이 0x0이면 GW 명령이다.
00035 */
00036 /**
00037 *@var ucControlType
00038 *@brief 제어 명령 구분자
00039 **아래 표 참조\n
00040 *@image html ControlDefine.png Control Type 표
00041 *@ref Define_Control.h 참조
00042 */
00043 /**
00044 *@var usMessageBody
00045 *@brief Data [2048byte]
00046 *@ref Struct_Control_Opt.h 참조
00047 */
00048 
00049     U8  usDomainCode[LEN_DOMAIN_CODE];
00050     U8  usGWID[LEN_GW_ID];
00051     U8  usDeviceID[LEN_DEVICE_ID];
00052     U8  ucControlType;
00053     U8  usMessageBody[MAX_MSG_BODY];
00054 }stControlReqHdr; //Control Request
00055 
00056 /**
00057 * @struct stControlRspHdr
00058 * @brief GMMP TCP Packet  구조 중 Response 수행 시 Message Header와 Message Body 영역
00059 * OMP에서 전송한 제어 메시지에 대한 응답을 전송한다.
00060 */
00061 typedef struct {
00062 /**
00063 *@var usDomainCode
00064 *@brief 서비스 영역별 구분 코드\n
00065 - AlphaNumeric : 문자,숫자 조합, 특수문자제외, SPACE 허용 안하며 빈자리는 0x00(NULL)로 채운다.\n
00066 */
00067 /**
00068 *@var usGWID
00069 *@brief M2M GW ID
00070 */
00071 /**
00072 *@var usDeviceID
00073 *@brief M2M Device ID, 값이 0x0이면 GW 명령이다.
00074 */
00075 /**
00076 *@var ucControlType
00077 *@brief 제어 명령 구분자\n
00078 *@ref Define_Control.h 참조
00079 */
00080 /**
00081 *@var ucResultCode
00082 *@brief Result Code (0x00 : Success, other : Fail Reason) @ref OMPErrorCode.h 참조
00083 */
00084 
00085     U8  usDomainCode[LEN_DOMAIN_CODE];
00086     U8  usGWID[LEN_GW_ID];
00087     U8  usDeviceID[LEN_DEVICE_ID];
00088     U8  ucControlType;
00089     U8  ucResultCode;
00090 }stControlRspHdr; //Control Response
00091 
00092 
00093 /**
00094 * @struct Control_Req
00095 * @brief GMMP TCP Packet  구조 중 Request Control 제어 구조
00096 *  OMP에서 메시지를 전송하여 GMMP Lib에서 해당 메시지를 수신한다.
00097 */
00098 typedef struct {
00099 /**
00100 *@var header
00101 *@brief
00102 *@ref GMMPHeader 참조
00103 */
00104 /**
00105 *@var body
00106 *@brief @ref stControlReqHdr 참조
00107 */
00108     GMMPHeader          header;
00109     stControlReqHdr body;
00110 }Control_Req;
00111 
00112 /**
00113  * @struct Control_Rsp
00114  * @brief GMMP TCP Packet  구조 중 Response Control 제어 구조
00115  * OMP에서 전송한 제어 메시지에 대한 응답을 전송한다.
00116  */
00117 typedef struct {
00118 /**
00119 *@var header
00120 *@brief @ref GMMPHeader 참조
00121 */
00122 /**
00123 *@var body
00124 *@brief @ref stControlRspHdr 참조
00125 */
00126     GMMPHeader          header;
00127     stControlRspHdr body;
00128 }Control_Rsp;
00129 #pragma pack(0)
00130 
00131 #endif /* STRUCT_CONTROL_H_ */