gwenhywfar  5.2.0
syncio.h
Go to the documentation of this file.
1 /***************************************************************************
2  begin : Tue Apr 27 2010
3  copyright : (C) 2010 by Martin Preuss
4  email : martin@libchipcard.de
5 
6  ***************************************************************************
7  * *
8  * This library is free software; you can redistribute it and/or *
9  * modify it under the terms of the GNU Lesser General Public *
10  * License as published by the Free Software Foundation; either *
11  * version 2.1 of the License, or (at your option) any later version. *
12  * *
13  * This library is distributed in the hope that it will be useful, *
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16  * Lesser General Public License for more details. *
17  * *
18  * You should have received a copy of the GNU Lesser General Public *
19  * License along with this library; if not, write to the Free Software *
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21  * MA 02111-1307 USA *
22  * *
23  ***************************************************************************/
24 
25 
26 #ifndef GWENHYWFAR_SYNCIO_H
27 #define GWENHYWFAR_SYNCIO_H
28 
30 #include <gwenhywfar/inherit.h>
31 #include <gwenhywfar/list1.h>
32 
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 
39 
40 typedef struct GWEN_SYNCIO GWEN_SYNCIO;
43 
44 
45 typedef enum {
52 
53 
54 
55 #define GWEN_SYNCIO_FLAGS_TRANSPARENT 0x80000000
56 #define GWEN_SYNCIO_FLAGS_DONTCLOSE 0x40000000
57 #define GWEN_SYNCIO_FLAGS_PASSIVE 0x20000000
58 #define GWEN_SYNCIO_FLAGS_PACKET_END 0x10000000
59 #define GWEN_SYNCIO_FLAGS_DOSMODE 0x08000000
60 
61 
62 #ifdef __cplusplus
63 }
64 #endif
65 
66 
67 
68 #include <gwenhywfar/stringlist.h>
69 #include <gwenhywfar/buffer.h>
70 
71 
72 
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
76 
77 
78 
79 
81 GWEN_SYNCIO *GWEN_SyncIo_new(const char *typeName, GWEN_SYNCIO *baseIo);
82 
85 
87 void GWEN_SyncIo_free(GWEN_SYNCIO *sio);
88 
89 
92 
95 
98 
99 
102  uint8_t *buffer,
103  uint32_t size);
104 
105 
106 
109  const uint8_t *buffer,
110  uint32_t size);
111 
113 uint32_t GWEN_SyncIo_GetFlags(const GWEN_SYNCIO *sio);
114 
116 void GWEN_SyncIo_SetFlags(GWEN_SYNCIO *sio, uint32_t fl);
117 
119 void GWEN_SyncIo_AddFlags(GWEN_SYNCIO *sio, uint32_t fl);
120 
122 void GWEN_SyncIo_SubFlags(GWEN_SYNCIO *sio, uint32_t fl);
123 
124 
127 
130 
131 
133 const char *GWEN_SyncIo_GetTypeName(const GWEN_SYNCIO *sio);
134 
135 
138 
140 GWEN_SYNCIO *GWEN_SyncIo_GetBaseIoByTypeName(const GWEN_SYNCIO *sio, const char *typeName);
141 
142 
143 
146  const uint8_t *buffer,
147  uint32_t size);
148 
149 
152  uint8_t *buffer,
153  uint32_t size);
154 
155 
156 
162 int GWEN_SyncIo_WriteString(GWEN_SYNCIO *sio, const char *s);
163 
165 int GWEN_SyncIo_WriteLine(GWEN_SYNCIO *sio, const char *s);
166 
168 int GWEN_SyncIo_WriteChar(GWEN_SYNCIO *sio, char s);
169 
170 
172 int GWEN_SyncIo_Helper_ReadFileToStringList(const char *fname,
173  int maxLines,
174  GWEN_STRINGLIST *sl);
175 
176 
187 int GWEN_SyncIo_Helper_PartiallyReadFile(const char *fName, uint8_t *buffer, uint32_t size);
188 
189 
198 int GWEN_SyncIo_Helper_ReadFile(const char *fName, GWEN_BUFFER *dbuf);
199 
200 
210 int GWEN_SyncIo_Helper_WriteFile(const char *fName, const uint8_t *ptrSource, uint64_t lenSource);
211 
212 
213 
214 
221 typedef GWENHYWFAR_CB int (*GWEN_SYNCIO_FLUSH_FN)(GWEN_SYNCIO *sio);
222 
223 
224 typedef GWENHYWFAR_CB int (*GWEN_SYNCIO_READ_FN)(GWEN_SYNCIO *sio,
225  uint8_t *buffer,
226  uint32_t size);
227 
228 
229 
231  const uint8_t *buffer,
232  uint32_t size);
243 
246 
249 
252 
258 #ifdef __cplusplus
259 }
260 #endif
261 
262 
263 
264 #endif
265 
266 
GWEN_SyncIo_Read
GWENHYWFAR_API int GWEN_SyncIo_Read(GWEN_SYNCIO *sio, uint8_t *buffer, uint32_t size)
GWEN_SyncIo_SetDisconnectFn
GWENHYWFAR_API GWEN_SYNCIO_DISCONNECT_FN GWEN_SyncIo_SetDisconnectFn(GWEN_SYNCIO *sio, GWEN_SYNCIO_DISCONNECT_FN fn)
GWEN_STRINGLIST
struct GWEN_STRINGLISTSTRUCT GWEN_STRINGLIST
Definition: stringlist.h:53
GWEN_SYNCIO_CONNECT_FN
GWENHYWFAR_CB int(* GWEN_SYNCIO_CONNECT_FN)(GWEN_SYNCIO *sio)
Definition: syncio.h:218
GWEN_SyncIo_SetStatus
GWENHYWFAR_API void GWEN_SyncIo_SetStatus(GWEN_SYNCIO *sio, GWEN_SYNCIO_STATUS st)
GWEN_SYNCIO
struct GWEN_SYNCIO GWEN_SYNCIO
Definition: syncio.h:39
GWEN_SyncIo_Helper_ReadFile
GWENHYWFAR_API int GWEN_SyncIo_Helper_ReadFile(const char *fName, GWEN_BUFFER *dbuf)
GWEN_SyncIo_Disconnect
GWENHYWFAR_API int GWEN_SyncIo_Disconnect(GWEN_SYNCIO *sio)
GWEN_SyncIo_WriteChar
GWENHYWFAR_API int GWEN_SyncIo_WriteChar(GWEN_SYNCIO *sio, char s)
GWEN_SyncIo_free
GWENHYWFAR_API void GWEN_SyncIo_free(GWEN_SYNCIO *sio)
GWEN_SyncIo_GetTypeName
const GWENHYWFAR_API char * GWEN_SyncIo_GetTypeName(const GWEN_SYNCIO *sio)
GWEN_INHERIT_FUNCTION_LIB_DEFS
#define GWEN_INHERIT_FUNCTION_LIB_DEFS(t, decl)
Definition: inherit.h:124
GWEN_SyncIo_WriteForced
GWENHYWFAR_API int GWEN_SyncIo_WriteForced(GWEN_SYNCIO *sio, const uint8_t *buffer, uint32_t size)
GWEN_SyncIo_Write
GWENHYWFAR_API int GWEN_SyncIo_Write(GWEN_SYNCIO *sio, const uint8_t *buffer, uint32_t size)
GWEN_SyncIo_SetWriteFn
GWENHYWFAR_API GWEN_SYNCIO_WRITE_FN GWEN_SyncIo_SetWriteFn(GWEN_SYNCIO *sio, GWEN_SYNCIO_WRITE_FN fn)
GWEN_SYNCIO_WRITE_FN
GWENHYWFAR_CB int(* GWEN_SYNCIO_WRITE_FN)(GWEN_SYNCIO *sio, const uint8_t *buffer, uint32_t size)
Definition: syncio.h:229
GWEN_SyncIo_Status_Unconnected
Definition: syncio.h:46
GWEN_SyncIo_SetFlushFn
GWENHYWFAR_API GWEN_SYNCIO_FLUSH_FN GWEN_SyncIo_SetFlushFn(GWEN_SYNCIO *sio, GWEN_SYNCIO_FLUSH_FN fn)
GWEN_SyncIo_new
GWENHYWFAR_API GWEN_SYNCIO * GWEN_SyncIo_new(const char *typeName, GWEN_SYNCIO *baseIo)
GWEN_SyncIo_GetBaseIoByTypeName
GWENHYWFAR_API GWEN_SYNCIO * GWEN_SyncIo_GetBaseIoByTypeName(const GWEN_SYNCIO *sio, const char *typeName)
GWEN_SYNCIO_DISCONNECT_FN
GWENHYWFAR_CB int(* GWEN_SYNCIO_DISCONNECT_FN)(GWEN_SYNCIO *sio)
Definition: syncio.h:219
GWEN_SyncIo_WriteString
GWENHYWFAR_API int GWEN_SyncIo_WriteString(GWEN_SYNCIO *sio, const char *s)
GWEN_SyncIo_ReadForced
GWENHYWFAR_API int GWEN_SyncIo_ReadForced(GWEN_SYNCIO *sio, uint8_t *buffer, uint32_t size)
GWEN_SYNCIO_READ_FN
GWENHYWFAR_CB int(* GWEN_SYNCIO_READ_FN)(GWEN_SYNCIO *sio, uint8_t *buffer, uint32_t size)
Definition: syncio.h:223
GWEN_SyncIo_Status_Disabled
Definition: syncio.h:49
GWEN_SyncIo_Helper_PartiallyReadFile
GWENHYWFAR_API int GWEN_SyncIo_Helper_PartiallyReadFile(const char *fName, uint8_t *buffer, uint32_t size)
GWEN_LIST_FUNCTION_LIB_DEFS
#define GWEN_LIST_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list1.h:347
GWEN_SyncIo_Helper_ReadFileToStringList
GWENHYWFAR_API int GWEN_SyncIo_Helper_ReadFileToStringList(const char *fname, int maxLines, GWEN_STRINGLIST *sl)
GWEN_SyncIo_SetReadFn
GWENHYWFAR_API GWEN_SYNCIO_READ_FN GWEN_SyncIo_SetReadFn(GWEN_SYNCIO *sio, GWEN_SYNCIO_READ_FN fn)
GWEN_SyncIo_Status_Unknown
Definition: syncio.h:45
GWEN_SyncIo_WriteLine
GWENHYWFAR_API int GWEN_SyncIo_WriteLine(GWEN_SYNCIO *sio, const char *s)
GWEN_SYNCIO_FLUSH_FN
GWENHYWFAR_CB int(* GWEN_SYNCIO_FLUSH_FN)(GWEN_SYNCIO *sio)
Definition: syncio.h:220
GWEN_SyncIo_Status_Connected
Definition: syncio.h:48
GWENHYWFAR_CB
#define GWENHYWFAR_CB
Definition: gwenhywfarapi.h:88
buffer.h
GWEN_SYNCIO_STATUS
GWEN_SYNCIO_STATUS
Definition: syncio.h:44
GWEN_SyncIo_GetFlags
GWENHYWFAR_API uint32_t GWEN_SyncIo_GetFlags(const GWEN_SYNCIO *sio)
GWEN_SyncIo_Helper_WriteFile
GWENHYWFAR_API int GWEN_SyncIo_Helper_WriteFile(const char *fName, const uint8_t *ptrSource, uint64_t lenSource)
GWEN_SyncIo_Attach
GWENHYWFAR_API void GWEN_SyncIo_Attach(GWEN_SYNCIO *sio)
GWEN_SyncIo_SubFlags
GWENHYWFAR_API void GWEN_SyncIo_SubFlags(GWEN_SYNCIO *sio, uint32_t fl)
gwenhywfarapi.h
GWEN_SyncIo_SetConnectFn
GWENHYWFAR_API GWEN_SYNCIO_CONNECT_FN GWEN_SyncIo_SetConnectFn(GWEN_SYNCIO *sio, GWEN_SYNCIO_CONNECT_FN fn)
GWEN_SyncIo_GetStatus
GWENHYWFAR_API GWEN_SYNCIO_STATUS GWEN_SyncIo_GetStatus(const GWEN_SYNCIO *sio)
GWEN_SyncIo_GetBaseIo
GWENHYWFAR_API GWEN_SYNCIO * GWEN_SyncIo_GetBaseIo(const GWEN_SYNCIO *sio)
GWENHYWFAR_API
#define GWENHYWFAR_API
Definition: gwenhywfarapi.h:66
GWEN_SyncIo_SetFlags
GWENHYWFAR_API void GWEN_SyncIo_SetFlags(GWEN_SYNCIO *sio, uint32_t fl)
GWEN_SyncIo_Status_Disconnected
Definition: syncio.h:47
GWEN_SyncIo_AddFlags
GWENHYWFAR_API void GWEN_SyncIo_AddFlags(GWEN_SYNCIO *sio, uint32_t fl)
stringlist.h
list1.h
inherit.h
GWEN_BUFFER
struct GWEN_BUFFER GWEN_BUFFER
A dynamically resizeable text buffer.
Definition: buffer.h:37
GWEN_SyncIo_Connect
GWENHYWFAR_API int GWEN_SyncIo_Connect(GWEN_SYNCIO *sio)
GWEN_SyncIo_Flush
GWENHYWFAR_API int GWEN_SyncIo_Flush(GWEN_SYNCIO *sio)