File: zero.html

package info (click to toggle)
aolserver4 4.5.1-18.1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 12,008 kB
  • sloc: ansic: 45,126; tcl: 5,533; sh: 1,037; makefile: 380; pascal: 219; php: 13
file content (3001 lines) | stat: -rw-r--r-- 69,530 bytes parent folder | download | duplicates (8)
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001

   #Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_AbsoluteUrl
  
    Overview
    
   Construct a URL from a URL and location
   
    Syntax
    
    int Ns_AbsoluteUrl(
    Ns_DString *pds,
    char *url,
    char *baseurl
    );

    Description
    
   The Ns_AbsoluteUrl function constructs a URL, based on url, which may
   be incomplete, and baseurl, which is typically a location.
   
    Examples
    
    Ns_DString ds;
    Ns_DStringInit(&ds);
    Ns_AbsoluteUrl(&ds, "/foo/bar.html", "http://www.foo.com:1234/");

   The ds DString will contain "http://www.foo.com:1234/foo/bar.html".
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_AbsTimedWaitForEvent
  
    Overview
    
   Wait for an event to be broadcast
   
    Syntax
    
    int Ns_AbsTimedWaitForEvent (
    Ns_Cond* event,
    Ns_Mutex* lock,
    time_t abstime
    );

    Description
    
   Wait for an event to be broadcast or the current time to be abstime,
   whichever comes first.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_AdjTime
  
    Overview
    
   Adjust Ns_Time
   
    Syntax
    
    Ns_AdjTime(
    Ns_Time *timePtr
    );

    Description
    
   Adjust an Ns_Time so that the values are in range. If usec is
   negative, sec is decremented; if usec is over 1000000, sec is
   incremented.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_AdpRegisterParser
  
    Overview
    
   Register a parser for ADPs
   
    Syntax
    
    int Ns_AdpRegisterParser (
    char *name,
    Ns_AdpParserProc *newParserProc
    );

    typedef void (Ns_AdpParserProc)(Ns_DString *out, char *in);

    Description
    
   This registers a new ADP parser with the name "name". The
   newParserProc will be called when an ADP is to be parsed. The content
   of the ADP will be in the "in" parameter. The parser should parse it
   and append appropriate output into the "out" parameter.
   
   The output should be formatted as a series of concatenated "chunks". A
   chunk is a string of the format:
    <type character><string><null>
where:

