← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/mysql_protocol/vio.h

  • Committer: Brian Aker
  • Date: 2010-02-15 18:29:31 UTC
  • mto: (1273.13.68 build)
  • mto: This revision was merged to the branch mainline in revision 1303.
  • Revision ID: brian@gaz-20100215182931-ooy48h72plspoehy
More removal of show code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/mysql_protocol/vio.h
14
14
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
15
15
 
16
16
/*
17
 
 * Virtual I/O layer, only used with TCP/IP sockets at the moment.
 
17
 * Vio Lite.
 
18
 * Purpose: include file for Vio that will work with C and C++
18
19
 */
19
20
 
20
21
#ifndef PLUGIN_MYSQL_PROTOCOL_VIO_H
21
 
#define PLUGIN_MYSQL_PROTOCOL_VIO_H
 
22
#define PLUGIN_MYSQL_PROTOCOL_VIO_H
22
23
 
23
24
#include <sys/socket.h>
24
25
#include <errno.h>
25
26
 
 
27
/* Simple vio interface in C;  The functions are implemented in violite.c */
 
28
 
 
29
enum enum_vio_type
 
30
{
 
31
  VIO_CLOSED, VIO_TYPE_TCPIP, VIO_TYPE_SOCKET, VIO_TYPE_NAMEDPIPE,
 
32
  VIO_TYPE_SSL, VIO_TYPE_SHARED_MEMORY
 
33
};
 
34
 
26
35
typedef struct st_vio Vio;
27
36
 
 
37
#define VIO_BUFFERED_READ 2                     /* use buffered read */
 
38
#define VIO_READ_BUFFER_SIZE 16384              /* size of read buffer */
 
39
 
 
40
Vio*    drizzleclient_vio_new(int sd, enum enum_vio_type type, unsigned int flags);
 
41
 
 
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);
 
50
/* setsockopt TCP_NODELAY at IPPROTO_TCP level, when possible */
 
51
int     drizzleclient_vio_fastsend(Vio *vio);
 
52
/* setsockopt SO_KEEPALIVE at SOL_SOCKET level, when possible */
 
53
int32_t drizzleclient_vio_keepalive(Vio *vio, bool      onoff);
 
54
/* Whenever we should retry the last read/write operation. */
 
55
bool    drizzleclient_vio_should_retry(Vio *vio);
 
56
/* Check that operation was timed out */
 
57
bool    drizzleclient_vio_was_interrupted(Vio *vio);
 
58
/* Short text description of the socket for those, who are curious.. */
 
59
const char* drizzleclient_vio_description(Vio *vio);
 
60
/* Return the type of the connection */
 
61
enum enum_vio_type drizzleclient_vio_type(Vio* vio);
 
62
/* Return last error number */
 
63
int     drizzleclient_vio_errno(Vio*vio);
 
64
/* Get socket number */
 
65
int drizzleclient_vio_fd(Vio*vio);
 
66
/* Remote peer's address and name in text form */
 
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);
 
75
 
 
76
#if !defined(DONT_MAP_VIO)
 
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)\
 
82
        (vio)->vioblocking(vio, set_blocking_mode, old_mode)
 
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)
 
91
#endif /* !defined(DONT_MAP_VIO) */
 
92
 
 
93
/* This enumerator is used in parser - should be always visible */
 
94
enum SSL_type
 
95
{
 
96
  SSL_TYPE_NOT_SPECIFIED= -1,
 
97
  SSL_TYPE_NONE,
 
98
  SSL_TYPE_ANY,
 
99
  SSL_TYPE_X509,
 
100
  SSL_TYPE_SPECIFIED
 
101
};
 
102
 
 
103
/* HFTODO - hide this if we don't want client in embedded server */
 
