gwenhywfar  4.3.1
Defines | Typedefs | Enumerations | Functions
syncio.h File Reference
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/inherit.h>
#include <gwenhywfar/list1.h>
#include <gwenhywfar/stringlist.h>

Go to the source code of this file.

Defines

#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
}

Functions

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_SYNCIOGWEN_SyncIo_GetBaseIo (const GWEN_SYNCIO *sio)
GWENHYWFAR_API GWEN_SYNCIOGWEN_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_ReadFileToStringList (const char *fname, int maxLines, GWEN_STRINGLIST *sl)
GWENHYWFAR_API GWEN_SYNCIOGWEN_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 void GWEN_SyncIo_SetFlags (GWEN_SYNCIO *sio, uint32_t fl)
GWENHYWFAR_API void GWEN_SyncIo_SetStatus (GWEN_SYNCIO *sio, GWEN_SYNCIO_STATUS st)
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)
Setters for Virtual Functions
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 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 GWEN_SYNCIO_WRITE_FN GWEN_SyncIo_SetWriteFn (GWEN_SYNCIO *sio, GWEN_SYNCIO_WRITE_FN fn)

Define Documentation

#define GWEN_SYNCIO_FLAGS_DONTCLOSE   0x40000000

Definition at line 57 of file syncio.h.

#define GWEN_SYNCIO_FLAGS_DOSMODE   0x08000000

Definition at line 60 of file syncio.h.

Referenced by GWEN_SyncIo_Buffered_Write(), and GWEN_SyncIo_WriteLine().

#define GWEN_SYNCIO_FLAGS_PACKET_END   0x10000000

Definition at line 59 of file syncio.h.

Referenced by GWEN_SyncIo_Buffered_Read().

#define GWEN_SYNCIO_FLAGS_PASSIVE   0x20000000
#define GWEN_SYNCIO_FLAGS_TRANSPARENT   0x80000000

Typedef Documentation

typedef struct GWEN_SYNCIO GWEN_SYNCIO

Definition at line 41 of file syncio.h.

Definition at line 169 of file syncio.h.

Definition at line 170 of file syncio.h.

Definition at line 171 of file syncio.h.

typedef GWENHYWFAR_CB int(* GWEN_SYNCIO_READ_FN)(GWEN_SYNCIO *sio, uint8_t *buffer, uint32_t size)

Definition at line 174 of file syncio.h.

typedef GWENHYWFAR_CB int(* GWEN_SYNCIO_WRITE_FN)(GWEN_SYNCIO *sio, const uint8_t *buffer, uint32_t size)

Definition at line 180 of file syncio.h.


Enumeration Type Documentation

Enumerator:
GWEN_SyncIo_Status_Unknown 
GWEN_SyncIo_Status_Unconnected 
GWEN_SyncIo_Status_Disconnected 
GWEN_SyncIo_Status_Connected 
GWEN_SyncIo_Status_Disabled 

Definition at line 46 of file syncio.h.


Function Documentation

GWENHYWFAR_API void GWEN_SyncIo_AddFlags ( GWEN_SYNCIO sio,
uint32_t  fl 
)

Definition at line 68 of file syncio.c.

Definition at line 116 of file syncio.c.

Referenced by GWEN_HttpSession_RecvPacketToFile(), and GWEN_Sar_CloseArchive().

GWENHYWFAR_API GWEN_SYNCIO* GWEN_SyncIo_GetBaseIoByTypeName ( const GWEN_SYNCIO sio,
const char *  typeName 
)

Definition at line 217 of file syncio.c.

References NULL.

Referenced by GWEN_HttpSession_ConnectionTest(), GWEN_HttpSession_Init(), and GWEN_HttpSession_SendPacket().

GWENHYWFAR_API uint32_t GWEN_SyncIo_GetFlags ( const GWEN_SYNCIO sio)
GWENHYWFAR_API const char* GWEN_SyncIo_GetTypeName ( const GWEN_SYNCIO sio)

Definition at line 201 of file syncio.c.

Referenced by GWEN_DBIO_Import(), and GWEN_HttpSession_Init().

GWENHYWFAR_API int GWEN_SyncIo_Helper_ReadFileToStringList ( const char *  fname,
int  maxLines,
GWEN_STRINGLIST sl 
)
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 void GWEN_SyncIo_SetFlags ( GWEN_SYNCIO sio,
uint32_t  fl 
)

Definition at line 161 of file syncio.c.

Referenced by GWEN_MDigest__HashFile(), and GWEN_SyncIo_Helper_ReadFileToStringList().

Definition at line 259 of file syncio.c.

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 
)

Definition at line 402 of file syncio.c.

References GWEN_SyncIo_WriteForced().

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.

Definition at line 365 of file syncio.c.

References DBG_INFO, GWEN_LOGDOMAIN, and GWEN_SyncIo_WriteForced().

Referenced by GWEN_SyncIo_WriteLine().