← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/mysql_protocol/vio.h

  • Committer: Andrew Hutchings
  • Date: 2010-11-01 22:14:18 UTC
  • mto: This revision was merged to the branch mainline in revision 1907.
  • Revision ID: andrew@linuxjedi.co.uk-20101101221418-9n9gmm4ms7fl8vo5
Fix copyright

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/mysql_protocol/vio.h
11
11
 
12
12
   You should have received a copy of the GNU General Public License
13
13
   along with this program; if not, write to the Free Software
14
 
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
 
14
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA */
15
15
 
16
 
/*
17
 
 * Virtual I/O layer, only used with TCP/IP sockets at the moment.
18
 
 */
19
16
 
20
17
#ifndef PLUGIN_MYSQL_PROTOCOL_VIO_H
21
18
#define PLUGIN_MYSQL_PROTOCOL_VIO_H
23
20
#include <sys/socket.h>
24
21
#include <errno.h>
25
22
 
26
 
typedef struct st_vio Vio;
27
 
 
28
 
struct st_vio
 
23
/**
 
24
 *@brief Virtual I/O layer, only used with TCP/IP sockets at the moment.
 
25
 */
 
26
class Vio
29
27
{
 
28
public:
 
29
  /**
 
30
   * Constructor. 
 
31
   * @param[in] sd Descriptor to use.
 
32
   */
 
33
  Vio(int sd);
 
34
  ~Vio();
 
35
 
 
36
  /**
 
37
   *Close the connection.
 
38
   *@returns 0 on success.
 
39
   */
 
40
  int close();
 
41
 
 
42
  /**
 
43
   * Read some data from the remote end.
 
44
   *@param[out] buf A buffer to write the new data to.
 
45
   *@param[in] size The size of the buffer
 
46
   *@returns The number of bytes read.
 
47
   */
 
48
  size_t read(unsigned char* buf, size_t size);
 
49
  
 
50
  /**
 
51
   * Write some data to the remote end.
 
52
   *@param[in] buf A buffer that contains the data to send.
 
53
   *@param[in] size The size of the buffer
 
54
   *@returns The number of bytes written.
 
55
   */
 
56
  size_t write(const unsigned char* buf, size_t size);
 
57
 
 
58
  /**
 
59
   * Set device blocking mode.
 
60
   *@param[in] set_blocking_mode Whether the device should block. true sets blocking mode, false clears it.
 
61
   *@param[out] old_mode This will be set to the previous blocking mode.
 
62
   *@returns 0 on success.
 
63
   */
 
64
  int blocking(bool set_blocking_mode, bool *old_mode);
 
65
 
 
66
  /**
 
67
   * Enables fast sending.
 
68
   * Setting this sets the TCP_NODELAY socket option.
 
69
   *@returns 0 on succcess.
 
70
   */
 
71
  int fastsend();
 
72
 
 
73
  /**
 
74
   * Sets or clears the keepalive option.
 
75
   *@param[in] set_keep_alive Whether to set or clear the flag. True Sets keepalive, false clears it.
 
76
   *@returns 0 on success.
 
77
   */
 
78
  int32_t keepalive(bool set_keep_alive);
 
79
 
 
80
  /**
 
81
   *@returns true if the caller should retry the last operation.
 
82
   */
 
83
  bool should_retry() const;
 
84
 
 
85
  /**
 
86
   *@returns true if the last operation was interrupted.
 
87
   */
 
88
  bool was_interrupted() const;
 
89
 
 
90
  /**
 
91
   *Gets the address details of the peer.
 
92
   @param[out] buf Buffer that will recieve the peer address.
 
93
   @param[out] port Port of remote end.
 
94
   @param[in] buflen Size of buf.
 
95
   @returns True on success, false otherwise.
 
96
   */
 
97
  bool peer_addr(char *buf, uint16_t *port, size_t buflen) const;
 
98
 
 
99
  /**
 
100
   * Sets either the send, or recieve timeouts for the socket.
 
101
   *@param[in] is_sndtimeo Set to true to change the send timeout, false to change the recieve timeout.
 
102
   *@param[in] timeout The new timeout to set, in seconds.
 
103
   */
 
104
  void timeout(bool is_sndtimeo, int32_t timeout);
 
105
 
 
106
  /**
 
107
   * Returns the last error code.
 
108
   *@returns the last error code, as described in errno.h
 
109
   */
 
110
  int get_errno() const;
 
111
 
 
112
  /**
 
113
   * Get the underlying descriptor this class is using.
 
114
   *@returns The descriptor passed in to the constructor of this class.
 
115
   */
 
116
  int get_fd() const;
 
117
 
 
118
  /**
 
119
   * Returns the current read position.
 
120
   */
 
121
  char *get_read_pos() const;
 
122
 
 
123
  /**
 
124
   * Returns the current write position.
 
125
   */
 
126
  char *get_read_end() const;
 
127
 
 
128
private:
30
129
  bool closed;
31
130
  int sd;
32
131
  int fcntl_mode; /* Buffered fcntl(sd,F_GETFL) */
33
132
  struct sockaddr_storage local; /* Local internet address */
34
133
  struct sockaddr_storage remote; /* Remote internet address */
35
 
  int addrLen; /* Length of remote address */
36
134
  char *read_pos; /* start of unfetched data in the read buffer */
37
135
  char *read_end; /* end of unfetched data */
38
136
 
39
 
  /* 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*);
47
 
  bool (*peer_addr)(Vio*, char *, uint16_t *, size_t);
48
 
  void (*in_addr)(Vio*, struct sockaddr_storage*);
49
 
  bool (*should_retry)(Vio*);
50
 
  bool (*was_interrupted)(Vio*);
51
 
  int32_t (*vioclose)(Vio*);
52
 
  void (*timeout)(Vio*, bool is_sndtimeo, int32_t timeout);
53
137
};
54
138
 
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
139
 
71
140
#endif /* PLUGIN_MYSQL_PROTOCOL_VIO_H */