← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to vio/violite.h

  • Committer: Monty Taylor
  • Date: 2008-08-15 20:01:00 UTC
  • Revision ID: monty@inaugust.com-20080815200100-tht5d421maap6kjp
Updated POTFILES with local_infile.c.

Show diffs side-by-side

added added

removed removed

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