LinuxSDK  V1.4.0.5
SwiApiCdmaIota.h
Go to the documentation of this file.
1 
13 #ifndef __SWIAPICDMAIOTA_H__
14 #define __SWIAPICDMAIOTA_H__
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 /* include files */
21 #include "SwiDataTypes.h"
22 #include "SwiRcodes.h"
23 #include "SwiApiCdmaBasic.h"
24 
25 #define LENGTH_WAPUri 128
32 typedef enum SWI_EMIOTA_EVENT_TYPE
33 {
34  SWI_EMIOTA_SESSION_START,
35  SWI_EMIOTA_SESSION_END
36 }SWI_EMIOTA_EVENT_TYPE;
37 
43 typedef enum SWI_EMIOTA_EVENT_RESULT
44 {
45  SWI_EMIOTA_EVENT_RESULT_SUCCESS,
46  SWI_EMIOTA_EVENT_RESULT_FAILURE
47 }SWI_EMIOTA_EVENT_RESULT;
48 
54 typedef enum SWI_EMIOTA_EVENT_FAIL_REASON
55 {
56  SWI_EMIOTA_STATUS_MIN = -1,
57  SWI_EMIOTA_STATUS_SUCCESS ,
58  SWI_EMIOTA_STATUS_ERROR_DISCONNECT,
61  SWI_EMIOTA_STATUS_ERROR_NOT_ALLOWED,
62 
64  SWI_EMIOTA_STATUS_ERROR_ALREADY_ACTIVE,
65 
67  SWI_EMIOTA_STATUS_ERROR_CLIENT_ABORT,
68 
69  SWI_EMIOTA_STATUS_ERROR_HTTP,
70  SWI_EMIOTA_STATUS_ERROR_MIME,
71  SWI_EMIOTA_STATUS_ERROR_XML,
72  SWI_EMIOTA_STATUS_ERROR_MMC,
75  SWI_EMIOTA_STATUS_ERROR_NOT_TRUSTED,
76 
78  SWI_EMIOTA_STATUS_ERROR_SESSION_TIMEOUT,
79 
80  SWI_EMIOTA_STATUS_ERROR_UNKNOWN,
81  SWI_EMIOTA_STATUS_ERROR_INTERNAL,
82  SWI_EMIOTA_STATUS_ERROR_NO_SERVICE,
85  SWI_EMIOTA_STATUS_ERROR_ACTIVE_DATA_CALL,
86 
88  SWI_EMIOTA_STATUS_ERROR_ACTIVE_VOICE_CALL,
89 
91  SWI_EMIOTA_STATUS_ERROR_NO_DIGITAL_SERVICE,
92 
93  SWI_EMIOTA_STATUS_MAX
94 }SWI_EMIOTA_EVENT_FAIL_REASON;
95 
103 typedef enum SWI_EMIOTA_EVENT_ERR_CODE
104 {
105  SWI_EMIOTA_ERR_MMC_DISCONNECT,
106  SWI_EMIOTA_ERR_INVALID_VALREF,
107  SWI_EMIOTA_ERR_CID_MISSING,
108  SWI_EMIOTA_ERR_DLD_FAILED,
109  SWI_EMIOTA_ERR_RESERVED,
110  SWI_EMIOTA_ERR_INVALID_CONTENT,
111  SWI_EMIOTA_ERR_USR_DENIED,
112  SWI_EMIOTA_ERR_BAD_VALUE,
113  SWI_EMIOTA_ERR_TIMEOUT,
114  SWI_EMIOTA_ERR_NONEW_DOC,
115  SWI_EMIOTA_ERR_DELETE_FAILED,
116  SWI_EMIOTA_ERR_BAD_DATA,
117  SWI_EMIOTA_ERR_DISPLAY_DISABLED,
118  SWI_EMIOTA_ERR_WRITE_ONLY,
119  SWI_EMIOTA_ERR_RESULT_ABORT,
120  SWI_EMIOTA_ERR_RESERVED1,
121  SWI_EMIOTA_ERR_BAD_OBJECT,
122  SWI_EMIOTA_ERR_UNKNOWN_RESULT,
123  SWI_EMIOTA_ERR_FILE_LOCKED,
124  SWI_EMIOTA_ERR_FILE_OPEN,
125  SWI_EMIOTA_ERR_CHECK_FAILED,
126  SWI_EMIOTA_ERR_INVALID_SIZE,
127  SWI_EMIOTA_ERR_INVALID_OFFSET,
128  SWI_EMIOTA_ERR_DEVICE_BUSY,
129  SWI_EMIOTA_ERR_RESERVED2
130 }SWI_EMIOTA_EVENT_ERR_CODE;
131 
141 typedef struct SWI_STRUCT_IOTA_State
142 {
143  swi_uint32 sizeStruct;
146  swi_uint16 iEvent;
147 
149  swi_uint16 iEventStatus;
150 
153  swi_uint16 iSessionEndFailureReason;
154 
156  swi_uint16 iSessionEndErrorCode;
157 
158  /* end failure reason) (future support) see SWI_EMIOTA_EVENT_ERR_CODE for
159  details. For HTTP Error - actual HTTP error code MMC error.
160  code see above
161  */
162 
163 }SWI_STRUCT_IOTA_State;
164 
174 typedef struct SWI_STRUCT_IOTA_WAPPush
175 {
176  swi_uint32 sizeStruct;
179  swi_uint8 szWAPUri[LENGTH_WAPUri];
180 }SWI_STRUCT_IOTA_WAPPush;
181 
182 /* Function prototypes */
183 
184 SWI_API SWI_RCODE SwiGetEFileInfo(const swi_charp pszEFilename,
185  SWI_STRUCT_EFileInfo* psEFileInfo,
186  swi_uint32 timeout);
187 
188 SWI_API SWI_RCODE SwiGetEFile(const swi_charp pszEFilename, swi_uint8* pBuffer,
189  swi_uint16 nBufLen, swi_uint32 timeout);
190 
191 SWI_API SWI_RCODE SwiStartIOTASession(swi_uint32 timeout);
192 
193 SWI_API SWI_RCODE SwiStopIOTASession(swi_uint32 timeout);
194 
195 SWI_API SWI_RCODE SwiSetIOTADisable(swi_bool bDisable, swi_uint32 timeout);
196 
197 SWI_API SWI_RCODE SwiGetIOTADisable(swi_bool *pbDisable, swi_uint32 timeout);
198 
199 SWI_API SWI_RCODE SwiGetIOTALog(swi_uint8* pBuffer, swi_uint16 nBufLen,
200  swi_uint32 timeout);
201 
202 SWI_API SWI_RCODE SwiGetIOTALogSize(swi_uint16 *nBufLen, swi_uint32 timeout);
203 
204 #ifdef __cplusplus
205 } /* extern "C" { */
206 #endif
207 
208 #endif /* __SWIAPICDMAIOTA_H__ */
209 
210 /*
211  * $Log: SwiApiCdmaIota.h,v $
212  */
Linux SDK V1.4.0.5
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved