[go: up one dir, main page]

File: tonoblockquery.h

package info (click to toggle)
tora 1.3.4-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 8,632 kB
  • ctags: 7,487
  • sloc: cpp: 68,518; perl: 1,475; ansic: 291; sh: 173; makefile: 51
file content (173 lines) | stat: -rw-r--r-- 5,043 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
//***************************************************************************
/*
 * TOra - An Oracle Toolkit for DBA's and developers
 * Copyright (C) 2000-2001,2001 Underscore AB
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation;  only version 2 of
 * the License is valid for this program.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 *      As a special exception, you have permission to link this program
 *      with the Oracle Client libraries and distribute executables, as long
 *      as you follow the requirements of the GNU GPL in regard to all of the
 *      software in the executable aside from Oracle client libraries.
 *
 *      Specifically you are not permitted to link this program with the
 *      Qt/UNIX, Qt/Windows or Qt Non Commercial products of TrollTech.
 *      And you are not permitted to distribute binaries compiled against
 *      these libraries without written consent from Underscore AB. Observe
 *      that this does not disallow linking to the Qt Free Edition.
 *
 * All trademarks belong to their respective owners.
 *
 ****************************************************************************/

#ifndef TONOBLOCKQUERY_H
#define TONOBLOCKQUERY_H

#include "toconnection.h"
#include "tothread.h"

#include <time.h>

class toResultStats;

/** This is class to be able to run a query in the background without
 * blocking until a response is available from OCI.
 */

class toNoBlockQuery {
private:
  /** A task to implement running the query.
   */
  class queryTask : public toTask {
    toNoBlockQuery &Parent;
  public:
    queryTask(toNoBlockQuery &parent)
      : Parent(parent)
    { }
    virtual void run(void);
  };
  friend class queryTask;

  /** This semaphore indicates wether the query is still running.
   */
  toSemaphore Running;
  /** This semaphore indicates wether the child thread should
   * continue reading values.
   */
  toSemaphore Continue;
  /** Lock for all this stuff
   */
  toLock Lock;
  /** Current location that values are being read.
   */
  toQList::iterator CurrentValue;
  /** Values read by the task. This can be changed without holding @ref Lock.
   */
  toQList ReadingValues;
  /** Values ready to be read by client.
   */
  toQList Values;
  /** Indicator if at end of query.
   */
  bool EOQ;
  /** Indicator if to quit reading from query.
   */
  bool Quit;
  /** SQL to execute.
   */
  QString SQL;
  /** Error string if error occurs.
   */
  toConnection::exception Error;
  /** Number of rows processed.
   */
  int Processed;
  /** Parameters to pass to query before execution.
   */
  toQList Param;
  /** Statistics to be used if any.
   */
  toResultStats *Statistics;
  /** Description of result
   */
  toQDescList Description;
  /** When query is executed
   */
  time_t Started;
  /** Query used to run query
   */
  toQuery *Query;
  /** Throw error if any.
   */
  void checkError();
  /** Stop reading query
   */
  void stop();
public:
  /** Create a new query.
   * @param conn Connection to run on.
   * @param sql SQL to execute.
   * @param param Parameters to pass to query.
   * @param statistics Optional statistics widget to update with values from query.
   */
  toNoBlockQuery(toConnection &conn,
		 const QString &sql,
		 const toQList &param,
		 toResultStats *statistics=NULL);
  /** Create a new query.
   * @param conn Connection to run on.
   * @param mode Query mode to execute query in.
   * @param sql SQL to execute.
   * @param param Parameters to pass to query.
   * @param statistics Optional statistics widget to update with values from query.
   */
  toNoBlockQuery(toConnection &conn,
		 toQuery::queryMode mode,
		 const QString &sql,
		 const toQList &param,
		 toResultStats *statistics=NULL);
  virtual ~toNoBlockQuery();

  /** Poll if any result is available.
   * @return True if at least one row is available.
   */
  bool poll(void);

  /** Get description of columns.
   * @return Description of columns list. Don't modify this list.
   */
  toQDescList &describe(void);

  /** Read the next value from the query.
   * @return The next available value.
   */
  QString readValue(void);
  /** Read the next value from the query. Don't send NULL as string.
   * @return The next available value.
   */
  QString readValueNull(void);

  /** Get the number of rows processed.
   * @return Number of rows processed.
   */
  int rowsProcessed(void);

  /** Check if at end of query.
   * @return True if query is done.
   */
  bool eof(void);
};

#endif