APR::Const(3pm)

1docs::api::APR::Const(3U)ser Contributed Perl Documentatidooncs::api::APR::Const(3)
2
3
4

NAME

6       APR::Const - Perl Interface for APR Constants
7

Synopsis

9         # make the constants available but don't import them
10         use APR::Const -compile => qw(constant names ...);
11
12         # w/o the => syntax sugar
13         use APR::Const ("-compile", qw(constant names ...));
14
15         # compile and import the constants
16         use APR::Const qw(constant names ...);
17

Description

19       This package contains constants specific to "APR" features.
20
21       Refer to "the Apache2::Const description section" for more information.
22

Constants

24   ":common"
25         use APR::Const -compile => qw(:common);
26
27       The ":common" group is for XXX constants.
28
29       "APR::Const::SUCCESS"
30
31       since: 2.0.00
32
33   ":error"
34         use APR::Const -compile => qw(:error);
35
36       The ":error" group is for XXX constants.
37
38       "APR::Const::EABOVEROOT"
39
40       since: 2.0.00
41
42       "APR::Const::EABSOLUTE"
43
44       since: 2.0.00
45
46       "APR::Const::EACCES"
47
48       since: 2.0.00
49
50       Due to possible variants in conditions matching "EACCES", for checking
51       error codes against this you most likely want to use the
52       "APR::Status::is_EACCES" function instead.
53
54       "APR::Const::EAGAIN"
55
56       since: 2.0.00
57
58       The error Resource temporarily unavailable, may be returned by many
59       different system calls, especially IO calls. Most likely you want to
60       use the "APR::Status::is_EAGAIN" function instead.
61
62       "APR::Const::EBADDATE"
63
64       since: 2.0.00
65
66       "APR::Const::EBADF"
67
68       since: 2.0.00
69
70       "APR::Const::EBADIP"
71
72       since: 2.0.00
73
74       "APR::Const::EBADMASK"
75
76       since: 2.0.00
77
78       "APR::Const::EBADPATH"
79
80       since: 2.0.00
81
82       "APR::Const::EBUSY"
83
84       since: 2.0.00
85
86       "APR::Const::ECONNABORTED"
87
88       since: 2.0.00
89
90       Due to possible variants in conditions matching "ECONNABORTED", for
91       checking error codes against this you most likely want to use the
92       "APR::Status::is_ECONNABORTED" function instead.
93
94       "APR::Const::ECONNREFUSED"
95
96       since: 2.0.00
97
98       "APR::Const::ECONNRESET"
99
100       since: 2.0.00
101
102       Due to possible variants in conditions matching "ECONNRESET", for
103       checking error codes against this you most likely want to use the
104       "APR::Status::is_ECONNRESET" function instead.
105
106       "APR::Const::EDSOOPEN"
107
108       since: 2.0.00
109
110       "APR::Const::EEXIST"
111
112       since: 2.0.00
113
114       "APR::Const::EFTYPE"
115
116       since: 2.0.00
117
118       "APR::Const::EGENERAL"
119
120       since: 2.0.00
121
122       "APR::Const::EHOSTUNREACH"
123
124       since: 2.0.00
125
126       "APR::Const::EINCOMPLETE"
127
128       since: 2.0.00
129
130       "APR::Const::EINIT"
131
132       since: 2.0.00
133
134       "APR::Const::EINPROGRESS"
135
136       since: 2.0.00
137
138       "APR::Const::EINTR"
139
140       since: 2.0.00
141
142       "APR::Const::EINVAL"
143
144       since: 2.0.00
145
146       "APR::Const::EINVALSOCK"
147
148       since: 2.0.00
149
150       "APR::Const::EMFILE"
151
152       since: 2.0.00
153
154       "APR::Const::EMISMATCH"
155
156       since: 2.0.00
157
158       "APR::Const::ENAMETOOLONG"
159
160       since: 2.0.00
161
162       "APR::Const::END"
163
164       since: 2.0.00
165
166       "APR::Const::ENETUNREACH"
167
168       since: 2.0.00
169
170       "APR::Const::ENFILE"
171
172       since: 2.0.00
173
174       "APR::Const::ENODIR"
175
176       since: 2.0.00
177
178       "APR::Const::ENOENT"
179
180       since: 2.0.00
181
182       Due to possible variants in conditions matching "ENOENT", for checking
183       error codes against this you most likely want to use the
184       "APR::Status::is_ENOENT" function instead.
185
186       "APR::Const::ENOLOCK"
187
188       since: 2.0.00
189
190       "APR::Const::ENOMEM"
191
192       since: 2.0.00
193
194       "APR::Const::ENOPOLL"
195
196       since: 2.0.00
197
198       "APR::Const::ENOPOOL"
199
200       since: 2.0.00
201
202       "APR::Const::ENOPROC"
203
204       since: 2.0.00
205
206       "APR::Const::ENOSHMAVAIL"
207
208       since: 2.0.00
209
210       "APR::Const::ENOSOCKET"
211
212       since: 2.0.00
213
214       "APR::Const::ENOSPC"
215
216       since: 2.0.00
217
218       "APR::Const::ENOSTAT"
219
220       since: 2.0.00
221
222       "APR::Const::ENOTDIR"
223
224       since: 2.0.00
225
226       "APR::Const::ENOTEMPTY"
227
228       since: 2.0.00
229
230       "APR::Const::ENOTHDKEY"
231
232       since: 2.0.00
233
234       "APR::Const::ENOTHREAD"
235
236       since: 2.0.00
237
238       "APR::Const::ENOTIME"
239
240       since: 2.0.00
241
242       "APR::Const::ENOTIMPL"
243
244       Something is not implemented
245
246       since: 2.0.00
247
248       "APR::Const::ENOTSOCK"
249
250       since: 2.0.00
251
252       "APR::Const::EOF"
253
254       since: 2.0.00
255
256       Due to possible variants in conditions matching "EOF", for checking
257       error codes against this you most likely want to use the
258       "APR::Status::is_EOF" function instead.
259
260       "APR::Const::EPATHWILD"
261
262       since: 2.0.00
263
264       "APR::Const::EPIPE"
265
266       since: 2.0.00
267
268       "APR::Const::EPROC_UNKNOWN"
269
270       since: 2.0.00
271
272       "APR::Const::ERELATIVE"
273
274       since: 2.0.00
275
276       "APR::Const::ESPIPE"
277
278       since: 2.0.00
279
280       "APR::Const::ESYMNOTFOUND"
281
282       since: 2.0.00
283
284       "APR::Const::ETIMEDOUT"
285
286       since: 2.0.00
287
288       "APR::Const::EXDEV"
289
290       since: 2.0.00
291
292   ":fopen"
293         use APR::Const -compile => qw(:fopen);
294
295       The ":fopen" group is for XXX constants.
296
297       "APR::Const::FOPEN_BINARY"
298
299       since: 2.0.00
300
301       "APR::Const::FOPEN_BUFFERED"
302
303       since: 2.0.00
304
305       "APR::Const::FOPEN_CREATE"
306
307       since: 2.0.00
308
309       "APR::Const::FOPEN_DELONCLOSE"
310
311       since: 2.0.00
312
313       "APR::Const::FOPEN_EXCL"
314
315       since: 2.0.00
316
317       "APR::Const::FOPEN_PEND"
318
319       since: 2.0.00
320
321       "APR::Const::FOPEN_READ"
322
323       since: 2.0.00
324
325       "APR::Const::FOPEN_TRUNCATE"
326
327       since: 2.0.00
328
329       "APR::Const::FOPEN_WRITE"
330
331       since: 2.0.00
332
333   ":filepath"
334         use APR::Const -compile => qw(:filepath);
335
336       The ":filepath" group is for XXX constants.
337
338       "APR::Const::FILEPATH_ENCODING_LOCALE"
339
340       since: 2.0.00
341
342       "APR::Const::FILEPATH_ENCODING_UNKNOWN"
343
344       since: 2.0.00
345
346       "APR::Const::FILEPATH_ENCODING_UTF8"
347
348       since: 2.0.00
349
350       "APR::Const::FILEPATH_NATIVE"
351
352       since: 2.0.00
353
354       "APR::Const::FILEPATH_NOTABOVEROOT"
355
356       since: 2.0.00
357
358       "APR::Const::FILEPATH_NOTABSOLUTE"
359
360       since: 2.0.00
361
362       "APR::Const::FILEPATH_NOTRELATIVE"
363
364       since: 2.0.00
365
366       "APR::Const::FILEPATH_SECUREROOT"
367
368       since: 2.0.00
369
370       "APR::Const::FILEPATH_SECUREROOTTEST"
371
372       since: 2.0.00
373
374       "APR::Const::FILEPATH_TRUENAME"
375
376       since: 2.0.00
377
378   ":fprot"
379         use APR::Const -compile => qw(:fprot);
380
381       The ":fprot" group is used by "$finfo->protection".
382
383       "APR::Const::FPROT_GEXECUTE"
384
385       Execute by group
386
387       since: 2.0.00
388
389       "APR::Const::FPROT_GREAD"
390
391       Read by group
392
393       since: 2.0.00
394
395       "APR::Const::FPROT_GSETID"
396
397       Set group id
398
399       since: 2.0.00
400
401       "APR::Const::FPROT_GWRITE"
402
403       Write by group
404
405       since: 2.0.00
406
407       "APR::Const::FPROT_OS_DEFAULT"
408
409       use OS's default permissions
410
411       since: 2.0.00
412
413       "APR::Const::FPROT_UEXECUTE"
414
415       Execute by user
416
417       since: 2.0.00
418
419       "APR::Const::FPROT_UREAD"
420
421       Read by user
422
423       since: 2.0.00
424
425       "APR::Const::FPROT_USETID"
426
427       Set user id
428
429       since: 2.0.00
430
431       "APR::Const::FPROT_UWRITE"
432
433       Write by user
434
435       since: 2.0.00
436
437       "APR::Const::FPROT_WEXECUTE"
438
439       Execute by others
440
441       since: 2.0.00
442
443       "APR::Const::FPROT_WREAD"
444
445       Read by others
446
447       since: 2.0.00
448
449       "APR::Const::FPROT_WSTICKY"
450
451       Sticky bit
452
453       since: 2.0.00
454
455       "APR::Const::FPROT_WWRITE"
456
457       Write by others
458
459       since: 2.0.00
460
461   ":filetype"
462         use APR::Const -compile => qw(:filetype);
463
464       The ":filetype" group is used by "$finfo->filetype".
465
466       "APR::Const::FILETYPE_BLK"
467
468       a file is a block device
469
470       since: 2.0.00
471
472       "APR::Const::FILETYPE_CHR"
473
474       a file is a character device
475
476       since: 2.0.00
477
478       "APR::Const::FILETYPE_DIR"
479
480       a file is a directory
481
482       since: 2.0.00
483
484       "APR::Const::FILETYPE_LNK"
485
486       a file is a symbolic link
487
488       since: 2.0.00
489
490       "APR::Const::FILETYPE_NOFILE"
491
492       the file type is undedetermined.
493
494       since: 2.0.00
495
496       "APR::Const::FILETYPE_PIPE"
497
498       a file is a FIFO or a pipe.
499
500       since: 2.0.00
501
502       "APR::Const::FILETYPE_REG"
503
504       a file is a regular file.
505
506       since: 2.0.00
507
508       "APR::Const::FILETYPE_SOCK"
509
510       a file is a [unix domain] socket.
511
512       since: 2.0.00
513
514       "APR::Const::FILETYPE_UNKFILE"
515
516       a file is of some other unknown type or the type cannot be determined.
517
518       since: 2.0.00
519
520   ":finfo"
521         use APR::Const -compile => qw(:finfo);
522
523       The ":finfo" group is used by "stat()" and "$finfo->valid".
524
525       "APR::Const::FINFO_ATIME"
526
527       Access Time
528
529       since: 2.0.00
530
531       "APR::Const::FINFO_CSIZE"
532
533       Storage size consumed by the file
534
535       since: 2.0.00
536
537       "APR::Const::FINFO_CTIME"
538
539       Creation Time
540
541       since: 2.0.00
542
543       "APR::Const::FINFO_DEV"
544
545       Device
546
547       since: 2.0.00
548
549       "APR::Const::FINFO_DIRENT"
550
551       an atomic unix apr_dir_read()
552
553       since: 2.0.00
554
555       "APR::Const::FINFO_GPROT"
556
557       Group protection bits
558
559       since: 2.0.00
560
561       "APR::Const::FINFO_GROUP"
562
563       Group id
564
565       since: 2.0.00
566
567       "APR::Const::FINFO_ICASE"
568
569       whether device is case insensitive
570
571       since: 2.0.00
572
573       "APR::Const::FINFO_IDENT"
574
575       device and inode
576
577       since: 2.0.00
578
579       "APR::Const::FINFO_INODE"
580
581       Inode
582
583       since: 2.0.00
584
585       "APR::Const::FINFO_LINK"
586
587       Stat the link not the file itself if it is a link
588
589       since: 2.0.00
590
591       "APR::Const::FINFO_MIN"
592
593       type, mtime, ctime, atime, size
594
595       since: 2.0.00
596
597       "APR::Const::FINFO_MTIME"
598
599       Modification Time
600
601       since: 2.0.00
602
603       "APR::Const::FINFO_NAME"
604
605       name in proper case
606
607       since: 2.0.00
608
609       "APR::Const::FINFO_NLINK"
610
611       Number of links
612
613       since: 2.0.00
614
615       "APR::Const::FINFO_NORM"
616
617       All fields provided by an atomic unix apr_stat()
618
619       since: 2.0.00
620
621       "APR::Const::FINFO_OWNER"
622
623       user and group
624
625       since: 2.0.00
626
627       "APR::Const::FINFO_PROT"
628
629       all protections
630
631       since: 2.0.00
632
633       "APR::Const::FINFO_SIZE"
634
635       Size of the file
636
637       since: 2.0.00
638
639       "APR::Const::FINFO_TYPE"
640
641       Type
642
643       since: 2.0.00
644
645       "APR::Const::FINFO_UPROT"
646
647       User protection bits
648
649       since: 2.0.00
650
651       "APR::Const::FINFO_USER"
652
653       User id
654
655       since: 2.0.00
656
657       "APR::Const::FINFO_WPROT"
658
659       World protection bits
660
661       since: 2.0.00
662
663   ":flock"
664         use APR::Const -compile => qw(:flock);
665
666       The ":flock" group is for XXX constants.
667
668       "APR::Const::FLOCK_EXCLUSIVE"
669
670       since: 2.0.00
671
672       "APR::Const::FLOCK_NONBLOCK"
673
674       since: 2.0.00
675
676       "APR::Const::FLOCK_SHARED"
677
678       since: 2.0.00
679
680       "APR::Const::FLOCK_TYPEMASK"
681
682       since: 2.0.00
683
684   ":hook"
685         use APR::Const -compile => qw(:hook);
686
687       The ":hook" group is for XXX constants.
688
689       "APR::Const::HOOK_FIRST"
690
691       since: 2.0.00
692
693       "APR::Const::HOOK_LAST"
694
695       since: 2.0.00
696
697       "APR::Const::HOOK_MIDDLE"
698
699       since: 2.0.00
700
701       "APR::Const::HOOK_REALLY_FIRST"
702
703       since: 2.0.00
704
705       "APR::Const::HOOK_REALLY_LAST"
706
707       since: 2.0.00
708
709   ":limit"
710         use APR::Const -compile => qw(:limit);
711
712       The ":limit" group is for XXX constants.
713
714       "APR::Const::LIMIT_CPU"
715
716       since: 2.0.00
717
718       "APR::Const::LIMIT_MEM"
719
720       since: 2.0.00
721
722       "APR::Const::LIMIT_NOFILE"
723
724       since: 2.0.00
725
726       "APR::Const::LIMIT_NPROC"
727
728       since: 2.0.00
729
730   ":lockmech"
731         use APR::Const -compile => qw(:lockmech);
732
733       The ":lockmech" group is for XXX constants.
734
735       "APR::Const::LOCK_DEFAULT"
736
737       since: 2.0.00
738
739       "APR::Const::LOCK_FCNTL"
740
741       since: 2.0.00
742
743       "APR::Const::LOCK_FLOCK"
744
745       since: 2.0.00
746
747       "APR::Const::LOCK_POSIXSEM"
748
749       since: 2.0.00
750
751       "APR::Const::LOCK_PROC_PTHREAD"
752
753       since: 2.0.00
754
755       "APR::Const::LOCK_SYSVSEM"
756
757       since: 2.0.00
758
759   ":poll"
760         use APR::Const -compile => qw(:poll);
761
762       The ":poll" group is used by "poll".
763
764       "APR::Const::POLLERR"
765
766       since: 2.0.00
767
768       Pending error
769
770       "APR::Const::POLLHUP"
771
772       since: 2.0.00
773
774       Hangup occurred
775
776       "APR::Const::POLLIN"
777
778       since: 2.0.00
779
780       Can read without blocking
781
782       "APR::Const::POLLNVAL"
783
784       since: 2.0.00
785
786       Descriptior invalid
787
788       "APR::Const::POLLOUT"
789
790       since: 2.0.00
791
792       Can write without blocking
793
794       "APR::Const::POLLPRI"
795
796       since: 2.0.00
797
798       Priority data available
799
800   ":read_type"
801         use APR::Const -compile => qw(:read_type);
802
803       The ":read_type" group is for IO constants.
804
805       "APR::Const::BLOCK_READ"
806
807       since: 2.0.00
808
809       the read function blocks
810
811       "APR::Const::NONBLOCK_READ"
812
813       since: 2.0.00
814
815       the read function does not block
816
817   ":shutdown_how"
818         use APR::Const -compile => qw(:shutdown_how);
819
820       The ":shutdown_how" group is for XXX constants.
821
822       "APR::Const::SHUTDOWN_READ"
823
824       since: 2.0.00
825
826       "APR::Const::SHUTDOWN_READWRITE"
827
828       since: 2.0.00
829
830       "APR::Const::SHUTDOWN_WRITE"
831
832       since: 2.0.00
833
834   ":socket"
835         use APR::Const -compile => qw(:socket);
836
837       The ":socket" group is for the "APR::Socket" object constants, in
838       methods "opt_get" and "opt_set".
839
840       The following section discusses in detail each of the ":socket"
841       constants.
842
843       "APR::Const::SO_DEBUG"
844
845       Possible values:
846
847       XXX
848
849       since: 2.0.00
850
851       Turns on debugging information
852
853       "APR::Const::SO_DISCONNECTED"
854
855       Queries the disconnected state of the socket.  (Currently only used on
856       Windows)
857
858       Possible values:
859
860       XXX
861
862       since: 2.0.00
863
864       "APR::Const::SO_KEEPALIVE"
865
866       Keeps connections active
867
868       Possible values:
869
870       XXX
871
872       since: 2.0.00
873
874       "APR::Const::SO_LINGER"
875
876       Lingers on close if data is present
877
878       since: 2.0.00
879
880       "APR::Const::SO_NONBLOCK"
881
882       Turns blocking IO mode on/off for socket.
883
884       Possible values:
885
886         1 nonblocking
887         0 blocking
888
889       For example, to set a socket to a blocking IO mode:
890
891         use APR::Socket ();
892         use APR::Const    -compile => qw(SO_NONBLOCK);
893         ...
894         if ($socket->opt_get(APR::Const::SO_NONBLOCK)) {
895             $socket->opt_set(APR::Const::SO_NONBLOCK => 0);
896         }
897
898       You don't have to query for this option, before setting it. It was done
899       for the demonstration purpose.
900
901       since: 2.0.00
902
903       "APR::Const::SO_RCVBUF"
904
905       Controls the "ReceiveBufferSize" setting
906
907       Possible values:
908
909       XXX
910
911       since: 2.0.00
912
913       "APR::Const::SO_REUSEADDR"
914
915       The rules used in validating addresses supplied to bind should allow
916       reuse of local addresses.
917
918       Possible values:
919
920       XXX
921
922       since: 2.0.00
923
924       "APR::Const::SO_SNDBUF"
925
926       Controls the "SendBufferSize" setting
927
928       Possible values:
929
930       XXX
931
932       since: 2.0.00
933
934   ":status"
935         use APR::Const -compile => qw(:status);
936
937       The ":status" group is for the API that return status code, or set the
938       error variable XXXXXX.
939
940       The following section discusses in detail each of the available
941       ":status" constants.
942
943       "APR::Const::TIMEUP"
944
945       The operation did not finish before the timeout.
946
947       since: 2.0.00
948
949       Due to possible variants in conditions matching "TIMEUP", for checking
950       error codes against this you most likely want to use the
951       "APR::Status::is_TIMEUP" function instead.
952
953   ":table"
954         use APR::Const -compile => qw(:table);
955
956       The ":table" group is for "overlap()" and "compress()" constants.  See
957       "APR::Table" for details.
958
959       "APR::Const::OVERLAP_TABLES_MERGE"
960
961       since: 2.0.00
962
963       See "APR::Table::compress" and "APR::Table::overlap".
964
965       "APR::Const::OVERLAP_TABLES_SET"
966
967       since: 2.0.00
968
969       See "APR::Table::compress" and "APR::Table::overlap".
970
971   ":uri"
972         use APR::Const -compile => qw(:uri);
973
974       The ":uri" group of constants is for manipulating URIs.
975
976       "APR::Const::URI_ACAP_DEFAULT_PORT"
977
978       since: 2.0.00
979
980       "APR::Const::URI_FTP_DEFAULT_PORT"
981
982       since: 2.0.00
983
984       "APR::Const::URI_GOPHER_DEFAULT_PORT"
985
986       since: 2.0.00
987
988       "APR::Const::URI_HTTPS_DEFAULT_PORT"
989
990       since: 2.0.00
991
992       "APR::Const::URI_HTTP_DEFAULT_PORT"
993
994       since: 2.0.00
995
996       "APR::Const::URI_IMAP_DEFAULT_PORT"
997
998       since: 2.0.00
999
1000       "APR::Const::URI_LDAP_DEFAULT_PORT"
1001
1002       since: 2.0.00
1003
1004       "APR::Const::URI_NFS_DEFAULT_PORT"
1005
1006       since: 2.0.00
1007
1008       "APR::Const::URI_NNTP_DEFAULT_PORT"
1009
1010       since: 2.0.00
1011
1012       "APR::Const::URI_POP_DEFAULT_PORT"
1013
1014       since: 2.0.00
1015
1016       "APR::Const::URI_PROSPERO_DEFAULT_PORT"
1017
1018       since: 2.0.00
1019
1020       "APR::Const::URI_RTSP_DEFAULT_PORT"
1021
1022       since: 2.0.00
1023
1024       "APR::Const::URI_SIP_DEFAULT_PORT"
1025
1026       since: 2.0.00
1027
1028       "APR::Const::URI_SNEWS_DEFAULT_PORT"
1029
1030       since: 2.0.00
1031
1032       "APR::Const::URI_SSH_DEFAULT_PORT"
1033
1034       since: 2.0.00
1035
1036       "APR::Const::URI_TELNET_DEFAULT_PORT"
1037
1038       since: 2.0.00
1039
1040       "APR::Const::URI_TIP_DEFAULT_PORT"
1041
1042       since: 2.0.00
1043
1044       "APR::Const::URI_UNP_OMITPASSWORD"
1045
1046       since: 2.0.00
1047
1048       See "APR::URI::unparse".
1049
1050       "APR::Const::URI_UNP_OMITPATHINFO"
1051
1052       since: 2.0.00
1053
1054       See "APR::URI::unparse".
1055
1056       "APR::Const::URI_UNP_OMITQUERY"
1057
1058       since: 2.0.00
1059
1060       See "APR::URI::unparse".
1061
1062       "APR::Const::URI_UNP_OMITSITEPART"
1063
1064       since: 2.0.00
1065
1066       See "APR::URI::unparse".
1067
1068       "APR::Const::URI_UNP_OMITUSER"
1069
1070       since: 2.0.00
1071
1072       See "APR::URI::unparse".
1073
1074       "APR::Const::URI_UNP_OMITUSERINFO"
1075
1076       since: 2.0.00
1077
1078       "APR::Const::URI_UNP_REVEALPASSWORD"
1079
1080       since: 2.0.00
1081
1082       See "APR::URI::unparse".
1083
1084       "APR::Const::URI_WAIS_DEFAULT_PORT"
1085
1086       since: 2.0.00
1087
1088   Other Constants
1089       "APR::PerlIO::PERLIO_LAYERS_ARE_ENABLED"
1090
1091       since: 2.0.00
1092
1093       See "APR::PerlIO::Constants")
1094

Copyright

1099       mod_perl 2.0 and its core modules are copyrighted under The Apache
1100       Software License, Version 2.0.
1101

Authors

1103       The mod_perl development team and numerous contributors.
1104
1105
1106
1107perl v5.12.0                      2007-11-12          docs::api::APR::Const(3)

NAME

Synopsis

Description

Constants

See Also

Copyright

Authors