home *** CD-ROM | disk | FTP | other *** search
/ Chip 2001 January / Chip_2001-01_cd1.bin / tema / mysql / mysql-3.23.28g-win-source.exe / include / violite.h < prev    next >
C/C++ Source or Header  |  2000-11-14  |  3KB  |  119 lines
  1. /* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
  2.    
  3.    This library is free software; you can redistribute it and/or
  4.    modify it under the terms of the GNU Library General Public
  5.    License as published by the Free Software Foundation; either
  6.    version 2 of the License, or (at your option) any later version.
  7.    
  8.    This library is distributed in the hope that it will be useful,
  9.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11.    Library General Public License for more details.
  12.    
  13.    You should have received a copy of the GNU Library General Public
  14.    License along with this library; if not, write to the Free
  15.    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  16.    MA 02111-1307, USA */
  17.  
  18. /*
  19.  * Vio Lite.
  20.  * Purpose: include file for Vio that will work with C and C++
  21.  */
  22.  
  23. #ifndef vio_violite_h_
  24. #define    vio_violite_h_
  25.  
  26. #include "my_net.h"            /* needed because of struct in_addr */
  27.  
  28. #ifdef HAVE_VIO
  29. #include <Vio.h>                /* Full VIO interface */
  30. #else
  31.  
  32. /* Simple vio interface in C;  The functions are implemented in violite.c */
  33.  
  34. #ifdef    __cplusplus
  35. extern "C" {
  36. #endif /* __cplusplus */
  37.  
  38. #ifndef Vio_defined
  39. #define Vio_defined
  40. struct st_vio;                    /* Only C */
  41. typedef struct st_vio Vio;
  42. #endif
  43.  
  44. enum enum_vio_type { VIO_CLOSED, VIO_TYPE_TCPIP, VIO_TYPE_SOCKET,
  45.              VIO_TYPE_NAMEDPIPE, VIO_TYPE_SSL};
  46.  
  47. Vio*        vio_new(my_socket    sd,
  48.             enum enum_vio_type type,
  49.             my_bool        localhost);
  50. #ifdef __WIN__
  51. Vio*        vio_new_win32pipe(HANDLE hPipe);
  52. #endif
  53. void        vio_delete(Vio* vio);
  54.  
  55. /*
  56.  * vio_read and vio_write should have the same semantics
  57.  * as read(2) and write(2).
  58.  */
  59. int        vio_read(        Vio*        vio,
  60.                     gptr        buf,    int    size);
  61. int        vio_write(        Vio*        vio,
  62.                     const gptr    buf,
  63.                     int        size);
  64. /*
  65.  * Whenever the socket is set to blocking mode or not.
  66.  */
  67. int        vio_blocking(        Vio*        vio,
  68.                     my_bool        onoff);
  69. my_bool        vio_is_blocking(    Vio*        vio);
  70. /*
  71.  * setsockopt TCP_NODELAY at IPPROTO_TCP level, when possible.
  72.  */
  73. int        vio_fastsend(        Vio*        vio,
  74.                     my_bool        onoff);
  75. /*
  76.  * setsockopt SO_KEEPALIVE at SOL_SOCKET level, when possible.
  77.  */
  78. int        vio_keepalive(        Vio*        vio,
  79.                     my_bool        onoff);
  80. /*
  81.  * Whenever we should retry the last read/write operation.
  82.  */
  83. my_bool        vio_should_retry(    Vio*        vio);
  84. /*
  85.  * When the workday is over...
  86.  */
  87. int        vio_close(        Vio*        vio);
  88. /*
  89.  * Short text description of the socket for those, who are curious..
  90.  */
  91. const char*    vio_description(    Vio*        vio);
  92.  
  93. /* Return the type of the connection */
  94.  enum enum_vio_type vio_type(Vio* vio);
  95.  
  96. /* Return last error number */
  97. int vio_errno(Vio *vio);
  98.  
  99. /* Get socket number */
  100. my_socket vio_fd(Vio *vio);
  101.  
  102. /*
  103.  * Remote peer's address and name in text form.
  104.  */
  105. my_bool vio_peer_addr(Vio * vio, char *buf);
  106.  
  107. /* Remotes in_addr */
  108.  
  109. void vio_in_addr(Vio *vio, struct in_addr *in);
  110.  
  111.   /* Return 1 if there is data to be read */
  112. my_bool vio_poll_read(Vio *vio,uint timeout);
  113.  
  114. #ifdef    __cplusplus
  115. }
  116. #endif
  117. #endif /* HAVE_VIO */
  118. #endif /* vio_violite_h_ */
  119.