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 / mysql_com.h < prev    next >
C/C++ Source or Header  |  2000-09-16  |  9KB  |  244 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. ** Common definition between mysql server & client
  20. */
  21.  
  22. #ifndef _mysql_com_h
  23. #define _mysql_com_h
  24.  
  25.  
  26. #define NAME_LEN    64        /* Field/table name length */
  27. #define HOSTNAME_LENGTH 60
  28. #define USERNAME_LENGTH 16
  29.  
  30. #define LOCAL_HOST    "localhost"
  31. #define LOCAL_HOST_NAMEDPIPE "."
  32.  
  33. #if defined(__EMX__) || defined(__OS2__)
  34. #undef MYSQL_UNIX_ADDR
  35. #define MYSQL_OS2_ADDR "\\socket\\MySQL"
  36. #define MYSQL_UNIX_ADDR MYSQL_OS2_ADDR
  37. #endif
  38. #if defined(__WIN__) && !defined( _CUSTOMCONFIG_)
  39. #define MYSQL_NAMEDPIPE "MySQL"
  40. #define MYSQL_SERVICENAME "MySql"
  41. #endif /* __WIN__ */
  42.  
  43. enum enum_server_command {COM_SLEEP,COM_QUIT,COM_INIT_DB,COM_QUERY,
  44.               COM_FIELD_LIST,COM_CREATE_DB,COM_DROP_DB,COM_REFRESH,
  45.               COM_SHUTDOWN,COM_STATISTICS,
  46.               COM_PROCESS_INFO,COM_CONNECT,COM_PROCESS_KILL,
  47.               COM_DEBUG,COM_PING,COM_TIME,COM_DELAYED_INSERT,
  48.               COM_CHANGE_USER, COM_BINLOG_DUMP,
  49.                           COM_TABLE_DUMP, COM_CONNECT_OUT};
  50.  
  51. #define NOT_NULL_FLAG    1        /* Field can't be NULL */
  52. #define PRI_KEY_FLAG    2        /* Field is part of a primary key */
  53. #define UNIQUE_KEY_FLAG 4        /* Field is part of a unique key */
  54. #define MULTIPLE_KEY_FLAG 8        /* Field is part of a key */
  55. #define BLOB_FLAG    16        /* Field is a blob */
  56. #define UNSIGNED_FLAG    32        /* Field is unsigned */
  57. #define ZEROFILL_FLAG    64        /* Field is zerofill */
  58. #define BINARY_FLAG    128
  59. /* The following are only sent to new clients */
  60. #define ENUM_FLAG    256        /* field is an enum */
  61. #define AUTO_INCREMENT_FLAG 512        /* field is a autoincrement field */
  62. #define TIMESTAMP_FLAG    1024        /* Field is a timestamp */
  63. #define SET_FLAG    2048        /* field is a set */
  64. #define NUM_FLAG    32768        /* Field is num (for clients) */
  65. #define PART_KEY_FLAG    16384        /* Intern; Part of some key */
  66. #define GROUP_FLAG    32768        /* Intern: Group field */
  67. #define UNIQUE_FLAG    65536        /* Intern: Used by sql_yacc */
  68.  
  69. #define REFRESH_GRANT        1    /* Refresh grant tables */
  70. #define REFRESH_LOG        2    /* Start on new log file */
  71. #define REFRESH_TABLES        4    /* close all tables */
  72. #define REFRESH_HOSTS        8    /* Flush host cache */
  73. #define REFRESH_STATUS        16    /* Flush status variables */
  74. #define REFRESH_THREADS        32    /* Flush status variables */
  75. #define REFRESH_SLAVE           64      /* Reset master info and restart slave
  76.                        thread */
  77. #define REFRESH_MASTER          128     /* Remove all bin logs in the index
  78.                        and truncate the index */
  79.  
  80. /* The following can't be set with mysql_refresh() */
  81. #define REFRESH_READ_LOCK    16384    /* Lock tables for read */
  82. #define REFRESH_FAST        32768    /* Intern flag */
  83.  
  84. #define CLIENT_LONG_PASSWORD    1    /* new more secure passwords */
  85. #define CLIENT_FOUND_ROWS    2    /* Found instead of affected rows */
  86. #define CLIENT_LONG_FLAG    4    /* Get all column flags */
  87. #define CLIENT_CONNECT_WITH_DB    8    /* One can specify db on connect */
  88. #define CLIENT_NO_SCHEMA    16    /* Don't allow database.table.column */
  89. #define CLIENT_COMPRESS        32    /* Can use compression protocol */
  90. #define CLIENT_ODBC        64    /* Odbc client */
  91. #define CLIENT_LOCAL_FILES    128    /* Can use LOAD DATA LOCAL */
  92. #define CLIENT_IGNORE_SPACE    256    /* Ignore spaces before '(' */
  93. #define CLIENT_CHANGE_USER    512    /* Support the mysql_change_user() */
  94. #define CLIENT_INTERACTIVE    1024    /* This is an interactive client */
  95. #define CLIENT_SSL              2048     /* Switch to SSL after handshake */
  96. #define CLIENT_IGNORE_SIGPIPE   4096     /* IGNORE sigpipes */
  97. #define CLIENT_TRANSACTIONS    8196    /* Client knows about transactions */
  98.  
  99. #define SERVER_STATUS_IN_TRANS  1    /* Transaction has started */
  100. #define SERVER_STATUS_AUTOCOMMIT 2    /* Server in auto_commit mode */
  101.  
  102. #define MYSQL_ERRMSG_SIZE    200
  103. #define NET_READ_TIMEOUT    30        /* Timeout on read */
  104. #define NET_WRITE_TIMEOUT    60        /* Timeout on write */
  105. #define NET_WAIT_TIMEOUT    8*60*60        /* Wait for new query */
  106.  
  107. #ifndef Vio_defined
  108. #define Vio_defined
  109. #ifdef HAVE_VIO
  110. class Vio;                    /* Fill Vio class in C++ */
  111. #else
  112. struct st_vio;                    /* Only C */
  113. typedef struct st_vio Vio;
  114. #endif
  115. #endif
  116.  
  117. typedef struct st_net {
  118.   Vio* vio;
  119.   my_socket fd;                    /* For Perl DBI/dbd */
  120.   int fcntl;
  121.   unsigned char *buff,*buff_end,*write_pos,*read_pos;
  122.   char last_error[MYSQL_ERRMSG_SIZE];
  123.   unsigned int last_errno,max_packet,timeout,pkt_nr;
  124.   unsigned char error;
  125.   my_bool return_errno,compress;
  126.   my_bool no_send_ok; /* needed if we are doing several
  127.    queries in one command ( as in LOAD TABLE ... FROM MASTER ),
  128.    and do not want to confuse the client with OK at the wrong time
  129.               */
  130.   unsigned long remain_in_buf,length, buf_length, where_b;
  131.   unsigned int *return_status;
  132.   unsigned char reading_or_writing;
  133.   char save_char;
  134. } NET;
  135.  
  136. #define packet_error ((unsigned int) -1)
  137.  
  138. enum enum_field_types { FIELD_TYPE_DECIMAL, FIELD_TYPE_TINY,
  139.             FIELD_TYPE_SHORT,  FIELD_TYPE_LONG,
  140.             FIELD_TYPE_FLOAT,  FIELD_TYPE_DOUBLE,
  141.             FIELD_TYPE_NULL,   FIELD_TYPE_TIMESTAMP,
  142.             FIELD_TYPE_LONGLONG,FIELD_TYPE_INT24,
  143.             FIELD_TYPE_DATE,   FIELD_TYPE_TIME,
  144.             FIELD_TYPE_DATETIME, FIELD_TYPE_YEAR,
  145.             FIELD_TYPE_NEWDATE,
  146.             FIELD_TYPE_ENUM=247,
  147.             FIELD_TYPE_SET=248,
  148.             FIELD_TYPE_TINY_BLOB=249,
  149.             FIELD_TYPE_MEDIUM_BLOB=250,
  150.             FIELD_TYPE_LONG_BLOB=251,
  151.             FIELD_TYPE_BLOB=252,
  152.             FIELD_TYPE_VAR_STRING=253,
  153.             FIELD_TYPE_STRING=254
  154. };
  155.  
  156. #define FIELD_TYPE_CHAR FIELD_TYPE_TINY        /* For compability */
  157. #define FIELD_TYPE_INTERVAL FIELD_TYPE_ENUM    /* For compability */
  158.  
  159. extern unsigned long max_allowed_packet;
  160. extern unsigned long net_buffer_length;
  161.  
  162. #define net_new_transaction(net) ((net)->pkt_nr=0)
  163.  
  164. int    my_net_init(NET *net, Vio* vio);
  165. void    net_end(NET *net);
  166. void    net_clear(NET *net);
  167. int    net_flush(NET *net);
  168. int    my_net_write(NET *net,const char *packet,unsigned long len);
  169. int    net_write_command(NET *net,unsigned char command,const char *packet,
  170.               unsigned long len);
  171. int    net_real_write(NET *net,const char *packet,unsigned long len);
  172. unsigned int    my_net_read(NET *net);
  173.  
  174. struct rand_struct {
  175.   unsigned long seed1,seed2,max_value;
  176.   double max_value_dbl;
  177. };
  178.  
  179.   /* The following is for user defined functions */
  180.  
  181. enum Item_result {STRING_RESULT,REAL_RESULT,INT_RESULT};
  182.  
  183. typedef struct st_udf_args
  184. {
  185.   unsigned int arg_count;        /* Number of arguments */
  186.   enum Item_result *arg_type;        /* Pointer to item_results */
  187.   char **args;                /* Pointer to argument */
  188.   unsigned long *lengths;        /* Length of string arguments */
  189.   char *maybe_null;            /* Set to 1 for all maybe_null args */
  190. } UDF_ARGS;
  191.  
  192.   /* This holds information about the result */
  193.  
  194. typedef struct st_udf_init
  195. {
  196.   my_bool maybe_null;            /* 1 if function can return NULL */
  197.   unsigned int decimals;        /* for real functions */
  198.   unsigned int max_length;        /* For string functions */
  199.   char      *ptr;                /* free pointer for function data */
  200.   my_bool const_item;            /* 0 if result is independent of arguments */
  201. } UDF_INIT;
  202.  
  203.   /* Constants when using compression */
  204. #define NET_HEADER_SIZE 4        /* standard header size */
  205. #define COMP_HEADER_SIZE 3        /* compression header extra size */
  206.  
  207.   /* Prototypes to password functions */
  208.  
  209. #ifdef __cplusplus
  210. extern "C" {
  211. #endif
  212.   
  213. void randominit(struct rand_struct *,unsigned long seed1,
  214.         unsigned long seed2);
  215. double rnd(struct rand_struct *);
  216. void make_scrambled_password(char *to,const char *password);
  217. void get_salt_from_password(unsigned long *res,const char *password);
  218. void make_password_from_salt(char *to, unsigned long *hash_res);
  219. char *scramble(char *to,const char *message,const char *password,
  220.            my_bool old_ver);
  221. my_bool check_scramble(const char *, const char *message,
  222.                unsigned long *salt,my_bool old_ver);
  223. char *get_tty_password(char *opt_message);
  224. void hash_password(unsigned long *result, const char *password);
  225. #ifdef __cplusplus
  226. }
  227. #endif
  228.  
  229. /* Some other useful functions */
  230.  
  231. void my_init(void);
  232. void load_defaults(const char *conf_file, const char **groups,
  233.            int *argc, char ***argv);
  234.  
  235. #define NULL_LENGTH ((unsigned long) ~0) /* For net_store_length */
  236.  
  237. #ifdef __WIN__
  238. #define socket_errno WSAGetLastError()
  239. #else
  240. #define socket_errno errno
  241. #endif
  242.  
  243. #endif
  244.