<type character> = 't' or 's'. A 't' means what follows is HTML and should be returneddirectly to the browser. An 's' means what follows is Tcl and should be evaluated.

   After the last chunk there should be an extra <null> character. For
   example, the "adp" parser will take a page like this:
    This is a test page<%ns_puts hi%>The end<%ns_puts bye%>

   And create this output:
    "tThis is a test page\0sns_puts hi\0tThe end\0sns_puts bye\0\0"

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_AllocThreadLocalStorage
  
    Overview
    
   Initialize a local thread storage variable.
   
    Syntax
    
    int Ns_AllocThreadLocalStorage(
    Ns_ThreadLocalStorage * tls,
    void (*destructor) (void *)
    );

    Description
    
   Initializes a thread local storage variable and sets its destructor
   function. The tls's value is initially NULL in all existing threads
   and any new threads which are later created. If the destructor
   function pointer is non-null and the tls is non-null in a particular
   thread when it exits, the destructor will be called for that thread.
   
   Thread local storage is often used to store data which must be shared
   between unrelated functions much like global variables are used in a
   single threaded program. Thread local storage is also often used to
   provide buffer space unique to each thread when making older code
   thread safe.
   
    Examples
    
    static Ns_ThreadLocalStorage tls;

    void
    Init(void)
    {
        /* This function is called once at startup. */
        Ns_AllocThreadLocalStorage(&tls, Ns_Free);
    }

    char *
    GetBuffer
    {
        void *ptr;

        Ns_GetThreadLocalStorage(&tls, &ptr);
        if (ptr == NULL) {
                /* Allocate a buffer for this thread. */
                ptr = Ns_Malloc(BUFFER_SIZE);
                Ns_SetThreadLocalStorage(&tls, ptr);
        }
        return (char *) ptr;
    }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_Asctime
  
    Overview
    
   Perform asctime_r
   
    Syntax
    
    char* Ns_Asctime (
    const struct tm* tmPtr
    );

    Description
    
   This function is a wrapper around asctime_r(3C). This converts a tm
   struture to a 26-character string. The value returned by this function
   will be changed by additional calls to it within the same thread, so
   make a copy of the value if needed.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_AuthorizeRequest
  
    Overview
    
   Check access of a method and URL
   
    Syntax
    
    int Ns_AuthorizeRequest(
    char *hServer,
    char *method,
    char *URL,
    char *authuser,
    char *authpasswd,
    char *ipaddr
    );

    Description
    
   The Ns_AuthorizeRequest function is used to call the function
   registered by Ns_SetRequestAuthorizeProc to authorize a user's access
   to the given method and URL. Possible return values are:
   
   NS_OK
   
   The user's access is authorized.
   
   NS_UNAUTHORIZED
   
   Access is not public for this method or URL and either the user and
   password were not verified or the user does not have permission.
   
   NS_FORBIDDEN
   
   There is no possible user/password combination that would give
   authorization.
   
   NS_ERROR
   
   The authentication function could not perform the permission check.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_AuthorizeUser
  
    Overview
    
   Check username and password
   
    Syntax
    
    int Ns_AuthorizeUser(
    char *user,
    char *passwd
    );

    Description
    
   Checks that the cleartext password is correct for the specified user.
   Returns NS_OK if it matches or NS_ERROR if not (or if no authorization
   procedure is registered).
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_BeginDetachedThread
  
    Overview
    
   Create a detached thread
   
    Syntax
    
    int Ns_BeginDetachedThread(
    Ns_ThreadProc *start_routine,
    void *arg
    );

    Description
    
   Ns_BeginDetachedThread creates a thread which cleans up its data as
   soon as it ends. Note that detached threads' ids can be reused
   immediately by the system, and they cannot be waited on.
   
    Examples
    
    static void
    ThreadStart(void *arg)
    {
        int n;

        n = (int) arg;
        Ns_Log(Notice, "%d: %d", Ns_GetThreadId(), n);
    }

    /*
      * ManyThreads - Create 10 threads which all log a message.
      */
    static void
    ManyThreads(void)
    {
        int i;

        for (i = 0; i < 10; ++i) {
                Ns_BeginDetachedThread(ThreadStart, (void *) i);
        }
    }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_BeginThread
  
    Overview
    
   Start a thread
   
    Syntax
    
    int Ns_BeginThread(
    Ns_ThreadProc *start_routine,
    void *arg,
    Ns_Thread *thread
    );

    Description
    
   Ns_BeginThread starts a new thread running start_routine and passwd
   arg as its context. If thread is non-null it will be filled with the
   thread's id. (see Ns_WaitForThread.)
   
   Ns_ThreadCreate is the preferred function to start a thread.
   
    Examples
    
    static void
    ThreadStart(void *arg)
    {
        int n;

        n = (int) arg;
        Ns_Log(Notice, "%d: %d", Ns_GetThreadId(), n);
    }

    /*
      * ManyThreadWait - Create 10 threads which all log a message
      * and wait for all of them to exit.
      */
    static void
    ManyThreadWait(void)
    {
        int i;
        Ns_Thread tids[10];

        for (i = 0; i < 10; ++i) {
                Ns_BeginThread(ThreadStart, (void *) i, &tids[i]);
        }

        for (i = 0; i < 10; ++i) {
                Ns_WaitForThread(&tids[i]);
        }
    }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_BindSock
  
    Overview
    
   Bind socket as root
   
    Syntax
    
    int Ns_BindSock (
    struct sockaddr_in* saPtr
    );

    Description
    
   Bind a socket as root. This function can only be called before server
   startup.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_BroadcastEvent
  
    Overview
    
   Wake up events that are waiting to be triggered
   
    Syntax
    
    int Ns_BroadcastEvent(
    Ns_Event * event
    );

    Description
    
   Wake up all the threads waiting on the event. If no threads are
   waiting on the event, this function has no effect.
   
    Examples
    
    static Ns_Event myev;
    static Ns_Mutex mylock;

    void
    Init(void)
    {
        /* Initialize the lock and event at startup. */
        Ns_InitializeMutex(&mylock);
        Ns_InitializeEvent(&myev);
    }

    /* Lock the mutex and wait for the event. */
    void
    WaitFunc(void)
    {
        Ns_LockMutex(&mylock);
        Ns_WaitForEvent(&myev, &mylock);
    }

    /* Wake up any waiting threads. */
    void
    BroadcastFunc(void)
    {
        Ns_BroadcastEvent(&myev);
    }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheBroadcast
  
    Overview
    
   Broadcast to condition variable
   
    Syntax
    
    void Ns_CacheBroadcast (
    Ns_Cache* cache
    );

    Description
    
   Broadcast to the cache's condition variable, waking all threads. Every
   cache has an associated cond for user use. Every cache has an
   associated cond for user use.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheCreate
  
    Overview
    
   Create a new cache
   
    Syntax
    
    Ns_Cache* Ns_CacheCreate (
    char* name,
    int keys,
    time_t timeout,
    Ns_Callback* freeProc
    );

    Description
    
   Create a new cache with the specified name. The keys argument is the
   size of the cache key in system words. The timeout argument is the
   time for cache entries to live. The freeProc argument is the
   Ns_Callback to free cache entry data.
   
   For a good example of how to use the Ns_Cache* functions, look at
   nsd/fastpath.c.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheCreateEntry
  
    Overview
    
   Create a cache entry
   
    Syntax
    
    Ns_Entry* Ns_CacheCreateEntry (
    Ns_Cache* cache,
    char* key,
    int* pnew
    );

    Description
    
   Create a new cache entry in the specified cache. This function
   emulates Tcl_CreateHashEntry's interface.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheCreateSz
  
    Overview
    
   Create a size-based cache
   
    Syntax
    
    Ns_Cache* Ns_CacheCreateSz (
    char* name,
    int keys,
    size_t maxsize,
    Ns_Callback* freeProc
    );

    Description
    
   Create a new size-based cache (a cache that has a maximum size in
   bytes, specified by the maxsize argument). The keys argument is
   TCL_STRING_KEYS or TCL_ONE_WORD_KEYS or an integer >=2, which is the
   number of machine words needed to store a cache key. The freeProc
   argument is the Ns_Callback to free cache entry data.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheDeleteEntry
  
    Overview
    
   Delete a cache entry
   
    Syntax
    
    void Ns_CacheDeleteEntry (
    Ns_Entry* entry
    );

    Description
    
   Delete the specified entry from the cache table.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheFind
  
    Overview
    
   Find a cache
   
    Syntax
    
    Ns_Cache* Ns_CacheFind (
    char* name
    );

    Description
    
   Find a cache by name.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheFindEntry
  
    Overview
    
   Find a cache entry
   
    Syntax
    
    Ns_Entry* Ns_CacheFindEntry (
    Ns_Cache* cache,
    char* key
    );

    Description
    
   Find a cache entry.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheFirstEntry
  
    Overview
    
   Get first cache entry
   
    Syntax
    
    Ns_Entry* Ns_CacheFirstEntry (
    Ns_Cache* cache,
    Ns_CacheSearch* searchPtr
    );

    Description
    
   Return a pointer to the first entry in the cache (Cache entries are
   stored in no particular order.)
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheFlush
  
    Overview
    
   Flush all cache entries
   
    Syntax
    
    void Ns_CacheFlush (
    Ns_Cache* cache
    );

    Description
    
   Flush every entry from the specified cache.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheFlushEntry
  
    Overview
    
   Delete a cache entry
   
    Syntax
    
    void Ns_CacheFlushEntry (
    Ns_Entry* entry
    );

    Description
    
   Delete an entry from the cache table after first unsetting the current
   entry value (if any).
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheFree
  
    Overview
    
   Free allocated memory
   
    Syntax
    
    void Ns_CacheFree (
    Ns_Cache* cache,
    void* memPtr
    );

    Description
    
   Frees memory allocated with Ns_CacheMalloc.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheGetValue
  
    Overview
    
   Get value of cache entry
   
    Syntax
    
    void* Ns_CacheGetValue (
    Ns_Entry* entry
    );

    Description
    
   Get the value (contents) of a cache entry.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheKey
  
    Overview
    
   Get key of cache entry
   
    Syntax
    
    char* Ns_CacheKey (
    Ns_Entry* entry
    );

    Description
    
   Gets the key of a cache entry.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheLock
  
    Overview
    
   Lock a cache
   
    Syntax
    
    void Ns_CacheLock (
    Ns_Cache* cache
    );

    Description
    
   Lock the cache. This must be done before performing any read/write
   action on a cache.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheMalloc
  
    Overview
    
   Allocate memory
   
    Syntax
    
    void* Ns_CacheMalloc (
    Ns_Cache* cache,
    size_t len
    );

    Description
    
   Allocate memory from a cache-local pool.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheName
  
    Overview
    
   Get name of cache
   
    Syntax
    
    char* Ns_CacheName (
    Ns_Entry* entry
    );

    Description
    
   Get the name of the cache.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheNextEntry
  
    Overview
    
   Get next cache entry
   
    Syntax
    
    Ns_Entry* Ns_CacheNextEntry (
    Ns_CacheSearch* searchPtr
    );

    Description
    
   Get the next cache entry. When used in conjunction with
   Ns_CacheFirstEntry, you can traverse the whole cache.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheSetValue
  
    Overview
    
   Set value of cache entry
   
    Syntax
    
    void Ns_CacheSetValue (
    Ns_Entry* entry,
    void* value
    );

    Description
    
   Set the value of a cache entry.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheSetValueSz
  
    Overview
    
   Set value of cache entry and adjust cache size
   
    Syntax
    
    void Ns_CacheSetValueSz (
    Ns_Entry* entry,
    void* value,
    size_t size
    );

    Description
    
   Free the cache entry's previous contents, set it to the new contents,
   increase the size of the cache, and prune the cache until it's back
   under the maximum size.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheSignal
  
    Overview
    
   Signal cache's condition variable
   
    Syntax
    
    void Ns_CacheSignal (
    Ns_Cache* cache
    );

    Description
    
   Signal the cache's condition variable, waking the first waiting thread
   (if any).
   
   Note: Consider waking all threads with Ns_CacheBroadcast, instead.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheTimedGetValue
  
    Overview
    
   Wait for cache entry to be set
   
    Syntax
    
    void* Ns_CacheTimedGetValue (
    Ns_Cache* cache,
    char* key,
    Ns_Time* timePtr,
    int* condPtr
    );

    Description
    
   Wait for an entry's value to be set to non-null by some other thread
   up to the given timeout or until an optional condition integer becomes
   zero. Note that the cache and key are given instead of the entry
   because you cannot rely on an entry to remain valid during the
   Ns_CondTimedWait.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheTimedWait
  
    Overview
    
   Wait for condition variable to be set
   
    Syntax
    
    int Ns_CacheTimedWait (
    Ns_Cache* cache,
    Ns_Time* timePtr
    );

    Description
    
   Wait for the cache's condition variable to be signaled or the given
   absolute timeout if timePtr is not NULL.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheUnlock
  
    Overview
    
   Unlock cache
   
    Syntax
    
    void Ns_CacheUnlock (
    Ns_Cache* cache
    );

    Description
    
   Unlock the specified cache.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheUnsetValue
  
    Overview
    
   Reset cache entry to null
   
    Syntax
    
    void Ns_CacheUnsetValue (
    Ns_Entry* entry
    );

    Description
    
   Reset the value of an entry to NULL, calling the free proc for any
   previous entry and updating the cache size.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CacheWait
  
    Overview
    
   Wait indefinitely for condition variable to be set
   
    Syntax
    
    void Ns_CacheWait (
    Ns_Cache* cache
    );

    Description
    
   Wait indefinitely for the cache's condition variable to be signaled.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_Calloc
  
    Overview
    
   Allocate a zero-filled block of memory
   
    Syntax
    
    void *Ns_Calloc(
    size_t num,
    size_t size
    );

    Description
    
   The Ns_Calloc function allocates a block of zero-filled memory large
   enough to hold the given number of elements of the given size. This
   function replaces the system calloc function.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CheckStack
  
    Overview
    
   Check for thread stack overflow
   
    Syntax
    
   int Ns_CheckStack (void);
   
    Description
    
   Check for possible thread stack overflow. This function returns NS_OK
   if stack appears ok, otherwise it returns NS_ERROR.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CloseOnExec
  
    Overview
    
   Set close-on-exec flag
   
    Syntax
    
    int Ns_CloseOnExec (
    int fd
    );

    Description
    
   Set the close-on-exec flag on a file descriptor.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CondBroadcast
  
    Overview
    
   Wake up all threads waiting on a cond
   
    Syntax
    
    void Ns_CondBroadcast (
    Ns_Cond*
    );

    Description
    
   Wake up all threads that are waiting on a cond. For more informations
   on condition variables, look at the pthread_cond_wait(3P) man page.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CondDestroy
  
    Overview
    
   Free a cond's memory
   
    Syntax
    
    void Ns_CondDestroy (
    Ns_Cond *condPtr
    );

    Description
    
   Free a cond's memory.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CondInit
  
    Overview
    
   Initialize a cond
   
    Syntax
    
    void Ns_CondInit (
    Ns_Cond *condPtr
    );

    Description
    
   Initialize a cond. You don't need to call this function if it is
   initialized to 0, as is the case with static variables.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CondSignal
  
    Overview
    
   Wake up a single thread
   
    Syntax
    
    void Ns_CondSignal (
    Ns_Cond *condPtr
    );

    Description
    
   Wake up a single thread blocking on a cond.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CondTimedWait
  
    Overview
    
   Block on a cond
   
    Syntax
    
    int Ns_CondTimedWait (
    Ns_Cond *condPtr ,
    Ns_Mutex *mutexPtr ,
    Ns_Time *timePtr
    );

    Description
    
   Block on a cond until signaled or the specified time expires. The time
   is absolute. The Ns_Time value can be manipulated with Ns_GetTime,
   Ns_DiffTime, or Ns_IncrTime.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_CondWait
  
    Overview
    
   Wait indefinitely on a cond
   
    Syntax
    
    void Ns_CondWait (
    Ns_Cond *condPtr ,
    Ns_Mutex *mutexPtr
    );

    Description
    
   Wait indefinetly on a cond.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConfigGetBool
  
    Overview
    
   Get a boolean configuration file variable
   
    Syntax
    
    int Ns_ConfigGetBool(
    char *hSection,
    char *sKey,
    int *pbValue
    );

    Description
    
   The Ns_ConfigGetBool function returns the boolean value of the
   specified key (sKey) in the specified configuration file section
   (hSection) and puts it into the integer pointed to by pbValue as a 1
   or 0. Values of "1", "y", "yes", "on", "t", and "true" are 1, and
   values of "0", "n", "no", "f", and "false" are 0. If any other value
   is found, a warning is written to the log and NS_FALSE is returned.
   Ns_ConfigGetBool returns NS_TRUE if a valid sKey exists and NS_FALSE
   otherwise.
   
    Examples
    
        int opt;

        if (Ns_ConfigGetBool("MySect", "MyKey", &opt) != NS_TRUE) {
                /* Option was not present or invalid - set a default. */
                opt = 0;        /* off */
        }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConfigGetInt
  
    Overview
    
   Get a configuration file integer variable
   
    Syntax
    
    int Ns_ConfigGetInt(
    char *sectionName,
    char *key,
    int *valuePtr
    );

    Description
    
   This function converts the specified value into an int and stores it
   in valuePtr. If the key does not exist in the config file or it is not
   an integer, the function returns NS_FALSE. Otherwise it returns
   NS_TRUE.
   
    Examples
    
        int n;

        if (Ns_ConfigGetInt("MySect", "MyKey", &n) != NS_TRUE) {
                /* Integer was not present or invalid - set a default. */
                n = 5;  /* off */
        }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConfigGetInt64
  
    Overview
    
   Get a configuration file 64-bit integer variable
   
    Syntax
    
    int Ns_ConfigGetInt64(
    char *hSection,
    char *key,
    INT64 *valuePtr
    );

    Description
    
   This function converts the specified value into an INT64 and stores it
   in valuePtr. If the key does not exist in the config file or it is not
   an integer, the function returns NS_FALSE. Otherwise it returns
   NS_TRUE.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConfigGetPath
  
    Overview
    
   Return configuration file section name
   
    Syntax
    
    char *Ns_ConfigGetPath(
    char *hServer,
    char *module,
    ...
    );

    Description
    
   The Ns_ConfigGetPath function returns a pointer to a configuration
   file section name based on the server (hServer) and module specified.
   The hServer or module may be NULL. A variable number of additional
   path elements are appended. The list must end with NULL. For example,
   Ns_ConfigGetPath("server1", NULL, "special", NULL) will return
   "\NS\Server\server1\special" if such a section exists in the
   configuration file and NULL if it does not.
   
   The space for the string returned is located in the configuration
   data. You do not need to deallocate the string and you must not alter
   it.
   
    Examples
    

    int
    Ns_ModuleInit(char *hServer, char *hModule)
    {
        char *path;
        char *value;

        /*
         * Construct the MySub section name specific to this
         * server and module. For example, if hServer = "vs1"
         * and hModule = "mymod", path would be:
         * [ns/server/vs1/module/mymod/MySudb]
         */
        path = Ns_ConfigGetPath(hServer, hModule, "MySub", NULL);
        value = Ns_ConfigGetValue(path, "MyKey");

        ...

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConfigGetSection
  
    Overview
    
   Get the Ns_Set for a configuration file section
   
    Syntax
    
    Ns_Set *Ns_ConfigGetSection(
    char *sectionName
    );

    Description
    
   This function returns the entire section as an Ns_Set, where the
   fields of the set correspond to the entries of the section in the
   config file. The fields are stored in the Ns_Set in the same order in
   which they appear in the configuration file section. This is useful if
   you want to loop through all the entries of a section. If the section
   does not exist, Ns_ConfigGetSection returns NULL.
   
   The Ns_Set returned is located in the configuration data. You do not
   need to free the set and you must not alter it.
   
    Examples
    

        Ns_Set *section;
        int i;
        char *key;

        /* Log the keys of the "MySection" config section. */
        section = Ns_ConfigGetSection("MySection");
        for (i = 0; i < Ns_SetSize(section); ++i) {
                key = Ns_SetKey(section, i);
                Ns_Log(Notice, "key %d: %s", i, key);
        }
        ...

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConfigGetSections
  
    Overview
    
   Return Ns_Sets with configuration file data
   
    Syntax
    
    Ns_Set **Ns_ConfigGetSections(void);

    Description
    
   The Ns_ConfigGetSections function allocates and returns a
   null-terminated list of Ns_Sets. Each Ns_Set structure contains the
   configuration file data for a configuration file section.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConfigGetValue
  
    Overview
    
   Get a configuration file variable
   
    Syntax
    
    char *Ns_ConfigGetValue(
    char *sectionName,
    char *key
    );

    Description
    
   This function returns the value for the given key in the section named
   sectionName. If either the section does not exist or the key does not
   exist in the section, the function returns NULL. If multiple keys of
   the same name are in the named section (for example, the multiple Load
   lines of the Modules section), this function returns only the first
   matching entry. The section names must match exactly, but the key will
   be matched case-insensitively. Ns_ConfigGetValueExact is the
   case-sensitive counterpart of this function.
   
   The space for the string returned is located in the configuration
   data. You must not deallocate or modify the string.
   
    Examples
    
        /* Fetch the home directory of the AOLserver. */

        char *home;

        home = Ns_ConfigGetValue("ns/parameters", "Home");

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConfigGetValueExact
  
    Overview
    
   Get configuration variable case-sensitively
   
    Syntax
    
    char *Ns_ConfigGetValueExact(
    char *sectionName,
    char *key,
    );

    Description
    
   The Ns_ConfigGetValueExact function is a case-sensitive counterpart to
   the Ns_ConfigGetValue function. It matches both the section name and
   the key case-sensitively. It returns the value for the given key in
   the section named sectionName.
   
   The space for the string returned is located in the configuration
   data. You must not deallocate or modify the string.
   
    Examples
    
   See the example for Ns_ConfigGetValue.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnAuthPasswd
  
    Overview
    
   Return password
   
    Syntax
    
    char *Ns_ConnAuthPasswd(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnAuthPasswd function returns the decoded password from the
   header information associated with the connection.
   
    Examples
    
    /* PassTrace - A server trace to log users and passwords. */
    void
    PassTrace(void *ctx, Ns_Conn *conn)
    {
        char *user;
        char *pass;

        user = Ns_ConnAuthUser(conn);
        pass = Ns_ConnAuthPasswd(conn);
        if (user != NULL && pass != NULL) {
                Ns_Log(Notice, "User: %s Password: %s", user, pass);
        }
    }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnAuthUser
  
    Overview
    
   Return user name
   
    Syntax
    
    char *Ns_ConnAuthUser(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnAuthUser function returns the decoded user name from the
   header information associated with the connection.
   
    Examples
    
   See the example for Ns_ConnAuthPasswd.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnClose
  
    Overview
    
   Close a connection
   
    Syntax
    
    int Ns_ConnClose(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnClose function closes a connection. The semantics of this
   call are specific to the driver associated with the connection. In the
   case of a socket driver (the nssock module), this function will cause
   the socket associated with the connection to be closed. Ns_ConnClose
   returns a status of NS_OK or NS_ERROR.
   
   This function is called by AOLserver before running any registered
   traces. You do not normally need to call it.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnCondSetHeaders
  
    Overview
    
   Set the value for a header field conditionally
   
    Syntax
    
    void Ns_ConnCondSetHeaders(
    Ns_Conn *conn,
    char *field,
    char *value
    );

    Description
    
   The Ns_ConnCondSetHeaders function sets the value of a field if and
   only if the field/value pair does not already exist. The search for an
   existing field is not case sensitive.
   
    Examples
    
        /* Set a Cookie header if not already set. */
        Ns_ConnCondSetHeaders(conn, "Cookie", "randomStuff");

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnConstructHeaders
  
    Overview
    
   Put HTTP header into DString
   
    Syntax
    
    void Ns_ConnConstructHeaders(
    Ns_Conn *conn,
    Ns_DString *dsPtr
    );

    Description
    
   Put the header of an HTTP response into the DString. Content-Length
   and Connection-Keepalive headers will be added if possible.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnContentLength
  
    Overview
    
   Return content length
   
    Syntax
    
    int Ns_ConnContentLength(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnContentLength function returns the number of bytes in the
   content associated with the connection.
   
    Examples
    
        /* Copy the content from the browser to a DString. */
        Ns_DString ds;
        int len;

        Ns_DStringInit(&ds);
        len = Ns_ConnContentLength(conn);
        Ns_ConnCopyToDString(conn, len, &ds);

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnContentSent
  
    Overview
    
   Check if browser sent content
   
    Syntax
    
    int Ns_ConnContentSent (
    Ns_Conn* conn
    );

    Description
    
   Returns TRUE if the browser sent any content, such as in a PUT
   request. Returns FALSE otherwise.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnCopyToChannel
  
    Overview
    
   Copy content to Tcl channel
   
    Syntax
    
    int Ns_ConnCopyToChannel (
    Ns_Conn* conn,
    size_t iToCopy,
    Tcl_Channel chan
    );

    Description
    
   Copy content, such as in a PUT request, from the connection into an
   open Tcl channel. iToCopy bytes will be copied.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnCopyToDString
  
    Overview
    
   Copy data from connection to dynamic string
   
    Syntax
    
    int Ns_ConnCopyToDString(
    Ns_Conn *conn,
    size_t iToCopy,
    Ns_DString *pds
    );

    Description
    
   The Ns_ConnCopyToDString function copies iToCopy bytes of data from
   the connection to the Ns_DString pointed to by pds.
   Ns_ConnCopyToDString returns a status of NS_OK or NS_ERROR.
   
    Examples
    
   See the example for Ns_ConnContentLength.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnCopyToFd
  
    Overview
    
   Copy content to file descriptor
   
    Syntax
    
    int Ns_ConnCopyToFd (
    Ns_Conn* conn,
    size_t iToCopy,
    int fd
    );

    Description
    
   Copy content, such as in a PUT request, from the connection into an
   open file descriptor. iToCopy bytes will be copied.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnCopyToFile
  
    Overview
    
   Copy data from connection to a file
   
    Syntax
    
    int Ns_ConnCopyToFile(
    Ns_Conn *conn,
    size_t iToCopy,
    FILE *fp
    );

    Description
    
   The Ns_ConnCopyToFile function copies iToCopy bytes of data from the
   connection to the file pointed to by fp. Ns_ConnCopyToFile returns a
   status of NS_OK or NS_ERROR.
   
    Examples
    
        /* Copy the content from the browser to a file. */
        FILE *fp;
        int len;

        fp = fopen("content.out", "w");
        len = Ns_ConnContentLength(conn);
        Ns_ConnCopyToFile(conn, len, fp);
        fclose(fp);

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnDriverContext
  
    Overview
    
   Return driver context
   
    Syntax
    
    void *Ns_ConnDriverContext(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnDriverContext function returns a pointer to the
   communications driver context associated with the connection. This
   context is set in the Ns_QueueConn function. This function exists
   primarily for AOLserver communications driver developers.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnDriverName
  
    Overview
    
   Return driver name
   
    Syntax
    
    char *Ns_ConnDriverName(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnDriverName function returns the communications driver name
   associated with the connection.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnFlushContent
  
    Overview
    
   Flush remaining content
   
    Syntax
    
    int Ns_ConnFlushContent (
    Ns_Conn* conn
    );

    Description
    
   Read all remaining content sent by the browser, for example in a PUT
   request, and throw it away.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnFlushHeaders
  
    Overview
    
   Mark the end of the headers
   
    Syntax
    
    int Ns_ConnFlushHeaders(
    Ns_Conn *conn,
    int status
    );

    Description
    
   The Ns_ConnFlushHeaders functions returns a single blank line that
   signifies the end of the headers. It also sets the state of the
   connection from header buffering mode to immediate sending of data to
   the client. Before this function is called, any headers are not
   actually sent to the client but instead are buffered in the Ns_Conn
   structure to avoid the cost of sending the headers in individual
   network packets.
   
   The status is a standard error code such as 403 for access denied or
   200 for OK. Returns NS_OK or NS_ERROR.
   
   This function is normally required just before sending content to the
   client.
   
    Examples
    
    /* A simple Hello request function. */
    int
    MyHello(Ns_Conn *conn, void *ctx)
    {
        char hello[] = "hello";
        int len;

        len = strlen(hello);
        Ns_ConnSetRequiredHeaders(conn, "text/plain", len);
        Ns_ConnFlushHeaders(conn, 200);
        return Ns_ConnWrite(conn, hello, len);
    }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnGetQuery
  
    Overview
    
   Construct Ns_Set representing query data
   
    Syntax
    
    Ns_Set *Ns_ConnGetQuery(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnGetQuery function constructs and returns an Ns_Set
   structure representing the query data associated with the connection.
   It reads the POST content or the query string. The POST content takes
   precedence over the query string.
   
   Note that you must not call Ns_SetFree on the result of this function.
   
    Examples
    
        /* Get the value from an <INPUT NAME="mydata"> form tag. */
        Ns_Set *set;
        char *value;

        set = Ns_ConnGetQuery(conn);
        if (set != NULL) {
                value = Ns_SetGetValue(set, "mydata");
        }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnGets
  
    Overview
    
   Read content into a buffer
   
    Syntax
    
    char *Ns_ConnGets(
    char *buf,
    size_t sz,
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnGets function reads sz bytes of a single line (until
   newline/cr) from the connection into the buffer specified by buf.
   Ns_ConnGets returns buf or, in the case of a read error, NULL.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnHeaders
  
    Overview
    
   Return headers
   
    Syntax
    
    Ns_Set *Ns_ConnHeaders(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnHeaders function returns, as an Ns_Set, the headers
   associated with the connection.
   
    Examples
    
        /* Log the Referer header. */
        Ns_Set *headers;
        char *refer;

        headers = Ns_ConnHeaders(conn);
        if (headers != NULL) {
                refer = Ns_SetGet(headers, "Referer");
                if (refer != NULL) {
                        Ns_Log(Notice, "Referer: %s", refer);
                }
        }

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnHost
  
    Overview
    
   Return host
   
    Syntax
    
    char *Ns_ConnHost(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnHost function returns the server hostname associated with
   the connection.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnInit
  
    Overview
    
   Run socket init procedure
   
    Syntax
    
    int Ns_ConnInit (
    Ns_Conn* connPtr
    );

    Description
    
   Run a socket driver's init procedure. This function is usually only
   called internally.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnLocation
  
    Overview
    
   Return location
   
    Syntax
    
    char *Ns_ConnLocation(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnLocation function returns the HTTP location associated with
   the connection. For example: http://www.avalon.com:81.
   
   Multiple communications drivers can be loaded into a single server.
   This means a server may have more than one location. For example, if
   the nsssl module is loaded and bound to port 8000 and the nssock
   module is loaded and bound to port 9000, the server would have the
   following two locations:

        http://www.avalon.com:9000
        https://www.avalon.com:8000

   For this reason it is important to use the Ns_ConnLocation function to
   determine the driver location at run time.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnModifiedSince
  
    Overview
    
   Determine if content modified since a specified date
   
    Syntax
    
    int Ns_ConnModifiedSince(
    Ns_Conn *conn,
    time_t mtime
    );

    Description
    
   The Ns_ConnModifiedSince function returns 1 if the content associated
   with the connection has been modified since mtime. It uses the HTTP
   header variable "If-Modified-Since".
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnOutputHeaders
  
    Overview
    
   Get Ns_Set of headers to send to client
   
    Syntax
    
    Ns_Set * Ns_ConnOutputHeaders(
    Ns_Conn *conn
    );

    Description
    
   Get a writeable Ns_Set containing headers to send back to the client.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnPeer
  
    Overview
    
   Return name of peer
   
    Syntax
    
    char *Ns_ConnPeer(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnPeer function returns the name of the peer associated with
   the connection.
   
   The peer address is determined by the communications driver in use by
   the connection. Typically it is a dotted IP address, for example,
   199.221.53.205, but this is not guaranteed.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnPeerPort
  
    Overview
    
   Return peer port
   
    Syntax
    
    int Ns_ConnPeerPort (
    Ns_Conn* conn
    );

    Description
    
   Returns the port from which the peer is connected.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnPort
  
    Overview
    
   Return port
   
    Syntax
    
    int Ns_ConnPort(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnPort function returns the server port number associated
   with the connection.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnPrintfHeader
  
    Overview
    
   Return a formatted header
   
    Syntax
    
    int Ns_ConnPrintfHeader(
    Ns_Conn *conn,
    char *fmt,
    ...
    );

    Description
    
   The Ns_ConnPrintfHeader function constructs a formatted string using
   the given format specification and any optional arguments. It then
   appends the necessary line feed and carriage return characters and
   sends the header to the client.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnPuts
  
    Overview
    
   Send a string to a client
   
    Syntax
    
    int Ns_ConnPuts(
    Ns_Conn *conn,
    char *string
    );

    Description
    
   The Ns_ConnPuts function sends the given string to the client. It
   returns NS_OK on success and NS_ERROR on failure.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnRead
  
    Overview
    
   Read content into buffer
   
    Syntax
    
    int Ns_ConnRead(
    Ns_Conn *conn,
    void *pvBuf,
    int iToRead
    );

    Description
    
   The Ns_ConnRead function reads iToRead bytes from the connection into
   pvBuf. Ns_ConnRead returns the status NS_ERROR or the number of bytes
   read from the connection.
   
    Examples
    
    /* Read content from the browser into buf. */
    char buf[1024];

    Ns_ConnRead(conn, buf, sizeof(buf));

   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReadHeaders
  
    Overview
    
   Read headers into Ns_Set
   
    Syntax
    
    int Ns_ConnReadHeaders (
    Ns_Conn* conn,
    Ns_Set* psetHeaders,
    int* iRead
    );

    Description
    
   Read headers from the conn and put them into the passed-in set.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReadLine
  
    Overview
    
   Read a line from a connection
   
    Syntax
    
    int Ns_ConnReadLine(
    Ns_Conn *conn,
    Ns_DString *pdsLine,
    int* *iRead
    );

    Description
    
   The Ns_ConnReadLine function reads an \n or \r terminated line from
   the connection into the Ns_DString pointed to by pdsLine. The iRead
   argument will contain the number of bytes read. Ns_ConnReadLine
   returns a status of NS_OK or NS_ERROR.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnRedirect
  
    Overview
    
   Perform internal redirect
   
    Syntax
    
    int Ns_ConnRedirect (
    Ns_Conn* conn,
    char* url
    );

    Description
    
   Perform an internal redirect, i.e., make it appear that the user
   requested a different URL and then run that request. This doesn't
   require an additional thread.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReplaceHeaders
  
    Overview
    
   Replace output headers for connection
   
    Syntax
    
    void Ns_ConnReplaceHeaders(
    Ns_Conn *conn,
    Ns_Set *newheaders
    );

    Description
    
   The Ns_ConnReplaceHeaders function sets the current output headers for
   the connection to the newheaders set. It copies the newheaders set and
   frees memory associated with the old output headers in the connection.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnResponseLength
  
    Overview
    
   Return response length
   
    Syntax
    
    int Ns_ConnResponseLength(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnResponseStatus function returns the response length
   associated with the connection. This value is only meaningful after a
   response has been returned to the client. This function will normally
   be used in trace functions. See Ns_RegisterTrace for more information
   about traces.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnResponseStatus
  
    Overview
    
   Return response status
   
    Syntax
    
    int Ns_ConnResponseStatus(
    Ns_Conn *conn
    );

    Description
    
   The Ns_ConnResponseStatus function returns the response status
   associated with the connection. This value is only meaningful after a
   response has been returned to the client. This function will normally
   be used in trace functions. See Ns_RegisterTrace for more information
   about traces.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReturnAdminNotice
  
    Overview
    
   Return a short notice to a client to contact system administrator
   
    Syntax
    
    void Ns_ConnReturnAdminNotice(
    Ns_Conn *conn,
    int status,
    char *notice,
    char *html
    );

    Description
    
   The Ns_ConnReturnAdminNotice function returns to a client a simple
   HTML page with the given notice as the title of the page. It also
   appends a message directing users to contact the system administrator
   or web master if specified in the configuration file. The page
   includes the /NS/Asset/notice.gif image at the top of the page. If the
   html parameter is not NULL, it is added to the page after the notice.
   The HTML source can be arbitrarily long and should not contain the
   <HTML> or <BODY> begin or end tags; these tags will be added by
   Ns_ConnReturnAdminNotice. Ns_ConnReturnAdminNotice returns a status of
   NS_OK or NS_ERROR.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReturnBadRequest
  
    Overview
    
   Return an "invalid request" HTTP status line.
   
    Syntax
    
    int Ns_ConnReturnBadRequest(
    Ns_Conn *conn,
    char *reason
    );

    Description
    
   Calls Ns_ConnReturnStatus or Ns_ConnReturnNotice with a status code of
   400 to indicate that the request was invalid.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReturnData
  
    Overview
    
   Return an HTML string to a client
   
    Syntax
    
    EXTERN int Ns_ConnReturnData(
    Ns_Conn *conn,
    int status,
    char *html,
    int len,
    char *type
    );

    Description
    
   The Ns_ConnReturnData function calls the Ns_ConnSetRequiredHeaders
   function with the given status followed by the given HTML string. The
   length is used to generate the Content-Length header. If the length is
   -1, the function calculates the Content-Length from the string. The
   type is used to generate the Content-Type header. Ns_ConnReturnData
   returns a status of NS_OK or NS_ERROR.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReturnFile
  
    Overview
    
   Return a file to a client
   
    Syntax
    
    int Ns_ConnReturnFile(
    Ns_Conn *conn,
    int status,
    char *type,
    char *file
    );

    Description
    
   The Ns_ConnReturnFile function returns the entire contents of the
   given file to the client. In addition to setting the HTTP status
   response line and Content-Type headers from the given parameters,
   Ns_ConnReturnFile also uses the stat system call to generate the
   appropriate Last-Modified and Content-Length headers.
   Ns_ConnReturnFile returns a status of NS_OK or NS_ERROR.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReturnForbidden
  
    Overview
    
   Return a "request forbidden" HTTP status line.
   
    Syntax
    
    int Ns_ConnReturnForbidden(
    Ns_Conn *conn
    );

    Description
    
   Calls Ns_ConnReturnStatus or Ns_ConnReturnNotice with a status code of
   403 to indicate that the request is forbidden. There is no
   Authorization header that will authorize access from this IP address.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.
   
   Previous ToC Index Next
   
   [as-c-sm.gif] [ Previous ] [ Contents ] [ Index ] [ Next ] 
   
  Ns_ConnReturnHtml
  
    Overview
    
   Return an HTML string to a client
   
    Syntax
    
    int Ns_ConnReturnHtml(
    Ns_Conn *conn,
    int status,
    char *html,
    int len
    );

    Description
    
   The Ns_ConnReturnHtml function calls the Ns_ConnSetRequiredHeaders
   function with the given status followed by the given HTML string. The
   length is used to generate the Content-Length header. If the length is
   -1, the function calculates the Content-Length from the string.
   Ns_ConnReturnHtml returns a status of NS_OK or NS_ERROR.
   
   [bluebult.gif] Top of Page [bluebult.gif]
   
               [ Previous ] [ Contents ] [ Index ] [ Next ] 
                  Copyright  1998-99 America Online, Inc.