← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/drizzle_protocol/vio.h

  • Committer: Brian Aker
  • Date: 2010-01-22 00:53:13 UTC
  • Revision ID: brian@gaz-20100122005313-jmizcbcdi1lt4tcx
Revert db patch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/drizzle_protocol/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 PLUGIN_DRIZZLE_PROTOCOL_VIO_H
 
22
#define PLUGIN_DRIZZLE_PROTOCOL_VIO_H
 
23
 
 
24
#include <sys/socket.h>
 
25
#include <errno.h>
23
26
 
24
27
/* Simple vio interface in C;  The functions are implemented in violite.c */
25
28
 
26
 
#ifdef  __cplusplus
27
 
extern "C" {
28
 
#endif /* __cplusplus */
29
 
 
30
29
enum enum_vio_type
31
30
{
32
31
  VIO_CLOSED, VIO_TYPE_TCPIP, VIO_TYPE_SOCKET, VIO_TYPE_NAMEDPIPE,
33
32
  VIO_TYPE_SSL, VIO_TYPE_SHARED_MEMORY
34
33
};
35
34
 
 
35
typedef struct st_vio Vio;
36
36
 
37
 
#define VIO_LOCALHOST 1                         /* a localhost connection */
38
37
#define VIO_BUFFERED_READ 2                     /* use buffered read */
39
38
#define VIO_READ_BUFFER_SIZE 16384              /* size of read buffer */
40
39
 
41
 
Vio*    vio_new(int sd, enum enum_vio_type type, uint flags);
 
40
Vio*    drizzleclient_vio_new(int sd, enum enum_vio_type type, unsigned int flags);
42
41
 
43
 
void    vio_delete(Vio* vio);
44
 
int     vio_close(Vio* vio);
45
 
void    vio_reset(Vio* vio, enum enum_vio_type type, int sd, uint32_t flags);
46
 
size_t  vio_read(Vio *vio, uchar *      buf, size_t size);
47
 
size_t  vio_read_buff(Vio *vio, uchar * buf, size_t size);
48
 
size_t  vio_write(Vio *vio, const uchar * buf, size_t size);
49
 
int     vio_blocking(Vio *vio, bool onoff, bool *old_mode);
50
 
bool    vio_is_blocking(Vio *vio);
 
42
void    drizzleclient_vio_delete(Vio* vio);
 
43
int     drizzleclient_vio_close(Vio* vio);
 
44
void    drizzleclient_vio_reset(Vio* vio, enum enum_vio_type type, int sd, uint32_t flags);
 
45
size_t  drizzleclient_vio_read(Vio *vio, unsigned char *        buf, size_t size);
 
46
size_t  drizzleclient_vio_read_buff(Vio *vio, unsigned char * buf, size_t size);
 
47
size_t  drizzleclient_vio_write(Vio *vio, const unsigned char * buf, size_t size);
 
48
int     drizzleclient_vio_blocking(Vio *vio, bool onoff, bool *old_mode);
 
49
bool    drizzleclient_vio_is_blocking(Vio *vio);
51
50
/* setsockopt TCP_NODELAY at IPPROTO_TCP level, when possible */
52
 
int     vio_fastsend(Vio *vio);
 
51
int     drizzleclient_vio_fastsend(Vio *vio);
53
52
/* setsockopt SO_KEEPALIVE at SOL_SOCKET level, when possible */
54
 
int32_t vio_keepalive(Vio *vio, bool    onoff);
 
53
int32_t drizzleclient_vio_keepalive(Vio *vio, bool      onoff);
55
54
/* Whenever we should retry the last read/write operation. */
56
 
bool    vio_should_retry(Vio *vio);
 
55
bool    drizzleclient_vio_should_retry(Vio *vio);
57
56
/* Check that operation was timed out */
58
 
bool    vio_was_interrupted(Vio *vio);
 
57
bool    drizzleclient_vio_was_interrupted(Vio *vio);
59
58
/* Short text description of the socket for those, who are curious.. */
60
 
const char* vio_description(Vio *vio);
 
59
const char* drizzleclient_vio_description(Vio *vio);
61
60
/* Return the type of the connection */
62
 
enum enum_vio_type vio_type(Vio* vio);
 
61
enum enum_vio_type drizzleclient_vio_type(Vio* vio);
63
62
/* Return last error number */
64
 
int     vio_errno(Vio*vio);
 
63
int     drizzleclient_vio_errno(Vio*vio);
65
64
/* Get socket number */
66
 
int vio_fd(Vio*vio);
 
65
int drizzleclient_vio_fd(Vio*vio);
67
66
/* Remote peer's address and name in text form */
68
 
bool vio_peer_addr(Vio *vio, char *buf, uint16_t *port, size_t buflen);
69
 
bool vio_poll_read(Vio *vio, int timeout);
70
 
bool vio_peek_read(Vio *vio, uint *bytes);
71
 
 
72
 
void vio_end(void);
73
 
 
74
 
#ifdef  __cplusplus
75
 
}
76
 
#endif
 
