← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzleclient/vio.h

  • Committer: Padraig O'Sullivan
  • Date: 2009-03-21 01:02:23 UTC
  • mto: (960.2.5 mordred)
  • mto: This revision was merged to the branch mainline in revision 961.
  • Revision ID: osullivan.padraig@gmail.com-20090321010223-j8cph7eeyt1u3xol
Fixed function object to ensure it correctly returns a boolean type since
memcmp returns an integer. Added some more comments.

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzleclient/vio.h
18
18
 * Purpose: include file for Vio that will work with C and C++
19
19
 */
20
20
 
21
 
#ifndef vio_violite_h_
22
 
#define vio_violite_h_
 
21
#ifndef LIBDRIZZLECLIENT_VIO_H
 
22
#define LIBDRIZZLECLIENT_VIO_H
23
23
 
24
24
#include <sys/socket.h>
25
25
#include <errno.h>
36
36
  VIO_TYPE_SSL, VIO_TYPE_SHARED_MEMORY
37
37
};
38
38
 
 
39
typedef struct st_vio Vio;
39
40
 
40
41
#define VIO_LOCALHOST 1                         /* a localhost connection */
41
42
#define VIO_BUFFERED_READ 2                     /* use buffered read */
42
43
#define VIO_READ_BUFFER_SIZE 16384              /* size of read buffer */
43
44
 
44
 
Vio*    vio_new(int sd, enum enum_vio_type type, unsigned int flags);
 
45
Vio*    drizzleclient_vio_new(int sd, enum enum_vio_type type, unsigned int flags);
45
46
 
46
 
void    vio_delete(Vio* vio);
47
 
int     vio_close(Vio* vio);
48
 
void    vio_reset(Vio* vio, enum enum_vio_type type, int sd, uint32_t flags);
49
 
size_t  vio_read(Vio *vio, unsigned char *      buf, size_t size);
50
 
size_t  vio_read_buff(Vio *vio, unsigned char * buf, size_t size);
51
 
size_t  vio_write(Vio *vio, const unsigned char * buf, size_t size);
52
 
int     vio_blocking(Vio *vio, bool onoff, bool *old_mode);
53
 
bool    vio_is_blocking(Vio *vio);
 
47
void    drizzleclient_vio_delete(Vio* vio);
 
48
int     drizzleclient_vio_close(Vio* vio);
 
49
void    drizzleclient_vio_reset(Vio* vio, enum enum_vio_type type, int sd, uint32_t flags);
 
50
size_t  drizzleclient_vio_read(Vio *vio, unsigned char *        buf, size_t size);
 
51
size_t  drizzleclient_vio_read_buff(Vio *vio, unsigned char * buf, size_t size);
 
52
size_t  drizzleclient_vio_write(Vio *vio, const unsigned char * buf, size_t size);
 
53
int     drizzleclient_vio_blocking(Vio *vio, bool onoff, bool *old_mode);
 
54
bool    drizzleclient_vio_is_blocking(Vio *vio);
54
55
/* setsockopt TCP_NODELAY at IPPROTO_TCP level, when possible */
55
 
int     vio_fastsend(Vio *vio);
 
56
int     drizzleclient_vio_fastsend(Vio *vio);
56
57
/* setsockopt SO_KEEPALIVE at SOL_SOCKET level, when possible */
57
 
int32_t vio_keepalive(Vio *vio, bool    onoff);
 
58
int32_t drizzleclient_vio_keepalive(Vio *vio, bool      onoff);
58
59
/* Whenever we should retry the last read/write operation. */
59
 
bool    vio_should_retry(Vio *vio);
 
60
bool    drizzleclient_vio_should_retry(Vio *vio);
60
61
/* Check that operation was timed out */
61
 
bool    vio_was_interrupted(Vio *vio);
 
62
bool    drizzleclient_vio_was_interrupted(Vio *vio);
62
63
/* Short text description of the socket for those, who are curious.. */
63
 
const char* vio_description(Vio *vio);
 
64
const char* drizzleclient_vio_description(Vio *vio);
64
65
/* Return the type of the connection */
65
 
enum enum_vio_type vio_type(Vio* vio);
 
66
enum enum_vio_type drizzleclient_vio_type(Vio* vio);
66
67
/* Return last error number */
67
 
int     vio_errno(Vio*vio);
 
68
int     drizzleclient_vio_errno(Vio*vio);
68
69
/* Get socket number */
69
 
int vio_fd(Vio*vio);
 
70
int drizzleclient_vio_fd(Vio*vio);
70
71
/* Remote peer's address and name in text form */
71
 
bool vio_peer_addr(Vio *vio, char *buf, uint16_t *port, size_t buflen);
72
 
