← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to include/violite.h

  • Committer: Brian Aker
  • Date: 2008-07-08 16:17:31 UTC
  • Revision ID: brian@tangent.org-20080708161731-io36j7igglok79py
DATE cleanup.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/violite.h
18
18
 * Purpose: include file for Vio that will work with C and C++
19
19
 */
20
20
 
21
 
#ifndef PLUGIN_DRIZZLE_PROTOCOL_VIO_H
22
 
#define PLUGIN_DRIZZLE_PROTOCOL_VIO_H
23
 
 
24
 
#include <sys/socket.h>
25
 
#include <errno.h>
26
 
 
27
 
namespace drizzle_protocol
28
 
{
 
21
#ifndef vio_violite_h_
 
22
#define vio_violite_h_
 
23
 
 
24
#include "my_net.h"                     /* needed because of struct in_addr */
 
25
 
29
26
 
30
27
/* Simple vio interface in C;  The functions are implemented in violite.c */
31
28
 
 
29
#ifdef  __cplusplus
 
30
extern "C" {
 
31
#endif /* __cplusplus */
 
32
 
32
33
enum enum_vio_type
33
34
{
34
35
  VIO_CLOSED, VIO_TYPE_TCPIP, VIO_TYPE_SOCKET, VIO_TYPE_NAMEDPIPE,
35
36
  VIO_TYPE_SSL, VIO_TYPE_SHARED_MEMORY
36
37
};
37
38
 
38
 
typedef struct st_vio Vio;
39
39
 
 
40
#define VIO_LOCALHOST 1                         /* a localhost connection */
40
41
#define VIO_BUFFERED_READ 2                     /* use buffered read */
41
42
#define VIO_READ_BUFFER_SIZE 16384              /* size of read buffer */
42
43
 
43
 
Vio*    drizzleclient_vio_new(int sd, enum enum_vio_type type, unsigned int flags);
 
44
Vio*    vio_new(my_socket sd, enum enum_vio_type type, uint flags);
 
45
#define HANDLE void *
44
46
 
45
 
void    drizzleclient_vio_delete(Vio* vio);
46
 
int     drizzleclient_vio_close(Vio* vio);
47
 
void    drizzleclient_vio_reset(Vio* vio, enum enum_vio_type type, int sd, uint32_t flags);
48
 
size_t  drizzleclient_vio_read(Vio *vio, unsigned char *        buf, size_t size);
49
 
size_t  drizzleclient_vio_read_buff(Vio *vio, unsigned char * buf, size_t size);
50
 
size_t  drizzleclient_vio_write(Vio *vio, const unsigned char * buf, size_t size);
51
 
int     drizzleclient_vio_blocking(Vio *vio, bool onoff, bool *old_mode);
52
 
bool    drizzleclient_vio_is_blocking(Vio *vio);
 
47
void    vio_delete(Vio* vio);
 
48
int     vio_close(Vio* vio);
 
49
void    vio_reset(Vio* vio, enum enum_vio_type type,
 
50
                  my_socket sd, HANDLE hPipe, uint flags);
 
51
size_t  vio_read(Vio *vio, uchar *      buf, size_t size);
 
52
size_t  vio_read_buff(Vio *vio, uchar * buf, size_t size);
 
53
size_t  vio_write(Vio *vio, const uchar * buf, size_t size);
 
54
int     vio_blocking(Vio *vio, my_bool onoff, my_bool *old_mode);
 
55
my_bool vio_is_blocking(Vio *vio);
53
56
/* setsockopt TCP_NODELAY at IPPROTO_TCP level, when possible */
54
 
int     drizzleclient_vio_fastsend(Vio *vio);
 
57
int     vio_fastsend(Vio *vio);
55
58
/* setsockopt SO_KEEPALIVE at SOL_SOCKET level, when possible */
56
 
int32_t drizzleclient_vio_keepalive(Vio *vio, bool      onoff);
 
59
int     vio_keepalive(Vio *vio, my_bool onoff);
57
60
/* Whenever we should retry the last read/write operation. */
58
 
bool    drizzleclient_vio_should_retry(Vio *vio);
 
61
my_bool vio_should_retry(Vio *vio);
59
62
/* Check that operation was timed out */
60
 
bool    drizzleclient_vio_was_interrupted(Vio *vio);
 
63
my_bool vio_was_interrupted(Vio *vio);
61
64
/* Short text description of the socket for those, who are curious.. */
62
 
const char* drizzleclient_vio_description(Vio *vio);
 
65
const char* vio_description(Vio *vio);
63
66
/* Return the type of the connection */
64
 
enum enum_vio_type drizzleclient_vio_type(Vio* vio);
 
67
enum enum_vio_type vio_type(Vio* vio);
65
68
/* Return last error number */
66
 
int     drizzleclient_vio_errno(Vio*vio);
 
69
int     vio_errno(Vio*vio);
67
70
/* Get socket number */
68
 
int drizzleclient_vio_fd(Vio*vio);
 
71
my_socket vio_fd(Vio*vio);
69
72
/* Remote peer's address and name in text form */
70
 
bool drizzleclient_vio_peer_addr(Vio *vio, char *buf, uint16_t *port, size_t buflen);
71
 
bool drizzleclient_vio_poll_read(Vio *vio, int timeout);
72
 
bool drizzleclient_vio_peek_read(Vio *vio, unsigned int *bytes);
73
 
 
74
 
void drizzleclient_vio_end(void);
75
 
 
76
 
void drizzleclient_vio_ignore_timeout(Vio *vio, bool is_sndtimeo, int32_t timeout);
77
 
void drizzleclient_vio_timeout(Vio *vio, bool is_sndtimeo, int32_t timeout);
 
73
my_bool vio_peer_addr(Vio *vio, char *buf, uint16 *port, size_t buflen);
 
74
my_bool vio_poll_read(Vio *vio,uint timeout);
 
75
my_bool vio_peek_read(Vio *vio, uint *bytes);
 
76
 
 
77
#ifdef HAVE_SMEM
 
78
size_t vio_read_shared_memory(Vio *vio, uchar * buf, size_t size);
 
79
size_t vio_write_shared_memory(Vio *vio, const uchar * buf, size_t size);
 
80
int vio_close_shared_memory(Vio * vio);
 
81
#endif
 
82
 
 
83
void vio_end(void);
 
84
 
 
85
#ifdef  __cplusplus
 
86
}
 
87
#endif
78
88
 
79
89
#if !defined(DONT_MAP_VIO)
80
 
#define drizzleclient_vio_delete(vio)                   (vio)->viodelete(vio)
81
 
#define drizzleclient_vio_errno(vio)                            (vio)->vioerrno(vio)
82
 
#define drizzleclient_vio_read(vio, buf, size)                ((vio)->read)(vio,buf,size)
83
 
#define drizzleclient_vio_write(vio, buf, size)               ((vio)->write)(vio, buf, size)
84
 
#define drizzleclient_vio_blocking(vio, set_blocking_mode, old_mode)\
 
90
#define vio_delete(vio)                         (vio)->viodelete(vio)
 
91
#define vio_errno(vio)                          (vio)->vioerrno(vio)
 
92
#define vio_read(vio, buf, size)                ((vio)->read)(vio,buf,size)
 
93
#define vio_write(vio, buf, size)               ((vio)->write)(vio, buf, size)
 
94
#define vio_blocking(vio, set_blocking_mode, old_mode)\
85
95
        (vio)->vioblocking(vio, set_blocking_mode, old_mode)
86
 
#define drizzleclient_vio_is_blocking(vio)                      (vio)->is_blocking(vio)
87
 
#define drizzleclient_vio_fastsend(vio)                 (vio)->fastsend(vio)
88
 
#define drizzleclient_vio_keepalive(vio, set_keep_alive)        (vio)->viokeepalive(vio, set_keep_alive)
89
 
#define drizzleclient_vio_should_retry(vio)                     (vio)->should_retry(vio)
90
 
#define drizzleclient_vio_was_interrupted(vio)          (vio)->was_interrupted(vio)
91
 
#define drizzleclient_vio_close(vio)                            ((vio)->vioclose)(vio)
92
 
#define drizzleclient_vio_peer_addr(vio, buf, prt, buflen)      (vio)->peer_addr(vio, buf, prt, buflen)
93
 
#define drizzleclient_vio_timeout(vio, which, seconds)  (vio)->timeout(vio, which, seconds)
 
96
#define vio_is_blocking(vio)                    (vio)->is_blocking(vio)
 
97
#define vio_fastsend(vio)                       (vio)->fastsend(vio)
 
98
#define vio_keepalive(vio, set_keep_alive)      (vio)->viokeepalive(vio, set_keep_alive)
 
99
#define vio_should_retry(vio)                   (vio)->should_retry(vio)
 
100
#define vio_was_interrupted(vio)                (vio)->was_interrupted(vio)
 
101
#define vio_close(vio)                          ((vio)->vioclose)(vio)
 
102
#define vio_peer_addr(vio, buf, prt, buflen)    (vio)->peer_addr(vio, buf, prt, buflen)
 
103
#define vio_timeout(vio, which, seconds)        (vio)->timeout(vio, which, seconds)
94
104
#endif /* !defined(DONT_MAP_VIO) */
95
105
 
96
106
/* This enumerator is used in parser - should be always visible */
103
113
  SSL_TYPE_SPECIFIED
104
114
};
105
115
 
 
116
 
