gwenhywfar
5.11.1beta
|
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/inherit.h>
#include <gwenhywfar/list1.h>
#include <gwenhywfar/stringlist.h>
#include <gwenhywfar/buffer.h>
Go to the source code of this file.
Macros | |
#define | GWEN_SYNCIO_FLAGS_DONTCLOSE 0x40000000 |
#define | GWEN_SYNCIO_FLAGS_DOSMODE 0x08000000 |
#define | GWEN_SYNCIO_FLAGS_PACKET_END 0x10000000 |
#define | GWEN_SYNCIO_FLAGS_PASSIVE 0x20000000 |
#define | GWEN_SYNCIO_FLAGS_TRANSPARENT 0x80000000 |
Typedefs | |
typedef struct GWEN_SYNCIO | GWEN_SYNCIO |
Declarations for Virtual Functions | |
typedef GWENHYWFAR_CB int(* | GWEN_SYNCIO_CONNECT_FN) (GWEN_SYNCIO *sio) |
typedef GWENHYWFAR_CB int(* | GWEN_SYNCIO_DISCONNECT_FN) (GWEN_SYNCIO *sio) |
typedef GWENHYWFAR_CB int(* | GWEN_SYNCIO_FLUSH_FN) (GWEN_SYNCIO *sio) |
typedef GWENHYWFAR_CB int(* | GWEN_SYNCIO_READ_FN) (GWEN_SYNCIO *sio, uint8_t *buffer, uint32_t size) |
typedef GWENHYWFAR_CB int(* | GWEN_SYNCIO_WRITE_FN) (GWEN_SYNCIO *sio, const uint8_t *buffer, uint32_t size) |
Enumerations | |
enum | GWEN_SYNCIO_STATUS { GWEN_SyncIo_Status_Unknown =-1 , GWEN_SyncIo_Status_Unconnected =0 , GWEN_SyncIo_Status_Disconnected , GWEN_SyncIo_Status_Connected , GWEN_SyncIo_Status_Disabled } |
typedef struct GWEN_SYNCIO GWEN_SYNCIO |
typedef GWENHYWFAR_CB int(* GWEN_SYNCIO_CONNECT_FN) (GWEN_SYNCIO *sio) |
typedef GWENHYWFAR_CB int(* GWEN_SYNCIO_DISCONNECT_FN) (GWEN_SYNCIO *sio) |
typedef GWENHYWFAR_CB int(* GWEN_SYNCIO_FLUSH_FN) (GWEN_SYNCIO *sio) |
typedef GWENHYWFAR_CB int(* GWEN_SYNCIO_READ_FN) (GWEN_SYNCIO *sio, uint8_t *buffer, uint32_t size) |
typedef GWENHYWFAR_CB int(* GWEN_SYNCIO_WRITE_FN) (GWEN_SYNCIO *sio, const uint8_t *buffer, uint32_t size) |
enum GWEN_SYNCIO_STATUS |
GWENHYWFAR_API void GWEN_SyncIo_AddFlags | ( | GWEN_SYNCIO * | sio, |
uint32_t | fl | ||
) |
GWENHYWFAR_API void GWEN_SyncIo_Attach | ( | GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API int GWEN_SyncIo_Connect | ( | GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API int GWEN_SyncIo_Disconnect | ( | GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API int GWEN_SyncIo_Flush | ( | GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API void GWEN_SyncIo_free | ( | GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API GWEN_SYNCIO* GWEN_SyncIo_GetBaseIo | ( | const GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API GWEN_SYNCIO* GWEN_SyncIo_GetBaseIoByTypeName | ( | const GWEN_SYNCIO * | sio, |
const char * | typeName | ||
) |
GWENHYWFAR_API uint32_t GWEN_SyncIo_GetFlags | ( | const GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API GWEN_SYNCIO_STATUS GWEN_SyncIo_GetStatus | ( | const GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API const char* GWEN_SyncIo_GetTypeName | ( | const GWEN_SYNCIO * | sio | ) |
GWENHYWFAR_API int GWEN_SyncIo_Helper_CopyFile | ( | const char * | srcPath, |
const char * | destPath | ||
) |
Copy source file to destination file. Destination file is overwritten if it exists.
srcPath | path and name of the file to read |
destPath | path and name of the file to write |
GWENHYWFAR_API int GWEN_SyncIo_Helper_PartiallyReadFile | ( | const char * | fName, |
uint8_t * | buffer, | ||
uint32_t | size | ||
) |
Read SIZE bytes from the given file. Returns the number of bytes actually read or an error code (negative value).
fName | name of the file to load |
buffer | pointer to a fixed buffer to receive the bytes read |
size | number of bytes to read |
GWENHYWFAR_API int GWEN_SyncIo_Helper_ReadFile | ( | const char * | fName, |
GWEN_BUFFER * | dbuf | ||
) |
Read a whole file into the given buffer
fName | name of the file to load |
dbuf | GWEN_BUFFER to receive the bytes read |
GWENHYWFAR_API int GWEN_SyncIo_Helper_ReadFileToStringList | ( | const char * | fname, |
int | maxLines, | ||
GWEN_STRINGLIST * | sl | ||
) |
GWENHYWFAR_API int GWEN_SyncIo_Helper_WriteFile | ( | const char * | fName, |
const uint8_t * | ptrSource, | ||
uint64_t | lenSource | ||
) |
Writes a whole file from the given buffer
fName | name of the file to load |
ptrSource | pointer to the data to write |
lenSource | size of the data to write |
GWENHYWFAR_API GWEN_SYNCIO* GWEN_SyncIo_new | ( | const char * | typeName, |
GWEN_SYNCIO * | baseIo | ||
) |
GWENHYWFAR_API int GWEN_SyncIo_Read | ( | GWEN_SYNCIO * | sio, |
uint8_t * | buffer, | ||
uint32_t | size | ||
) |
GWENHYWFAR_API int GWEN_SyncIo_ReadForced | ( | GWEN_SYNCIO * | sio, |
uint8_t * | buffer, | ||
uint32_t | size | ||
) |
GWENHYWFAR_API GWEN_SYNCIO_CONNECT_FN GWEN_SyncIo_SetConnectFn | ( | GWEN_SYNCIO * | sio, |
GWEN_SYNCIO_CONNECT_FN | fn | ||
) |
GWENHYWFAR_API GWEN_SYNCIO_DISCONNECT_FN GWEN_SyncIo_SetDisconnectFn | ( | GWEN_SYNCIO * | sio, |
GWEN_SYNCIO_DISCONNECT_FN | fn | ||
) |
GWENHYWFAR_API void GWEN_SyncIo_SetFlags | ( | GWEN_SYNCIO * | sio, |
uint32_t | fl | ||
) |
GWENHYWFAR_API GWEN_SYNCIO_FLUSH_FN GWEN_SyncIo_SetFlushFn | ( | GWEN_SYNCIO * | sio, |
GWEN_SYNCIO_FLUSH_FN | fn | ||
) |
GWENHYWFAR_API GWEN_SYNCIO_READ_FN GWEN_SyncIo_SetReadFn | ( | GWEN_SYNCIO * | sio, |
GWEN_SYNCIO_READ_FN | fn | ||
) |
GWENHYWFAR_API void GWEN_SyncIo_SetStatus | ( | GWEN_SYNCIO * | sio, |
GWEN_SYNCIO_STATUS | st | ||
) |
GWENHYWFAR_API GWEN_SYNCIO_WRITE_FN GWEN_SyncIo_SetWriteFn | ( | GWEN_SYNCIO * | sio, |
GWEN_SYNCIO_WRITE_FN | fn | ||
) |
GWENHYWFAR_API void GWEN_SyncIo_SubFlags | ( | GWEN_SYNCIO * | sio, |
uint32_t | fl | ||
) |
GWENHYWFAR_API int GWEN_SyncIo_Write | ( | GWEN_SYNCIO * | sio, |
const uint8_t * | buffer, | ||
uint32_t | size | ||
) |
GWENHYWFAR_API int GWEN_SyncIo_WriteChar | ( | GWEN_SYNCIO * | sio, |
char | s | ||
) |
GWENHYWFAR_API int GWEN_SyncIo_WriteForced | ( | GWEN_SYNCIO * | sio, |
const uint8_t * | buffer, | ||
uint32_t | size | ||
) |
GWENHYWFAR_API int GWEN_SyncIo_WriteLine | ( | GWEN_SYNCIO * | sio, |
const char * | s | ||
) |
GWENHYWFAR_API int GWEN_SyncIo_WriteString | ( | GWEN_SYNCIO * | sio, |
const char * | s | ||
) |
This is just a convenience function to easily replace a function from the deprecated module GWEN_BUFFEREDIO.