| Qore Programming Language Reference Manual 1.0.8

ql_lib.dox.h
1
3 namespace Qore {
5
7 struct NetIfInfo {
9 *string address;
11 *string address_desc;
13 int family;
15 string familystr;
17 string interface;
18 };
19 }
20
22 namespace Qore {
24
26 struct ExceptionInfo {
28 auto arg;
30 list<hash<CallStackInfo>> callstack;
32 auto desc;
34 int endline;
36 auto err;
38 string file;
40 string lang;
42 int line;
44 hash<ExceptionInfo> next;
46 int offset;
48 string source;
50 string type;
51 };
52 }
53
55 namespace Qore {
141
154 nothing abort();
155
157
171 string basename(string path);
172
174
178 nothing basename();
179
181
197 nothing close_all_fd(*softbool strd);
198
200
214 string dirname(string path);
215
217
221 nothing dirname();
222
224
234 int errno();
235
237
247 nothing exec(string command);
248
250
262 nothing exit(softint rc = 0);
263
265
293 int fork();
294
296
349 list<hash<NetIfInfo>> get_netif_list();
350
352
374 list<hash<auto>> getaddrinfo(*string node, *softstring service, softint family = AF_UNSPEC, softint flags = 0);
375
377
391 int getegid();
392
394
408 int geteuid();
409
411
425 int getgid();
426
428
444 list<int> getgroups();
445
447
471 *string gethostbyaddr(string addr, softint type = AF_INET);
472
474
478 nothing gethostbyaddr();
479
481
505 *hash<auto> gethostbyaddr_long(string addr, softint type = AF_INET);
506
508
512 nothing gethostbyaddr_long();
513
515
534 *string gethostbyname(string name);
535
537
541 nothing gethostbyname();
542
544
563 *hash<auto> gethostbyname_long(string name);
564
566
570 nothing gethostbyname_long();
571
573
586 string gethostname();
587
589
602 int getpid();
603
605
622 int getppid();
623
625
639 int getuid();
640
642
663 int kill(softint pid, softint sig = SIGHUP);
664
666
673 nothing kill();
674
676
685 int qore_get_library_options();
686
688
700 int qore_set_library_options(int opts);
701
703
720 int rand();
721
723
740 int setegid(softint gid);
741
743
760 int seteuid(softint uid);
761
763
780 int setgid(softint gid);
781
783
799 nothing setgroups(softlist<softint> gids);
800
802
815 int setsid();
816
818
835 int setuid(softint uid);
836
838
852 int sleep(softint seconds);
853
855
862 nothing sleep();
863
865
881 nothing srand(softint seed);
882
884
891 nothing srand();
892
894
907 string strerror(softint err);
908
910
923 string strerror();
924
926
946 int system(string command);
947
949
956 nothing system();
957
959
975 int usleep(softint usecs);
976
978
994 int usleep(date d);
995
997
1004 nothing usleep();
1005
1007 }
1008
1010 namespace Qore {
1015
1017 const QLO_DISABLE_GARBAGE_COLLECTION = QLO_DISABLE_GARBAGE_COLLECTION;
1020 const QLO_DISABLE_OPENSSL_CLEANUP = QLO_DISABLE_OPENSSL_CLEANUP;
1022 const QLO_DISABLE_OPENSSL_INIT = QLO_DISABLE_OPENSSL_INIT;
1024 const QLO_DISABLE_SIGNAL_HANDLING = QLO_DISABLE_SIGNAL_HANDLING;
1026 const QLO_DISABLE_TLS_13 = QLO_DISABLE_TLS_13;
1028 const QLO_DO_NOT_SEED_RNG = QLO_DO_NOT_SEED_RNG;
1030
1033 const QLO_RUNTIME_OPTS = QLO_RUNTIME_OPTS;
1035 }
Qore::gethostbyname
*string gethostbyname(string name)
Returns the first address corresponding to the hostname passed as an argument or NOTHING if the looku...
Qore::NetIfInfo::address
*string address
interface address if available
Definition: ql_lib.dox.h:9
Qore::getuid
int getuid()
Returns the real user ID of the current process.
Qore::date
date date(date dt)
Returns the date passed.
Qore::getegid
int getegid()
Returns the effective group ID of the current process.
Qore::AF_UNSPEC
const AF_UNSPEC
unspecified address family
Definition: QC_Socket.dox.h:2947
Qore::rand
int rand()
Returns a random non-negative 64-bit integer number.
Qore::QLO_RUNTIME_OPTS
const QLO_RUNTIME_OPTS
bitmask for library options that can be set at runtime
Definition: ql_lib.dox.h:1033
Qore::QLO_DISABLE_OPENSSL_CLEANUP
const QLO_DISABLE_OPENSSL_CLEANUP
do not perform cleanup on the openssl library (= is cleaned up manually; init only) ...
Definition: ql_lib.dox.h:1020
Qore::NetIfInfo
network interface info hash
Definition: ql_lib.dox.h:7
Qore::QLO_DO_NOT_SEED_RNG
const QLO_DO_NOT_SEED_RNG
disable seeding the random number generator when the Qore library is initialized (init only) ...
Definition: ql_lib.dox.h:1028
Qore::srand
nothing srand(softint seed)
Seeds the random number generator with the integer passed.
Qore::gethostbyaddr_long
*hash< auto > gethostbyaddr_long(string addr, softint type=AF_INET)
Returns a hash representing all host and address information corresponding to the address and address...
Qore::gethostbyname_long
*hash< auto > gethostbyname_long(string name)
Returns a hash representing all host and address information corresponding to the hostname passed as ...
Qore::setgroups
nothing setgroups(softlist< softint > gids)
sets the list of supplementary group IDs for the current process
Qore::ExceptionInfo::next
hash< ExceptionInfo > next
chained exception info
Definition: ql_lib.dox.h:44
Qore::seteuid
int seteuid(softint uid)
Changes the effective process user ID according to the argument passed.
Qore::ExceptionInfo::line
int line
position info: start line number
Definition: ql_lib.dox.h:42
Qore::QLO_DISABLE_OPENSSL_INIT
const QLO_DISABLE_OPENSSL_INIT
do not initialize the openssl library (= is initialized before the qore library is initialized; init ...
Definition: ql_lib.dox.h:1022
Qore::getgid
int getgid()
Returns the real group ID of the current process.
Qore::gethostname
string gethostname()
Returns the hostname of the system.
Qore::geteuid
int geteuid()
Returns the effective user ID of the current process.
Qore::ExceptionInfo::desc
auto desc
this key is populated with the value of the second expression of the throw statement (if a list was t...
Definition: ql_lib.dox.h:32
Qore::usleep
int usleep(softint usecs)
Causes the current thread to sleep for a certain number of microseconds.
Qore::setgid
int setgid(softint gid)
Changes the process group ID according to the argument passed.
Qore::kill
int kill(softint pid, softint sig=SIGHUP)
Sends a signal to a process, if no signal number is given, then Qore::SIGHUP is sent by default...
Qore::exec
nothing exec(string command)
Replaces the current process image with another; this function does not return.
Qore::ExceptionInfo::err
auto err
this key is populated with the value of the first expression of the throw statement. For system exceptions, this is a string giving the exception code.
Definition: ql_lib.dox.h:36
Qore::ExceptionInfo::lang
string lang
the language of the source code location; normally "Qore"
Definition: ql_lib.dox.h:40
Qore::close_all_fd
nothing close_all_fd(*softbool strd)
closes all possible file descriptors; useful in "daemon" processes that may have inherited open file ...
Qore::getpid
int getpid()
Returns the PID (process ID) of the current process.
Qore::QLO_DISABLE_SIGNAL_HANDLING
const QLO_DISABLE_SIGNAL_HANDLING
disable qore signal handling entirely (init only)
Definition: ql_lib.dox.h:1024
Qore::qore_get_library_options
int qore_get_library_options()
returns all Qore library options
Qore::get_netif_list
list< hash< NetIfInfo > > get_netif_list()
returns a list of network interfaces
Qore::NetIfInfo::familystr
string familystr
interface family type string
Definition: ql_lib.dox.h:15
Qore::qore_set_library_options
int qore_set_library_options(int opts)
sets Qore runtime library options
Qore::ExceptionInfo::endline
int endline
position info: end line number
Definition: ql_lib.dox.h:34
Qore::dirname
string dirname(string path)
Returns a string giving the path up to a file but not the filename itself.
Qore::ExceptionInfo::arg
auto arg
this key is populated with the value of the third expression of the throw statement (if a list was th...
Definition: ql_lib.dox.h:28
Qore::QLO_DISABLE_GARBAGE_COLLECTION
const QLO_DISABLE_GARBAGE_COLLECTION
disable garbage collection / recursive object reference detection (init only)
Definition: ql_lib.dox.h:1018
Qore::getgroups
list< int > getgroups()
returns a list of group IDs that the user is a member of
Qore::exit
nothing exit(softint rc=0)
Exits the program with the return code passed (this function does not return)
Qore::AF_INET
const AF_INET
IPv4 address family.
Definition: QC_Socket.dox.h:2939
Qore::QLO_DISABLE_TLS_13
const QLO_DISABLE_TLS_13
disable TLS v1.3 (may be set at runtime with qore_set_library_options())
Definition: ql_lib.dox.h:1026
Qore::setegid
int setegid(softint gid)
Changes the process effective group ID according to the argument passed.
Qore::abort
nothing abort()
Aborts the current program (this function does not return)
Qore::type
string type(auto arg)
Returns a string giving the data type of the argument passed; see String Type Constants for the value...
Qore::SIGHUP
const SIGHUP
SIGHUP.
Definition: ql_misc.dox.h:2290
Qore::gethostbyaddr
*string gethostbyaddr(string addr, softint type=AF_INET)
Returns the official hostname corresponding to the network address passed as an argument.
Qore::ExceptionInfo::callstack
list< hash< CallStackInfo > > callstack
call stack backtrace information
Definition: ql_lib.dox.h:30
Qore::system
int system(string command)
executes a command and returns the exit code of the process
Qore::strerror
string strerror(softint err)
Returns the string corresponding to the error code passed (generally retrieved with errno()) ...
Qore::errno
int errno()
Returns the error code of the last error that occurred in the current thread.
Qore::setuid
int setuid(softint uid)
Changes the process user ID according to the argument passed.
Qore::NetIfInfo::family
int family
interface family type; see Network Address Family Constants for possible values
Definition: ql_lib.dox.h:13
Qore::getppid
int getppid()
Returns the PID (process ID) of the parent process of the current process.
Qore::ExceptionInfo::type
string type
exception type: "User" or "System"; see Exception Type Constants
Definition: ql_lib.dox.h:50
Qore::getaddrinfo
list< hash< auto > > getaddrinfo(*string node, *softstring service, softint family=AF_UNSPEC, softint flags=0)
Returns a list of Address Information Hash for the given node name or string address; if no lookup ca...
Qore::NetIfInfo::address_desc
*string address_desc
interface address description (if the address is available)
Definition: ql_lib.dox.h:11
Qore::ExceptionInfo::offset
int offset
position info: line number offset for the "source" key (if known, for user code only) ...
Definition: ql_lib.dox.h:46
Qore::basename
string basename(string path)
Returns a string giving the last element of a file path (meant to be the filename) ...
Qore::fork
int fork()
Creates a copy of the current process with a new PID; returns 0 in the child process; returns the chi...
Qore::ExceptionInfo::source
string source
position info: an optional source string; if multiple sections of a file were parsed with different p...
Definition: ql_lib.dox.h:48
Qore::NetIfInfo::interface
string interface
interface name
Definition: ql_lib.dox.h:17
Qore
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
Qore::ExceptionInfo::file
string file
position info: the parse label where exception occurred; this is normally the file name; this corresp...
Definition: ql_lib.dox.h:38
Qore::setsid
int setsid()
Creates a new session lead by the calling process.
Qore::seconds
date seconds(softint seconds)
Returns a relative date/time value in seconds based on the integer argument passed to be used in date...
Qore::ExceptionInfo
exception information hash
Definition: ql_lib.dox.h:26
Qore::sleep
int sleep(softint seconds)
Causes the current thread to sleep for a certain number of seconds.