67
bool drizzleclient_vio_peer_addr(Vio *vio, char *buf, uint16_t *port, size_t buflen);
 
68
bool drizzleclient_vio_poll_read(Vio *vio, int timeout);
 
69
bool drizzleclient_vio_peek_read(Vio *vio, unsigned int *bytes);
 
70
 
 
71
void drizzleclient_vio_end(void);
 
72
 
 
73
void drizzleclient_vio_ignore_timeout(Vio *vio, bool is_sndtimeo, int32_t timeout);
 
74
void drizzleclient_vio_timeout(Vio *vio, bool is_sndtimeo, int32_t timeout);
77
75
 
78
76
#if !defined(DONT_MAP_VIO)
79
 
#define vio_delete(vio)                         (vio)->viodelete(vio)
80
 
#define vio_errno(vio)                          (vio)->vioerrno(vio)
81
 
#define vio_read(vio, buf, size)                ((vio)->read)(vio,buf,size)
82
 
#define vio_write(vio, buf, size)               ((vio)->write)(vio, buf, size)
83
 
#define vio_blocking(vio, set_blocking_mode, old_mode)\
 
77
#define drizzleclient_vio_delete(vio)                   (vio)->viodelete(vio)
 
78
#define drizzleclient_vio_errno(vio)                            (vio)->vioerrno(vio)
 
79
#define drizzleclient_vio_read(vio, buf, size)                ((vio)->read)(vio,buf,size)
 
80
#define drizzleclient_vio_write(vio, buf, size)               ((vio)->write)(vio, buf, size)
 
81
#define drizzleclient_vio_blocking(vio, set_blocking_mode, old_mode)\
84
82
        (vio)->vioblocking(vio, set_blocking_mode, old_mode)
85
 
#define vio_is_blocking(vio)                    (vio)->is_blocking(vio)
86
 
#define vio_fastsend(vio)                       (vio)->fastsend(vio)
87
 
#define vio_keepalive(vio, set_keep_alive)      (vio)->viokeepalive(vio, set_keep_alive)
88
 
#define vio_should_retry(vio)                   (vio)->should_retry(vio)
89
 
#define vio_was_interrupted(vio)                (vio)->was_interrupted(vio)
90
 
#define vio_close(vio)                          ((vio)->vioclose)(vio)
91
 
#define vio_peer_addr(vio, buf, prt, buflen)    (vio)->peer_addr(vio, buf, prt, buflen)
92
 
#define vio_timeout(vio, which, seconds)        (vio)->timeout(vio, which, seconds)
 
83
#define drizzleclient_vio_is_blocking(vio)                      (vio)->is_blocking(vio)
 
84
#define drizzleclient_vio_fastsend(vio)                 (vio)->fastsend(vio)
 
85
#define drizzleclient_vio_keepalive(vio, set_keep_alive)        (vio)->viokeepalive(vio, set_keep_alive)
 
86
#define drizzleclient_vio_should_retry(vio)                     (vio)->should_retry(vio)
 
87
#define drizzleclient_vio_was_interrupted(vio)          (vio)->was_interrupted(vio)
 
88
#define drizzleclient_vio_close(vio)                            ((vio)->vioclose)(vio)
 
89
#define drizzleclient_vio_peer_addr(vio, buf, prt, buflen)      (vio)->peer_addr(vio, buf, prt, buflen)
 
90
#define drizzleclient_vio_timeout(vio, which, seconds)  (vio)->timeout(vio, which, seconds)
93
91
#endif /* !defined(DONT_MAP_VIO) */
94
92
 
95
93
/* This enumerator is used in parser - should be always visible */
102
100
  SSL_TYPE_SPECIFIED
103
101
};
104
102
 
105
 
 
106
103
/* HFTODO - hide this if we don't want client in embedded server */
107
104
/* This structure is for every connection on both sides */
108
105
struct st_vio
121
118
  /* function pointers. They are similar for socket/SSL/whatever */
122
119
  void    (*viodelete)(Vio*);
123
120
  int32_t     (*vioerrno)(Vio*);
124
 
  size_t  (*read)(Vio*, uchar *, size_t);
125
 
  size_t  (*write)(Vio*, const uchar *, size_t);
 
121
  size_t  (*read)(Vio*, unsigned char *, size_t);
 
122
  size_t  (*write)(Vio*, const unsigned char *, size_t);
126
123
  int32_t     (*vioblocking)(Vio*, bool, bool *);
127
124
  bool (*is_blocking)(Vio*);
128
125
  int32_t     (*viokeepalive)(Vio*, bool);
133
130
  bool (*was_interrupted)(Vio*);
134
131
  int32_t     (*vioclose)(Vio*);
135
132
  void    (*timeout)(Vio*, bool is_sndtimeo, int32_t timeout);
136
 
  char                  *read_buffer;   /* buffer for vio_read_buff */
 
133
  char                  *read_buffer;   /* buffer for drizzleclient_vio_read_buff */
137
134
};
138
 
#endif /* vio_violite_h_ */
 
135
 
 
136
#endif /* PLUGIN_DRIZZLE_PROTOCOL_VIO_H */