← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzleclient/vio.h

  • Committer: Monty Taylor
  • Date: 2009-02-08 11:04:34 UTC
  • mto: This revision was merged to the branch mainline in revision 852.
  • Revision ID: mordred@inaugust.com-20090208110434-dul9atfu1mzq3wd0
Renamed vio.

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzleclient/vio.h
42
42
#define VIO_BUFFERED_READ 2                     /* use buffered read */
43
43
#define VIO_READ_BUFFER_SIZE 16384              /* size of read buffer */
44
44
 
45
 
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);
46
46
 
47
 
void    vio_delete(Vio* vio);
48
 
int     vio_close(Vio* vio);
49
 
void    vio_reset(Vio* vio, enum enum_vio_type type, int sd, uint32_t flags);
50
 
size_t  vio_read(Vio *vio, unsigned char *      buf, size_t size);
51
 
size_t  vio_read_buff(Vio *vio, unsigned char * buf, size_t size);
52
 
size_t  vio_write(Vio *vio, const unsigned char * buf, size_t size);
53
 
int     vio_blocking(Vio *vio, bool onoff, bool *old_mode);
54
 
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);
55
55
/* setsockopt TCP_NODELAY at IPPROTO_TCP level, when possible */
56
 
int     vio_fastsend(Vio *vio);
 
56
int     drizzleclient_vio_fastsend(Vio *vio);
57
57
/* setsockopt SO_KEEPALIVE at SOL_SOCKET level, when possible */
58
 
int32_t vio_keepalive(Vio *vio, bool    onoff);
 
58
int32_t drizzleclient_vio_keepalive(Vio *vio, bool      onoff);
59
59
/* Whenever we should retry the last read/write operation. */
60
 
bool    vio_should_retry(Vio *vio);
 
60
bool    drizzleclient_vio_should_retry(Vio *vio);
61
61
/* Check that operation was timed out */
62
 
bool    vio_was_interrupted(Vio *vio);
 
62
bool    drizzleclient_vio_was_interrupted(Vio *vio);
63
63
/* Short text description of the socket for those, who are curious.. */
64
 
const char* vio_description(Vio *vio);
 
64
const char* drizzleclient_vio_description(Vio *vio);
65
65
/* Return the type of the connection */
66
 
enum enum_vio_type vio_type(Vio* vio);
 
66
enum enum_vio_type drizzleclient_vio_type(Vio* vio);
67
67
/* Return last error number */
68
 
int     vio_errno(Vio*vio);
 
68
int     drizzleclient_vio_errno(Vio*vio);
69
69
/* Get socket number */
70
 
int vio_fd(Vio*vio);
 
70
int drizzleclient_vio_fd(Vio*vio);
71
71
/* Remote peer's address and name in text form */
72
 
bool vio_peer_addr(Vio *vio, char *buf, uint16_t *port, size_t buflen);
73
 
bool vio_poll_read(Vio *vio, int timeout);
74
 
bool vio_peek_read(Vio *vio, unsigned int *bytes);
75
 
 
76
 
void vio_end(void);
77
 
 
78
 
void vio_ignore_timeout(Vio *vio, bool is_sndtimeo, int32_t timeout);
79
 
void vio_timeout(Vio *vio, bool is_sndtimeo, int32_t timeout);
 
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);
80
80
 
81
81
#ifdef  __cplusplus
82
82
}
83
83
#endif
84
84
 
85
85
#if !defined(DONT_MAP_VIO)
86
 
#define vio_delete(vio)                         (vio)->viodelete(vio)
87
 
#define vio_errno(vio)                          (vio)->vioerrno(vio)
88
 
#define vio_read(vio, buf, size)                ((vio)->read)(vio,buf,size)
89
 
#define vio_write(vio, buf, size)               ((vio)->write)(vio, buf, size)
90
 
#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)\
91
91
        (vio)->vioblocking(vio, set_blocking_mode, old_mode)
92
 
#define vio_is_blocking(vio)                    (vio)->is_blocking(vio)
93
 
#define vio_fastsend(vio)                       (vio)->fastsend(vio)
94
 
#define vio_keepalive(vio, set_keep_alive)      (vio)->viokeepalive(vio, set_keep_alive)
95
 
#define vio_should_retry(vio)                   (vio)->should_retry(vio)
96
 
#define vio_was_interrupted(vio)                (vio)->was_interrupted(vio)
97
 
#define vio_close(vio)                          ((vio)->vioclose)(vio)
98
 
#define vio_peer_addr(vio, buf, prt, buflen)    (vio)->peer_addr(vio, buf, prt, buflen)
99
 
#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)
100
100
#endif /* !defined(DONT_MAP_VIO) */
101
101
 
102
102
/* This enumerator is used in parser - should be always visible */
139
139
  bool (*was_interrupted)(Vio*);
140
140
  int32_t     (*vioclose)(Vio*);
141
141
  void    (*timeout)(Vio*, bool is_sndtimeo, int32_t timeout);
142
 
  char                  *read_buffer;   /* buffer for vio_read_buff */
 
142
  char                  *read_buffer;   /* buffer for drizzleclient_vio_read_buff */
143
143
};
144
144
 
145
145
#endif /* LIBDRIZZLECLIENT_VIO_H */