bool vio_poll_read(Vio *vio, int timeout);
73
 
bool vio_peek_read(Vio *vio, unsigned int *bytes);
74
 
 
75
 
void vio_end(void);
 
72
bool drizzleclient_vio_peer_addr(Vio *vio, char *buf, uint16_t *port, size_t buflen);
 
73
bool drizzleclient_vio_poll_read(Vio *vio, int timeout);
 
74
bool drizzleclient_vio_peek_read(Vio *vio, unsigned int *bytes);
 
75
 
 
76
void drizzleclient_vio_end(void);
 
77
 
 
78
void drizzleclient_vio_ignore_timeout(Vio *vio, bool is_sndtimeo, int32_t timeout);
 
79
void drizzleclient_vio_timeout(Vio *vio, bool is_sndtimeo, int32_t timeout);
76
80
 
77
81
#ifdef  __cplusplus
78
82
}
79
83
#endif
80
84
 
81
85
#if !defined(DONT_MAP_VIO)
82
 
#define vio_delete(vio)                         (vio)->viodelete(vio)
83
 
#define vio_errno(vio)                          (vio)->vioerrno(vio)
84
 
#define vio_read(vio, buf, size)                ((vio)->read)(vio,buf,size)
85
 
#define vio_write(vio, buf, size)               ((vio)->write)(vio, buf, size)
86
 
#define vio_blocking(vio, set_blocking_mode, old_mode)\
 
86
#define drizzleclient_vio_delete(vio)                   (vio)->viodelete(vio)
 
87
#define drizzleclient_vio_errno(vio)                            (vio)->vioerrno(vio)
 
88
#define drizzleclient_vio_read(vio, buf, size)                ((vio)->read)(vio,buf,size)
 
89
#define drizzleclient_vio_write(vio, buf, size)               ((vio)->write)(vio, buf, size)
 
90
#define drizzleclient_vio_blocking(vio, set_blocking_mode, old_mode)\
87
91
        (vio)->vioblocking(vio, set_blocking_mode, old_mode)
88
 
#define vio_is_blocking(vio)                    (vio)->is_blocking(vio)
89
 
#define vio_fastsend(vio)                       (vio)->fastsend(vio)
90
 
#define vio_keepalive(vio, set_keep_alive)      (vio)->viokeepalive(vio, set_keep_alive)
91
 
#define vio_should_retry(vio)                   (vio)->should_retry(vio)
92
 
#define vio_was_interrupted(vio)                (vio)->was_interrupted(vio)
93
 
#define vio_close(vio)                          ((vio)->vioclose)(vio)
94
 
#define vio_peer_addr(vio, buf, prt, buflen)    (vio)->peer_addr(vio, buf, prt, buflen)
95
 
#define vio_timeout(vio, which, seconds)        (vio)->timeout(vio, which, seconds)
 
92
#define drizzleclient_vio_is_blocking(vio)                      (vio)->is_blocking(vio)
 
93
#define drizzleclient_vio_fastsend(vio)                 (vio)->fastsend(vio)
 
94
#define drizzleclient_vio_keepalive(vio, set_keep_alive)        (vio)->viokeepalive(vio, set_keep_alive)
 
95
#define drizzleclient_vio_should_retry(vio)                     (vio)->should_retry(vio)
 
96
#define drizzleclient_vio_was_interrupted(vio)          (vio)->was_interrupted(vio)
 
97
#define drizzleclient_vio_close(vio)                            ((vio)->vioclose)(vio)
 
98
#define drizzleclient_vio_peer_addr(vio, buf, prt, buflen)      (vio)->peer_addr(vio, buf, prt, buflen)
 
99
#define drizzleclient_vio_timeout(vio, which, seconds)  (vio)->timeout(vio, which, seconds)
96
100
#endif /* !defined(DONT_MAP_VIO) */
97
101
 
98
102
/* This enumerator is used in parser - should be always visible */
105
109
  SSL_TYPE_SPECIFIED
106
110
};
107
111
 
108
 
 
109
112
/* HFTODO - hide this if we don't want client in embedded server */
110
113
/* This structure is for every connection on both sides */
111
114
struct st_vio
136
139
  bool (*was_interrupted)(Vio*);
137
140
  int32_t     (*vioclose)(Vio*);
138
141
  void    (*timeout)(Vio*, bool is_sndtimeo, int32_t timeout);
139
 
  char                  *read_buffer;   /* buffer for vio_read_buff */
 
142
  char                  *read_buffer;   /* buffer for drizzleclient_vio_read_buff */
140
143
};
141
 
#endif /* vio_violite_h_ */
 
144
 
 
145
#endif /* LIBDRIZZLECLIENT_VIO_H */