| Qore Programming Language Reference Manual 1.0.8

qc_qore.dox.h
1
3 namespace Qore {
7
9
12 const NT_ALL = NT_ALL;
14 const NT_BINARY = NT_BINARY;
16 const NT_BOOLEAN = NT_BOOLEAN;
18 const NT_CALLREF = NT_FUNCREF;
20 const NT_CLOSURE = NT_RUNTIME_CLOSURE;
22 const NT_DATE = NT_DATE;
24 const NT_FLOAT = NT_FLOAT;
26 const NT_HASH = NT_HASH;
28 const NT_INT = NT_INT;
30 const NT_LIST = NT_LIST;
32 const NT_NOTHING = NT_NOTHING;
34 const NT_NULL = NT_NULL;
36 const NT_NUMBER = NT_NUMBER;
38 const NT_OBJECT = NT_OBJECT;
40 const NT_STRING = NT_STRING;
42 }
43
45 namespace Qore {
50
52 const TypeCodeMap = (
54 "0": "nothing",
55 "1": "integer",
56 "2": "float",
57 "3": "string",
58 "4": "date",
59 "5": "bool",
60 "6": "NULL",
61 "7": "binary",
62 "8": "list",
63 "9": "hash",
64 "10": "object",
65 "11": "number",
66 "29": "call reference",
67 "32": "closure",
68 );
70 const TypeNameMap = (
71 "nothing": NT_NOTHING,
72 "integer": NT_INT,
73 "float": NT_FLOAT,
74 "number": NT_NUMBER,
75 "string": NT_STRING,
76 "date": NT_DATE,
77 "bool": NT_BOOLEAN,
78 "NULL": NT_NULL,
79 "binary": NT_BINARY,
80 "list": NT_LIST,
81 "hash": NT_HASH,
82 "object": NT_OBJECT,
83 "call reference": NT_FUNCREF,
84 "closure": NT_RUNTIME_CLOSURE,
85 );
87 }
88
90 namespace Qore {
93
95 const False = bool(false);
98 const True = bool(true);
100 }
101
103 namespace Qore {
106
108 const NOTHING = qore(&Nothing);
111 const NULL = qore(&Null);
113 }
114
116 namespace Qore {
119
121 const ET_System = "System";
124 const ET_User = "User";
126 }
127
129 namespace Qore {
132
134 const CT_Builtin = CT_BUILTIN;
137 const CT_NewThread = CT_NEWTHREAD;
139 const CT_Rethrow = CT_RETHROW;
141 const CT_User = CT_USER;
143 }
144
146 namespace Qore {
149
151 const Build = qore(qore_build_number);
154 const BuildHost = qore(new QoreStringNode(qore_build_host));
156 const CFLAGS = qore(new QoreStringNode(qore_cflags));
158 const Compiler = qore(new QoreStringNode(qore_cplusplus_compiler));
160
164 const DirSep = qore(new QoreStringNode(QORE_DIR_SEP_STR));
166 const LDFLAGS = qore(new QoreStringNode(qore_ldflags));
168 const MACHINE_MSB = bool(Q_MACHINE_MSB);
170
176 const PathSep = qore(new QoreStringNode(QORE_PATH_SEP_STR));
178 const Platform = ("OS": qore(new QoreStringNode(TARGET_OS)), "CPU": qore(new QoreStringNode(TARGET_ARCH)), "Unix": bool(Q_IS_UNIX), "Windows": bool(Q_IS_WINDOWS));
180 const PlatformCPU = qore(new QoreStringNode(TARGET_ARCH));
182 const PlatformOS = qore(new QoreStringNode(TARGET_OS));
184 const VersionMajor = qore(qore_version_major);
186 const VersionMinor = qore(qore_version_minor);
188 const VersionString = qore(new QoreStringNode(qore_version_string));
190 const VersionSub = qore(qore_version_sub);
192 }
193
195 namespace Qore {
198
200 const SOURCE_FILE = QORE_SOURCE_FILE;
203 const SOURCE_FTPCLIENT = QORE_SOURCE_FTPCLIENT;
205 const SOURCE_HTTPCLIENT = QORE_SOURCE_HTTPCLIENT;
207 const SOURCE_SOCKET = QORE_SOURCE_SOCKET;
209 }
210
212 namespace Qore {
215
217 const EVENT_MAP = (
219 "1": "PACKET_READ",
220 "2": "PACKET_SENT",
221 "3": "HTTP_CONTENT_LENGTH",
222 "4": "HTTP_CHUNKED_START",
223 "5": "HTTP_CHUNKED_END",
224 "6": "HTTP_REDIRECT",
225 "7": "CHANNEL_CLOSED",
226 "8": "DELETED",
227 "9": "FTP_SEND_MESSAGE",
228 "10": "FTP_MESSAGE_RECEIVED",
229 "11": "HOSTNAME_LOOKUP",
230 "12": "HOSTNAME_RESOLVED",
231 "13": "HTTP_SEND_MESSAGE",
232 "14": "HTTP_MESSAGE_RECEIVED",
233 "15": "HTTP_FOOTERS_RECEIVED",
234 "16": "HTTP_CHUNKED_DATA_RECEIVED",
235 "17": "HTTP_CHUNK_SIZE",
236 "18": "CONNECTING",
237 "19": "CONNECTED",
238 "20": "START_SSL",
239 "21": "SSL_ESTABLISHED",
240 "22": "OPEN_FILE",
241 "23": "FILE_OPENED",
242 "24": "DATA_READ",
243 "25": "DATA_WRITTEN",
244 "26": "HTTP_CHUNKED_DATA_READ",
245 "27": "HTTP_CHUNKED_DATA_SENT",
246 "28": "HTTP_FOOTERS_SENT",
247 "29": "SOCKET_DATA_READ",
248 "30": "SOCKET_DATA_SENT",
249 "31": "HTTP_HEADERS_READ",
250 );
252 const EVENT_SOURCE_MAP = (
253 "1": "SOCKET",
254 "2": "HTTPCLIENT",
255 "3": "FTPCLIENT",
256 "4": "FILE",
257 );
259 }
260
262 namespace Qore {
265
267 const EVENT_CHANNEL_CLOSED = QORE_EVENT_CHANNEL_CLOSED;
270 const EVENT_CONNECTED = QORE_EVENT_CONNECTED;
272 const EVENT_CONNECTING = QORE_EVENT_CONNECTING;
274 const EVENT_DATA_READ = QORE_EVENT_DATA_READ;
276 const EVENT_DATA_WRITTEN = QORE_EVENT_DATA_WRITTEN;
278 const EVENT_DELETED = QORE_EVENT_DELETED;
280 const EVENT_FILE_OPENED = QORE_EVENT_FILE_OPENED;
282 const EVENT_FTP_MESSAGE_RECEIVED = QORE_EVENT_FTP_MESSAGE_RECEIVED;
284 const EVENT_FTP_SEND_MESSAGE = QORE_EVENT_FTP_SEND_MESSAGE;
286 const EVENT_HOSTNAME_LOOKUP = QORE_EVENT_HOSTNAME_LOOKUP;
288 const EVENT_HOSTNAME_RESOLVED = QORE_EVENT_HOSTNAME_RESOLVED;
290
292 const EVENT_HTTP_CHUNKED_DATA_READ = QORE_EVENT_HTTP_CHUNKED_DATA_READ;
294 const EVENT_HTTP_CHUNKED_DATA_RECEIVED = QORE_EVENT_HTTP_CHUNKED_DATA_RECEIVED;
296
298 const EVENT_HTTP_CHUNKED_DATA_SENT = QORE_EVENT_HTTP_CHUNKED_DATA_SENT;
300 const EVENT_HTTP_CHUNKED_END = QORE_EVENT_HTTP_CHUNKED_END;
302
304 const EVENT_HTTP_CHUNKED_FOOTERS_SENT = QORE_EVENT_HTTP_FOOTERS_SENT;
306 const EVENT_HTTP_CHUNKED_START = QORE_EVENT_HTTP_CHUNKED_START;
308 const EVENT_HTTP_CHUNK_SIZE = QORE_EVENT_HTTP_CHUNK_SIZE;
310 const EVENT_HTTP_CONTENT_LENGTH = QORE_EVENT_HTTP_CONTENT_LENGTH;
312 const EVENT_HTTP_FOOTERS_RECEIVED = QORE_EVENT_HTTP_FOOTERS_RECEIVED;
314
316 const EVENT_HTTP_HEADERS_READ = QORE_EVENT_HTTP_HEADERS_READ;
318 const EVENT_HTTP_MESSAGE_RECEIVED = QORE_EVENT_HTTP_MESSAGE_RECEIVED;
320 const EVENT_HTTP_REDIRECT = QORE_EVENT_HTTP_REDIRECT;
322 const EVENT_HTTP_SEND_MESSAGE = QORE_EVENT_HTTP_SEND_MESSAGE;
324 const EVENT_OPEN_FILE = QORE_EVENT_OPEN_FILE;
326 const EVENT_PACKET_READ = QORE_EVENT_PACKET_READ;
328 const EVENT_PACKET_SENT = QORE_EVENT_PACKET_SENT;
330
332 const EVENT_SOCKET_DATA_READ = QORE_EVENT_SOCKET_DATA_READ;
334
336 const EVENT_SOCKET_DATA_SENT = QORE_EVENT_SOCKET_DATA_SENT;
338 const EVENT_SSL_ESTABLISHED = QORE_EVENT_SSL_ESTABLISHED;
340 const EVENT_START_SSL = QORE_EVENT_START_SSL;
342 }
343
345 namespace Qore {
351
353 const stderr = qore(QC_FILE->execSystemConstructor(2));
356 const stderr_stream = qore(QC_FILEOUTPUTSTREAM->execSystemConstructor(2));
358 const stdin = qore(QC_FILE->execSystemConstructor(0));
360 const stdin_stream = qore(QC_FILEINPUTSTREAM->execSystemConstructor(0));
362 const stdout = qore(QC_FILE->execSystemConstructor(1));
364 const stdout_stream = qore(QC_FILEOUTPUTSTREAM->execSystemConstructor(1));
366 }
Qore::EVENT_SOURCE_MAP
const EVENT_SOURCE_MAP
Maps from Event Source Constants (the keys) to descriptive strings (the values)
Definition: qc_qore.dox.h:252
Qore::ET_System
const ET_System
Exception type code system exceptions (thrown in internal Qore code or in modules) ...
Definition: qc_qore.dox.h:122
Qore::PathSep
const PathSep
platform-specific path separator character string
Definition: qc_qore.dox.h:176
Qore::EVENT_CONNECTED
const EVENT_CONNECTED
Raised when the socket connection has been established.
Definition: qc_qore.dox.h:270
Qore::EVENT_HTTP_CHUNKED_DATA_READ
const EVENT_HTTP_CHUNKED_DATA_READ
Raised when data is read if the event data flag is set.
Definition: qc_qore.dox.h:292
Qore::stdin
const stdin
system constant for stdin (file descriptor 0)
Definition: qc_qore.dox.h:358
Qore::EVENT_HOSTNAME_LOOKUP
const EVENT_HOSTNAME_LOOKUP
Raised when a hostname lookup is started.
Definition: qc_qore.dox.h:286
Qore::NT_NOTHING
const NT_NOTHING
type code for no value (NOTHING)
Definition: qc_qore.dox.h:32
Qore::VersionMajor
const VersionMajor
The integer Qore major version number.
Definition: qc_qore.dox.h:184
Qore::Compiler
const Compiler
A string giving the C++ compiler used to build Qore.
Definition: qc_qore.dox.h:158
Qore::EVENT_OPEN_FILE
const EVENT_OPEN_FILE
Raised right before a file is opened.
Definition: qc_qore.dox.h:324
Qore::EVENT_SOCKET_DATA_SENT
const EVENT_SOCKET_DATA_SENT
Raised when data is sent on the socket if the event data flag is set.
Definition: qc_qore.dox.h:336
Qore::EVENT_HTTP_CONTENT_LENGTH
const EVENT_HTTP_CONTENT_LENGTH
Raised when the HTTP "Content-Length" header is received.
Definition: qc_qore.dox.h:310
Qore::EVENT_SSL_ESTABLISHED
const EVENT_SSL_ESTABLISHED
Raised when SSL communication has been negotiated and established.
Definition: qc_qore.dox.h:338
Qore::EVENT_CONNECTING
const EVENT_CONNECTING
Raised right before a socket connection attempt is made.
Definition: qc_qore.dox.h:272
Qore::EVENT_HTTP_CHUNKED_END
const EVENT_HTTP_CHUNKED_END
Raised when all HTTP chunked data has been received.
Definition: qc_qore.dox.h:300
Qore::EVENT_FTP_MESSAGE_RECEIVED
const EVENT_FTP_MESSAGE_RECEIVED
Raised when an FTP reply is received on the control channel.
Definition: qc_qore.dox.h:282
Qore::SOURCE_FTPCLIENT
const SOURCE_FTPCLIENT
FtpClient class source code
Definition: qc_qore.dox.h:203
Qore::EVENT_HTTP_CHUNKED_FOOTERS_SENT
const EVENT_HTTP_CHUNKED_FOOTERS_SENT
Raised when HTTP footers are sent while receiving chunked data if the event data flag is set...
Definition: qc_qore.dox.h:304
Qore::VersionSub
const VersionSub
The integer Qore sub version number.
Definition: qc_qore.dox.h:190
Qore::EVENT_HTTP_REDIRECT
const EVENT_HTTP_REDIRECT
Raised when an HTTP redirect message is received.
Definition: qc_qore.dox.h:320
Qore::stdin_stream
const stdin_stream
system constant for stdin InputStream (file descriptor 0)
Definition: qc_qore.dox.h:360
Qore::True
const True
logical True
Definition: qc_qore.dox.h:98
Qore::NT_FLOAT
const NT_FLOAT
type code for float values
Definition: qc_qore.dox.h:24
Qore::EVENT_SOCKET_DATA_READ
const EVENT_SOCKET_DATA_READ
Raised when data is read on the socket if the event data flag is set.
Definition: qc_qore.dox.h:332
Qore::NT_LIST
const NT_LIST
type code for list values
Definition: qc_qore.dox.h:30
Qore::EVENT_HTTP_FOOTERS_RECEIVED
const EVENT_HTTP_FOOTERS_RECEIVED
Raised when HTTP footers are received.
Definition: qc_qore.dox.h:312
Qore::EVENT_HTTP_CHUNKED_START
const EVENT_HTTP_CHUNKED_START
Raised when HTTP chunked data is about to be received.
Definition: qc_qore.dox.h:306
Qore::NULL
const NULL
logical False
Definition: qc_qore.dox.h:111
Qore::NT_STRING
const NT_STRING
type code for string values
Definition: qc_qore.dox.h:40
Qore::CT_User
const CT_User
Call type for user code.
Definition: qc_qore.dox.h:141
Qore::NT_CALLREF
const NT_CALLREF
type code for call references
Definition: qc_qore.dox.h:18
Qore::EVENT_START_SSL
const EVENT_START_SSL
Raised when socket SSL negotiation starts.
Definition: qc_qore.dox.h:340
Qore::SOURCE_FILE
const SOURCE_FILE
File class source code
Definition: qc_qore.dox.h:201
Qore::BuildHost
const BuildHost
The host name of the host used to build the Qore library.
Definition: qc_qore.dox.h:154
Qore::False
const False
logical False
Definition: qc_qore.dox.h:96
Qore::SOURCE_SOCKET
const SOURCE_SOCKET
Socket class source code
Definition: qc_qore.dox.h:207
Qore::Platform
const Platform
hash of platform information
Definition: qc_qore.dox.h:178
Qore::NT_CLOSURE
const NT_CLOSURE
type code for closures
Definition: qc_qore.dox.h:20
Qore::NT_ALL
const NT_ALL
type code for wildcard types (both with - "all" and without - "auto" type stripping) ...
Definition: qc_qore.dox.h:12
Qore::EVENT_DELETED
const EVENT_DELETED
Raised when the object being monitored is deleted.
Definition: qc_qore.dox.h:278
Qore::NT_DATE
const NT_DATE
type code for date/time values
Definition: qc_qore.dox.h:22
Qore::EVENT_PACKET_SENT
const EVENT_PACKET_SENT
Raised when a network packet is sent.
Definition: qc_qore.dox.h:328
Qore::VersionMinor
const VersionMinor
The integer Qore minor version number.
Definition: qc_qore.dox.h:186
Qore::EVENT_HTTP_CHUNK_SIZE
const EVENT_HTTP_CHUNK_SIZE
Raised when the next chunk size for HTTP chunked data is known.
Definition: qc_qore.dox.h:308
Qore::stderr
const stderr
system constant for stderr (file descriptor 2)
Definition: qc_qore.dox.h:354
Qore::stderr_stream
const stderr_stream
system constant for stderr OutputStream (file descriptor 2)
Definition: qc_qore.dox.h:356
Qore::EVENT_HOSTNAME_RESOLVED
const EVENT_HOSTNAME_RESOLVED
Raised when a hostname lookup is resolved.
Definition: qc_qore.dox.h:288
Qore::EVENT_HTTP_CHUNKED_DATA_SENT
const EVENT_HTTP_CHUNKED_DATA_SENT
Raised when data is sent if the event data flag is set.
Definition: qc_qore.dox.h:298
Qore::DirSep
const DirSep
platform-specific directory separator character string
Definition: qc_qore.dox.h:164
Qore::NT_INT
const NT_INT
type code for integer values
Definition: qc_qore.dox.h:28
Qore::NT_BOOLEAN
const NT_BOOLEAN
type code for boolean values
Definition: qc_qore.dox.h:16
Qore::EVENT_FTP_SEND_MESSAGE
const EVENT_FTP_SEND_MESSAGE
Raised immediately before an FTP control message is sent.
Definition: qc_qore.dox.h:284
Qore::NT_NULL
const NT_NULL
type code for NULL
Definition: qc_qore.dox.h:34
Qore::stdout
const stdout
system constant for stdout (file descriptor 1)
Definition: qc_qore.dox.h:362
Qore::EVENT_PACKET_READ
const EVENT_PACKET_READ
Raised when a network packet is received.
Definition: qc_qore.dox.h:326
Qore::NOTHING
const NOTHING
a constant representing the lack of a value
Definition: qc_qore.dox.h:109
Qore::PlatformCPU
const PlatformCPU
The string for the platform&#39;s CPU architecture.
Definition: qc_qore.dox.h:180
Qore::NT_BINARY
const NT_BINARY
type code for binary values
Definition: qc_qore.dox.h:14
Qore::CFLAGS
const CFLAGS
A string giving the C++ compiler flags used to build Qore.
Definition: qc_qore.dox.h:156
Qore::CT_Builtin
const CT_Builtin
Call type for builtin code.
Definition: qc_qore.dox.h:135
Qore::EVENT_HTTP_MESSAGE_RECEIVED
const EVENT_HTTP_MESSAGE_RECEIVED
Raised when an HTTP message is received.
Definition: qc_qore.dox.h:318
Qore::EVENT_DATA_READ
const EVENT_DATA_READ
Raised when data has been read from a file.
Definition: qc_qore.dox.h:274
Qore::EVENT_HTTP_SEND_MESSAGE
const EVENT_HTTP_SEND_MESSAGE
Raised when an HTTP message is sent.
Definition: qc_qore.dox.h:322
Qore::stdout_stream
const stdout_stream
system constant for stdout OutputStream (file descriptor 1)
Definition: qc_qore.dox.h:364
Qore::TypeNameMap
const TypeNameMap
type name map, looks up type codes from type names
Definition: qc_qore.dox.h:70
Qore::EVENT_HTTP_CHUNKED_DATA_RECEIVED
const EVENT_HTTP_CHUNKED_DATA_RECEIVED
Raised when a block of HTTP chunked data is received.
Definition: qc_qore.dox.h:294
Qore::NT_NUMBER
const NT_NUMBER
type code for number values
Definition: qc_qore.dox.h:36
Qore::Build
const Build
The integer Qore build number.
Definition: qc_qore.dox.h:152
Qore::EVENT_FILE_OPENED
const EVENT_FILE_OPENED
Raised when a file has been successfully opened.
Definition: qc_qore.dox.h:280
Qore::MACHINE_MSB
const MACHINE_MSB
True if the current machine uses big-endian or MSB byte order or False if the current machine uses li...
Definition: qc_qore.dox.h:168
Qore::NT_HASH
const NT_HASH
type code for hash values
Definition: qc_qore.dox.h:26
Qore::EVENT_DATA_WRITTEN
const EVENT_DATA_WRITTEN
Raised when data has been written to a file.
Definition: qc_qore.dox.h:276
Qore::EVENT_MAP
const EVENT_MAP
Maps from Event Constants (the keys) to descriptive strings (the values)
Definition: qc_qore.dox.h:218
Qore::NT_OBJECT
const NT_OBJECT
type code for objects
Definition: qc_qore.dox.h:38
Qore::VersionString
const VersionString
The full Qore version string.
Definition: qc_qore.dox.h:188
Qore::PlatformOS
const PlatformOS
A string giving the platform operating-system name.
Definition: qc_qore.dox.h:182
Qore
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
Qore::SOURCE_HTTPCLIENT
const SOURCE_HTTPCLIENT
HTTPClient class source code
Definition: qc_qore.dox.h:205
Qore::EVENT_CHANNEL_CLOSED
const EVENT_CHANNEL_CLOSED
Raised when a socket or file is closed.
Definition: qc_qore.dox.h:268
Qore::EVENT_HTTP_HEADERS_READ
const EVENT_HTTP_HEADERS_READ
Raised when HTTP headers are received.
Definition: qc_qore.dox.h:316
Qore::TypeCodeMap
const TypeCodeMap
type code map, looks up type names from type code values
Definition: qc_qore.dox.h:53
Qore::ET_User
const ET_User
Exception type for user exceptions (thrown by the throw statement)
Definition: qc_qore.dox.h:124
Qore::CT_Rethrow
const CT_Rethrow
Call type for an exception thrown by the rethrow statement.
Definition: qc_qore.dox.h:139
Qore::CT_NewThread
const CT_NewThread
Call type for the start of a new thread by the background operator.
Definition: qc_qore.dox.h:137
Qore::LDFLAGS
const LDFLAGS
A string giving the linker flags used to build Qore.
Definition: qc_qore.dox.h:166