104
/* This structure is for every connection on both sides */
28
105
struct st_vio
29
106
{
30
 
  bool closed;
31
 
  int sd;
32
 
  int fcntl_mode; /* Buffered fcntl(sd,F_GETFL) */
33
 
  struct sockaddr_storage local; /* Local internet address */
34
 
  struct sockaddr_storage remote; /* Remote internet address */
35
 
  int addrLen; /* Length of remote address */
36
 
  char *read_pos; /* start of unfetched data in the read buffer */
37
 
  char *read_end; /* end of unfetched data */
 
107
  int           sd;             /* int - real or imaginary */
 
108
  int                   fcntl_mode;     /* Buffered fcntl(sd,F_GETFL) */
 
109
  struct sockaddr_storage       local;          /* Local internet address */
 
110
  struct sockaddr_storage       remote;         /* Remote internet address */
 
111
  int addrLen;                          /* Length of remote address */
 
112
  enum enum_vio_type    type;           /* Type of connection */
 
113
  char                  desc[30];       /* String description */
 
114
  char                  *read_pos;      /* start of unfetched data in the
 
115
                                           read buffer */
 
116
  char                  *read_end;      /* end of unfetched data */
38
117
 
39
118
  /* function pointers. They are similar for socket/SSL/whatever */
40
 
  void (*viodelete)(Vio*);
41
 
  int32_t (*vioerrno)(Vio*);
42
 
  size_t (*read)(Vio*, unsigned char *, size_t);
43
 
  size_t (*write)(Vio*, const unsigned char *, size_t);
44
 
  int32_t (*vioblocking)(Vio*, bool, bool *);
45
 
  int32_t (*viokeepalive)(Vio*, bool);
46
 
  int32_t (*fastsend)(Vio*);
 
119
  void    (*viodelete)(Vio*);
 
120
  int32_t     (*vioerrno)(Vio*);
 
121
  size_t  (*read)(Vio*, unsigned char *, size_t);
 
122
  size_t  (*write)(Vio*, const unsigned char *, size_t);
 
123
  int32_t     (*vioblocking)(Vio*, bool, bool *);
 
124
  bool (*is_blocking)(Vio*);
 
125
  int32_t     (*viokeepalive)(Vio*, bool);
 
126
  int32_t     (*fastsend)(Vio*);
47
127
  bool (*peer_addr)(Vio*, char *, uint16_t *, size_t);
48
 
  void (*in_addr)(Vio*, struct sockaddr_storage*);
 
128
  void    (*in_addr)(Vio*, struct sockaddr_storage*);
49
129
  bool (*should_retry)(Vio*);
50
130
  bool (*was_interrupted)(Vio*);
51
 
  int32_t (*vioclose)(Vio*);
52
 
  void (*timeout)(Vio*, bool is_sndtimeo, int32_t timeout);
 
131
  int32_t     (*vioclose)(Vio*);
 
132
  void    (*timeout)(Vio*, bool is_sndtimeo, int32_t timeout);
 
133
  char                  *read_buffer;   /* buffer for drizzleclient_vio_read_buff */
53
134
};
54
135
 
55
 
Vio* mysql_protocol_vio_new(int sd);
56
 
 
57
 
#define vio_fd(vio) (vio)->sd
58
 
#define vio_delete(vio) (vio)->viodelete(vio)
59
 
#define vio_errno(vio) (vio)->vioerrno(vio)
60
 
#define vio_read(vio, buf, size) ((vio)->read)(vio,buf,size)
61
 
#define vio_write(vio, buf, size) ((vio)->write)(vio, buf, size)
62
 
#define vio_blocking(vio, set_blocking_mode, old_mode) (vio)->vioblocking(vio, set_blocking_mode, old_mode)
63
 
#define vio_fastsend(vio) (vio)->fastsend(vio)
64
 
#define vio_keepalive(vio, set_keep_alive) (vio)->viokeepalive(vio, set_keep_alive)
65
 
#define vio_should_retry(vio) (vio)->should_retry(vio)
66
 
#define vio_was_interrupted(vio) (vio)->was_interrupted(vio)
67
 
#define vio_close(vio) ((vio)->vioclose)(vio)
68
 
#define vio_peer_addr(vio, buf, prt, buflen) (vio)->peer_addr(vio, buf, prt, buflen)
69
 
#define vio_timeout(vio, which, seconds) (vio)->timeout(vio, which, seconds)
70
 
 
71
136
#endif /* PLUGIN_MYSQL_PROTOCOL_VIO_H */