106
117
/* HFTODO - hide this if we don't want client in embedded server */
107
118
/* This structure is for every connection on both sides */
108
119
struct st_vio
109
120
{
110
 
  int           sd;             /* int - real or imaginary */
 
121
  my_socket             sd;             /* my_socket - real or imaginary */
 
122
  HANDLE hPipe;
 
123
  my_bool               localhost;      /* Are we from localhost? */
111
124
  int                   fcntl_mode;     /* Buffered fcntl(sd,F_GETFL) */
112
125
  struct sockaddr_storage       local;          /* Local internet address */
113
126
  struct sockaddr_storage       remote;         /* Remote internet address */
114
127
  int addrLen;                          /* Length of remote address */
115
128
  enum enum_vio_type    type;           /* Type of connection */
116
129
  char                  desc[30];       /* String description */
 
130
  char                  *read_buffer;   /* buffer for vio_read_buff */
117
131
  char                  *read_pos;      /* start of unfetched data in the
118
132
                                           read buffer */
119
133
  char                  *read_end;      /* end of unfetched data */
120
 
 
121
134
  /* function pointers. They are similar for socket/SSL/whatever */
122
135
  void    (*viodelete)(Vio*);
123
 
  int32_t     (*vioerrno)(Vio*);
124
 
  size_t  (*read)(Vio*, unsigned char *, size_t);
125
 
  size_t  (*write)(Vio*, const unsigned char *, size_t);
126
 
  int32_t     (*vioblocking)(Vio*, bool, bool *);
127
 
  bool (*is_blocking)(Vio*);
128
 
  int32_t     (*viokeepalive)(Vio*, bool);
129
 
  int32_t     (*fastsend)(Vio*);
130
 
  bool (*peer_addr)(Vio*, char *, uint16_t *, size_t);
 
136
  int     (*vioerrno)(Vio*);
 
137
  size_t  (*read)(Vio*, uchar *, size_t);
 
138
  size_t  (*write)(Vio*, const uchar *, size_t);
 
139
  int     (*vioblocking)(Vio*, my_bool, my_bool *);
 
140
  my_bool (*is_blocking)(Vio*);
 
141
  int     (*viokeepalive)(Vio*, my_bool);
 
142
  int     (*fastsend)(Vio*);
 
143
  my_bool (*peer_addr)(Vio*, char *, uint16*, size_t);
131
144
  void    (*in_addr)(Vio*, struct sockaddr_storage*);
132
 
  bool (*should_retry)(Vio*);
133
 
  bool (*was_interrupted)(Vio*);
134
 
  int32_t     (*vioclose)(Vio*);
135
 
  void    (*timeout)(Vio*, bool is_sndtimeo, int32_t timeout);
136
 
  char                  *read_buffer;   /* buffer for drizzleclient_vio_read_buff */
 
145
  my_bool (*should_retry)(Vio*);
 
146
  my_bool (*was_interrupted)(Vio*);
 
147
  int     (*vioclose)(Vio*);
 
148
  void    (*timeout)(Vio*, unsigned int which, unsigned int timeout);
 
149
#ifdef HAVE_SMEM
 
150
  HANDLE  handle_file_map;
 
151
  char    *handle_map;
 
152
  HANDLE  event_server_wrote;
 
153
  HANDLE  event_server_read;
 
154
  HANDLE  event_client_wrote;
 
155
  HANDLE  event_client_read;
 
156
  HANDLE  event_conn_closed;
 
157
  size_t  shared_memory_remain;
 
158
  char    *shared_memory_pos;
 
159
  NET     *net;
 
160
#endif /* HAVE_SMEM */
137
161
};
138
 
 
139
 
} /* namespace drizzle_procotol */
140
 
 
141
 
#endif /* PLUGIN_DRIZZLE_PROTOCOL_VIO_H */
 
162
#endif /* vio_violite_h_ */