Annotation of libwww/Library/src/HTNet.c, revision 2.79.2.8
2.23 frystyk 1: /* HTNet.c
2.79 frystyk 2: ** HTNet Class
2.1 frystyk 3: **
2.10 frystyk 4: ** (c) COPYRIGHT MIT 1995.
2.4 frystyk 5: ** Please first read the full copyright statement in the file COPYRIGH.
2.79.2.8! frystyk 6: ** @(#) $Id: HTNet.c,v 2.79.2.7 1996/11/06 15:27:39 eric Exp $
2.4 frystyk 7: **
8: ** This is the implementation of the internal library multithreading
2.1 frystyk 9: ** functions. This includes an interrupt handler and a event loop.
10: **
11: ** History:
2.14 frystyk 12: ** 12 June 94 Written by Henrik Frystyk, frystyk@w3.org
2.17 frystyk 13: ** 31 May 95 Charlie Brooks cbrooks@osf.org
14: **
2.1 frystyk 15: */
16:
2.9 frystyk 17: /* Implemention dependent include files */
2.52 frystyk 18: #include "sysdep.h"
2.9 frystyk 19:
2.1 frystyk 20: /* Library include files */
2.59 frystyk 21: #include "WWWUtil.h"
2.16 frystyk 22: #include "HTProt.h"
2.1 frystyk 23: #include "HTError.h"
2.25 frystyk 24: #include "HTAlert.h"
2.37 frystyk 25: #include "HTParse.h"
2.59 frystyk 26: #include "HTTrans.h"
2.74 frystyk 27: #include "HTHost.h"
28: #include "HTReq.h"
2.65 frystyk 29: #include "HTEvent.h"
2.23 frystyk 30: #include "HTStream.h"
2.79.2.1 eric 31: #include "HTHstMan.h"
32: #include "HTIOStream.h"
2.24 frystyk 33: #include "HTNetMan.h" /* Implemented here */
2.1 frystyk 34:
2.23 frystyk 35: #ifndef HT_MAX_SOCKETS
36: #define HT_MAX_SOCKETS 6
37: #endif
38:
2.74 frystyk 39: #define HASH_SIZE 67
40:
2.79 frystyk 41: typedef struct _BeforeFilter {
42: HTNetBefore * before; /* Filter function */
43: char * tmplate; /* URL template for when to call filter */
44: int order; /* Relative execution order */
2.60 frystyk 45: void * param; /* Local context */
2.79 frystyk 46: } BeforeFilter;
47:
48: typedef struct _AfterFilter {
49: HTNetAfter * after; /* Filter function */
50: char * tmplate; /* URL template for when to call filter */
51: int order; /* Relative execution order */
52: void * param; /* Local context */
53: int status; /* Status of load for when to call filter */
54: } AfterFilter;
2.23 frystyk 55:
56: struct _HTStream {
2.52 frystyk 57: const HTStreamClass * isa;
2.23 frystyk 58: /* ... */
59: };
60:
2.79.2.1 eric 61: struct _HTInputStream {
62: const HTInputStreamClass * isa;
63: /* ... */
64: };
65:
2.79 frystyk 66: PRIVATE HTList * HTBefore = NULL; /* List of global BEFORE filters */
67: PRIVATE HTList * HTAfter = NULL; /* List of global AFTER filters */
2.24 frystyk 68:
2.74 frystyk 69: PRIVATE int MaxActive = HT_MAX_SOCKETS; /* Max active requests */
70: PRIVATE int Active = 0; /* Counts open sockets */
71: PRIVATE int Persistent = 0; /* Counts persistent sockets */
2.1 frystyk 72:
2.74 frystyk 73: PRIVATE HTList ** NetTable = NULL; /* List of net objects */
74: PRIVATE int HTNetCount = 0; /* Counting elements in table */
2.23 frystyk 75:
76: /* ------------------------------------------------------------------------- */
2.79 frystyk 77: /* GENERIC BEFORE and AFTER filter Management */
2.23 frystyk 78: /* ------------------------------------------------------------------------- */
79:
2.79 frystyk 80: PRIVATE int HTBeforeOrder (const void * a, const void * b)
81: {
82: return ((BeforeFilter *) b)->order - ((BeforeFilter *) a)->order;
83: }
84:
85: PRIVATE int HTAfterOrder (const void * a, const void * b)
86: {
87: return ((AfterFilter *) b)->order - ((AfterFilter *) a)->order;
88: }
89:
90: PRIVATE int check_order (int order)
91: {
92: return (order<HT_FILTER_FIRST) ? HT_FILTER_FIRST :
93: (order>HT_FILTER_LAST) ? HT_FILTER_LAST : order;
94: }
95:
96: /*
97: ** Register a BEFORE filter in the list provided by the caller.
98: ** Several filters can be registered in which case they are called
99: ** with the filter ordering in mind.
100: */
101: PUBLIC BOOL HTNetCall_addBefore (HTList * list, HTNetBefore * before,
102: const char * tmplate, void * param,
103: int order)
104: {
105: if (list && before) {
106: BeforeFilter * me;
107: if ((me = (BeforeFilter *) HT_CALLOC(1, sizeof(BeforeFilter)))==NULL)
108: HT_OUTOFMEM("HTNetCall_addBefore");
109: me->before = before;
110: if (tmplate) StrAllocCopy(me->tmplate, tmplate);
111: me->order = check_order(order);
112: me->param = param;
113: if (CORE_TRACE)
114: HTTrace("Net Before.. Add %p with order %d tmplate `%s\' context %p\n",
115: before, me->order, tmplate ? tmplate : "<null>", param);
116: return (HTList_addObject(list, me) &&
117: HTList_insertionSort(list, HTBeforeOrder));
118: }
119: return NO;
120: }
121:
122: /*
123: ** Unregister all instances of a BEFORE filter from a list.
124: */
125: PUBLIC BOOL HTNetCall_deleteBefore (HTList * list, HTNetBefore * before)
126: {
127: if (CORE_TRACE) HTTrace("Net Before.. Delete %p\n", before);
128: if (list && before) {
129: HTList * cur = list;
130: BeforeFilter * pres;
131: while ((pres = (BeforeFilter *) HTList_nextObject(list))) {
132: if (pres->before == before) {
133: HTList_removeObject(list, (void *) pres);
134: HT_FREE(pres->tmplate);
135: HT_FREE(pres);
136: cur = list;
137: }
138: }
139: }
140: return NO;
141: }
142:
143: /*
144: ** Deletes all BEFORE filters in list
145: */
146: PUBLIC BOOL HTNetCall_deleteBeforeAll (HTList * list)
147: {
148: if (CORE_TRACE) HTTrace("Net Before. Delete All filters\n");
149: if (list) {
150: HTList * cur = list;
151: BeforeFilter * pres;
152: while ((pres = (BeforeFilter *) HTList_nextObject(cur))) {
153: HT_FREE(pres->tmplate);
154: HT_FREE(pres);
155: }
156: HTList_delete(list);
157: return YES;
158: }
159: return NO;
160: }
161:
162: /*
163: ** Call all the BEFORE filters in the order specified at registration
164: ** time. We also check for any template and whether it matches or not.
165: ** If a filter returns other than HT_OK then stop and return immediately.
166: ** Otherwise return what the last filter returns.
2.23 frystyk 167: */
2.79 frystyk 168: PUBLIC int HTNetCall_executeBefore (HTList * list, HTRequest * request)
2.23 frystyk 169: {
2.79 frystyk 170: HTParentAnchor * anchor = HTRequest_anchor(request);
171: char * url = HTAnchor_physical(anchor);
172: char * addr = url ? url : HTAnchor_address((HTAnchor *) anchor);
173: int ret = HT_OK;
174: int mode = 0;
175: if (list && request && addr) {
176: BeforeFilter * pres;
177: while ((pres = (BeforeFilter *) HTList_nextObject(list))) {
178: if (!pres->tmplate ||
179: (pres->tmplate && HTStrMatch(pres->tmplate, addr))) {
180: if (CORE_TRACE) HTTrace("Net Before.. calling %p (request %p, context %p)\n",
181: pres->before,
182: request, pres->param);
183: ret = (*pres->before)(request, pres->param, mode);
184: if (ret != HT_OK) break;
185: }
186: }
187: }
188: if (!url) HT_FREE(addr);
189: return ret;
190: }
191:
192: /*
193: ** Register a AFTER filter in the list provided by the caller.
194: ** Several filters can be registered in which case they are called
195: ** with the filter ordering in mind.
196: */
197: PUBLIC BOOL HTNetCall_addAfter (HTList * list, HTNetAfter * after,
198: const char * tmplate, void * param,
199: int status, int order)
200: {
201: if (list && after) {
202: AfterFilter * me;
203: if ((me = (AfterFilter *) HT_CALLOC(1, sizeof(AfterFilter)))==NULL)
204: HT_OUTOFMEM("HTNetCall_addAfter");
205: me->after = after;
206: if (tmplate) StrAllocCopy(me->tmplate, tmplate);
207: me->order = check_order(order);
2.60 frystyk 208: me->param = param;
2.33 frystyk 209: me->status = status;
2.79 frystyk 210: if (CORE_TRACE)
211: HTTrace("Net After... Add %p with order %d tmplate `%s\' code %d context %p\n",
212: after, me->order, tmplate ? tmplate : "<null>", status, param);
213: return (HTList_addObject(list, me) &&
214: HTList_insertionSort(list, HTAfterOrder));
215: }
216: return NO;
217: }
218:
219: /*
220: ** Unregister all instances of an AFTER filter from a list.
221: */
222: PUBLIC BOOL HTNetCall_deleteAfter (HTList * list, HTNetAfter * after)
223: {
224: if (CORE_TRACE) HTTrace("Net After... Delete %p\n", after);
225: if (list && after) {
226: HTList * cur = list;
227: AfterFilter * pres;
228: while ((pres = (AfterFilter *) HTList_nextObject(cur))) {
229: if (pres->after == after) {
230: HTList_removeObject(list, (void *) pres);
231: HT_FREE(pres->tmplate);
232: HT_FREE(pres);
233: cur = list;
234: }
235: }
2.23 frystyk 236: }
237: return NO;
238: }
239:
2.79 frystyk 240: /*
241: ** Unregister all filters registered for a given status.
2.23 frystyk 242: */
2.79 frystyk 243: PUBLIC BOOL HTNetCall_deleteAfterStatus (HTList * list, int status)
2.23 frystyk 244: {
2.79 frystyk 245: if (CORE_TRACE) HTTrace("Net After... Delete all with status %d\n",status);
246: if (list) {
247: HTList * cur = list;
248: AfterFilter * pres;
249: while ((pres = (AfterFilter *) HTList_nextObject(cur))) {
250: if (pres->status == status) {
2.33 frystyk 251: HTList_removeObject(list, (void *) pres);
2.79 frystyk 252: HT_FREE(pres->tmplate);
2.49 frystyk 253: HT_FREE(pres);
2.79 frystyk 254: cur = list;
2.23 frystyk 255: }
256: }
2.79 frystyk 257: return YES;
2.23 frystyk 258: }
259: return NO;
260: }
2.1 frystyk 261:
2.79 frystyk 262: /*
263: ** Deletes all AFTER filters in list
2.23 frystyk 264: */
2.79 frystyk 265: PUBLIC BOOL HTNetCall_deleteAfterAll (HTList * list)
2.23 frystyk 266: {
2.79 frystyk 267: if (CORE_TRACE) HTTrace("Net After. Delete All filters\n");
2.33 frystyk 268: if (list) {
2.79 frystyk 269: HTList * cur = list;
270: AfterFilter * pres;
271: while ((pres = (AfterFilter *) HTList_nextObject(cur))) {
272: HT_FREE(pres->tmplate);
2.49 frystyk 273: HT_FREE(pres);
2.23 frystyk 274: }
2.33 frystyk 275: HTList_delete(list);
2.23 frystyk 276: return YES;
277: }
278: return NO;
279: }
280:
2.79 frystyk 281: /*
282: ** Call all the AFTER filters in the order specified at registration
283: ** time and if it has the right status code and it's not HT_IGNORE.
284: ** We also check for any template and whether it matches or not.
285: ** If a filter returns other than HT_OK then stop and return immediately.
286: ** Otherwise return what the last filter returns.
2.23 frystyk 287: */
2.79 frystyk 288: PUBLIC int HTNetCall_executeAfter (HTList * list, HTRequest * request,
289: int status)
2.23 frystyk 290: {
2.33 frystyk 291: int ret = HT_OK;
2.79 frystyk 292: if (status != HT_IGNORE) {
293: HTParentAnchor * anchor = HTRequest_anchor(request);
294: char * url = HTAnchor_physical(anchor);
295: char * addr = url ? url : HTAnchor_address((HTAnchor *) anchor);
296: HTResponse * response = HTRequest_response(request);
297: if (list && request && addr) {
298: AfterFilter * pres;
299: while ((pres = (AfterFilter *) HTList_nextObject(list))) {
300: if ((pres->status == status || pres->status == HT_ALL) &&
301: (!pres->tmplate ||
302: (pres->tmplate && HTStrMatch(pres->tmplate, addr)))) {
303: if (CORE_TRACE)
304: HTTrace("Net After... calling %p (request %p, response %p, status %d, context %p)\n",
305: pres->after, request, response,
306: status, pres->param);
307: ret = (*pres->after)(request, response, pres->param, status);
308: if (ret != HT_OK) break;
309: }
2.23 frystyk 310: }
311: }
2.79 frystyk 312: if (!url) HT_FREE(addr);
2.1 frystyk 313: }
2.33 frystyk 314: return ret;
315: }
316:
2.79 frystyk 317: /* ------------------------------------------------------------------------- */
318: /* GLOBAL BEFORE and AFTER filter Management */
319: /* ------------------------------------------------------------------------- */
320:
2.33 frystyk 321: /*
322: ** Global set of callback functions BEFORE the request is issued
323: ** list can be NULL
324: */
325: PUBLIC BOOL HTNet_setBefore (HTList *list)
326: {
327: HTBefore = list;
328: return YES;
329: }
330:
331: PUBLIC HTList * HTNet_before (void)
332: {
333: return HTBefore;
334: }
335:
2.79 frystyk 336: PUBLIC BOOL HTNet_addBefore (HTNetBefore * before, const char * tmplate,
337: void * param, int order)
2.33 frystyk 338: {
2.79 frystyk 339: if (!HTBefore) HTBefore = HTList_new();
340: return HTNetCall_addBefore(HTBefore, before, tmplate, param, order);
2.33 frystyk 341: }
342:
2.79 frystyk 343: PUBLIC BOOL HTNet_deleteBefore (HTNetBefore * cbf)
2.33 frystyk 344: {
2.79 frystyk 345: return HTNetCall_deleteBefore(HTBefore, cbf);
2.33 frystyk 346: }
347:
2.79 frystyk 348: /*
349: ** Call both the local and the global BEFORE filters (if any)
350: */
351: PUBLIC int HTNet_executeBeforeAll (HTRequest * request)
2.73 frystyk 352: {
2.79 frystyk 353: int ret;
354: BOOL override = NO;
355: HTList * befores;
356: if ((befores = HTRequest_before(request, &override))) {
357: if ((ret = HTNetCall_executeBefore(befores, request)) != HT_OK)
358: return ret;
359: }
360: return override ? HT_OK : HTNetCall_executeBefore(HTBefore, request);
2.73 frystyk 361: }
362:
2.33 frystyk 363: /*
364: ** Global set of callback functions AFTER the request is issued
365: ** list can be NULL
366: */
367: PUBLIC BOOL HTNet_setAfter (HTList *list)
368: {
369: HTAfter = list;
370: return YES;
371: }
372:
373: PUBLIC HTList * HTNet_after (void)
374: {
375: return HTAfter;
376: }
377:
2.79 frystyk 378: PUBLIC BOOL HTNet_addAfter (HTNetAfter * after, const char * tmplate,
379: void * param, int status, int order)
2.33 frystyk 380: {
2.79 frystyk 381: if (!HTAfter) HTAfter = HTList_new();
382: return HTNetCall_addAfter(HTAfter, after, tmplate, param, status, order);
383: }
2.58 hallam 384:
2.79 frystyk 385: PUBLIC BOOL HTNet_deleteAfter (HTNetAfter * cbf)
386: {
387: return HTNetCall_deleteAfter(HTAfter, cbf);
2.33 frystyk 388: }
389:
2.79 frystyk 390: PUBLIC BOOL HTNet_deleteAfterStatus (int status)
2.33 frystyk 391: {
2.79 frystyk 392: return HTNetCall_deleteAfterStatus(HTAfter, status);
2.73 frystyk 393: }
394:
2.79 frystyk 395: /*
396: ** Call both the local and the global AFTER filters (if any)
397: */
398: PUBLIC int HTNet_executeAfterAll (HTRequest * request, int status)
2.73 frystyk 399: {
2.79 frystyk 400: int ret;
401: BOOL override = NO;
402: HTList * afters;
403: if ((afters = HTRequest_after(request, &override))) {
404: if ((ret = HTNetCall_executeAfter(afters, request, status)) != HT_OK)
405: return ret;
406: }
407: return override ? HT_OK : HTNetCall_executeAfter(HTAfter, request, status);
2.1 frystyk 408: }
409:
2.23 frystyk 410: /* ------------------------------------------------------------------------- */
2.74 frystyk 411: /* Socket Management */
2.23 frystyk 412: /* ------------------------------------------------------------------------- */
2.1 frystyk 413:
2.74 frystyk 414: PUBLIC int HTNet_maxSocket (void)
415: {
416: return MaxActive;
417: }
418:
419: PUBLIC BOOL HTNet_setMaxSocket (int newmax)
420: {
421: if (newmax > 0) {
422: MaxActive = newmax;
423: return YES;
424: }
425: return NO;
426: }
427:
428: PUBLIC void HTNet_increaseSocket (void)
429: {
430: Active++;
431: if (CORE_TRACE) HTTrace("Net Manager. %d open sockets\n", Active);
432: }
433:
434: PUBLIC void HTNet_decreaseSocket (void)
435: {
436: if (--Active < 0) Active = 0;
437: if (CORE_TRACE) HTTrace("Net Manager. %d open sockets\n", Active);
438: }
439:
440: PUBLIC int HTNet_availableSockets (void)
441: {
442: int available = MaxActive - Active;
443: return available > 0 ? available : 0;
444: }
445:
446: PUBLIC void HTNet_increasePersistentSocket (void)
447: {
448: Persistent++;
449: if (CORE_TRACE) HTTrace("Net Manager. %d persistent sockets\n", Persistent);
450: }
451:
452: PUBLIC void HTNet_decreasePersistentSocket (void)
2.23 frystyk 453: {
2.74 frystyk 454: if (--Persistent < 0) Persistent = 0;
455: if (CORE_TRACE) HTTrace("Net Manager. %d persistent sockets\n", Persistent);
2.23 frystyk 456: }
2.17 frystyk 457:
2.74 frystyk 458: PUBLIC int HTNet_availablePersistentSockets (void)
2.28 frystyk 459: {
2.74 frystyk 460: int available = MaxActive - 2 - Persistent;
461: return available > 0 ? available : 0;
2.28 frystyk 462: }
463:
2.74 frystyk 464: /*
465: ** Returns whether there are any Net objects pending or active
2.40 frystyk 466: */
2.74 frystyk 467: PUBLIC BOOL HTNet_isIdle (void)
2.40 frystyk 468: {
2.74 frystyk 469: return (HTNetCount > 0);
2.40 frystyk 470: }
471:
2.74 frystyk 472: PUBLIC BOOL HTNet_isEmpty (void)
2.1 frystyk 473: {
2.74 frystyk 474: return (HTNetCount <= 0);
2.1 frystyk 475: }
476:
2.23 frystyk 477: /* ------------------------------------------------------------------------- */
478: /* Creation and deletion methods */
479: /* ------------------------------------------------------------------------- */
480:
2.74 frystyk 481: PRIVATE HTNet * create_object (void)
482: {
483: static int net_hash = 0;
484: HTNet * me = NULL;
485:
486: /* Create new object */
487: if ((me = (HTNet *) HT_CALLOC(1, sizeof(HTNet))) == NULL)
488: HT_OUTOFMEM("HTNet_new");
489: me->hash = net_hash++ % HASH_SIZE;
490:
491: /* Insert into hash table */
492: if (!NetTable) {
493: if ((NetTable = (HTList **) HT_CALLOC(HASH_SIZE, sizeof(HTList *))) == NULL)
494: HT_OUTOFMEM("create_object");
495: }
496: if (!NetTable[me->hash]) NetTable[me->hash] = HTList_new();
497: HTList_addObject(NetTable[me->hash], (void *) me);
498: HTNetCount++;
499: if (CORE_TRACE)
500: HTTrace("Net Object.. %p created with hash %d\n",me, me->hash);
501: return me;
502: }
503:
2.27 frystyk 504: /* HTNet_duplicate
505: ** ---------------
506: ** Creates a new HTNet object as a duplicate of the same request.
507: ** Returns YES if OK, else NO
508: ** BUG: We do not check if we have a socket free!
509: */
2.43 frystyk 510: PUBLIC HTNet * HTNet_dup (HTNet * src)
2.27 frystyk 511: {
2.74 frystyk 512: if (src) {
513: HTNet * me;
2.75 frystyk 514: int hash;
2.74 frystyk 515: if ((me = create_object()) == NULL) return NULL;
2.75 frystyk 516: hash = me->hash;
2.74 frystyk 517: if (CORE_TRACE) HTTrace("Net Object.. Duplicated %p\n", src);
518: memcpy((void *) me, src, sizeof(HTNet));
2.75 frystyk 519: me->hash = hash; /* Carry over hash entry */
2.74 frystyk 520: return me;
521: }
522: return NULL;
2.27 frystyk 523: }
524:
2.79.2.6 frystyk 525: PUBLIC BOOL HTNet_execute (HTNet * net, HTEventType type)
526: {
527: if (net && net->event.cbf && net->request) {
528: if (CORE_TRACE)
529: HTTrace("Net Object.. Call %p with event type %d and context %p\n",
530: net->event.cbf, type, net->context);
531: (*(net->event.cbf))(HTNet_socket(net), net->context, type);
532: return YES;
533: }
534: return NO;
535: }
536:
2.74 frystyk 537: /*
538: ** Start a Net obejct by calling the protocol module.
2.30 frystyk 539: */
2.74 frystyk 540: PUBLIC BOOL HTNet_start (HTNet * net)
2.30 frystyk 541: {
2.79.2.1 eric 542: if (net && net->event.cbf && net->request) {
2.74 frystyk 543: if (CORE_TRACE) HTTrace("Net Object.. Launching %p\n", net);
2.79.2.7 eric 544: (*(net->event.cbf))(HTNet_socket(net), net->event.param, HTEvent_BEGIN);
2.30 frystyk 545: return YES;
546: }
547: return NO;
548: }
549:
2.37 frystyk 550: /* HTNet_new
551: ** ---------
552: ** This function creates a new HTNet object and assigns the socket number
553: ** to it. This is intended to be used when you are going to listen on a
554: ** socket using the HTDoListen() function in HTTCP.c. The function do NOT
555: ** call any of the callback functions.
556: ** Returns new object or NULL on error
557: */
2.79.2.2 frystyk 558: PUBLIC HTNet * HTNet_new (HTRequest * request)
2.37 frystyk 559: {
2.79.2.2 frystyk 560: HTNet * me;
561: if ((me = create_object()) == NULL) return NULL;
562: me->preemptive = HTRequest_preemptive(request);
563: HTNet_setEventPriority(me, HTRequest_priority(request));
564: me->request = request;
565: HTRequest_setNet(request, me);
566: return me;
2.37 frystyk 567: }
568:
2.67 frystyk 569: /* HTNet_newServer
570: ** ---------------
571: ** Create a new HTNet object as a new request to be handled. If we have
2.74 frystyk 572: ** more than MaxActive connections already then return NO.
2.67 frystyk 573: ** Returns YES if OK, else NO
2.37 frystyk 574: */
2.79.2.1 eric 575:
2.69 frystyk 576: PUBLIC BOOL HTNet_newServer (HTRequest * request, HTNet * net, char * access)
2.37 frystyk 577: {
578: HTProtocol * protocol;
2.67 frystyk 579: HTTransport * tp = NULL; /* added JTD:5/28/96 */
2.79.2.1 eric 580: HTProtCallback * cbf;
2.37 frystyk 581: if (!request) return NO;
582:
583: /* Find a protocol object for this access scheme */
2.46 frystyk 584: protocol = HTProtocol_find(request, access);
2.67 frystyk 585:
586: /* added - JTD:5/28/96 */
587: /* Find a transport object for this protocol */
588: tp = HTTransport_find(request, HTProtocol_transport(protocol));
589: if (tp == NULL) {
2.74 frystyk 590: if (CORE_TRACE) HTTrace("Net Object.. NO TRANSPORT OBJECT\n");
2.67 frystyk 591: return NO;
592: }
593: /* end of additions - JTD:5/28/96 */
594:
2.69 frystyk 595: /* Fill out the net object and bind it to the request object */
2.74 frystyk 596: net->preemptive = (HTProtocol_preemptive(protocol) || HTRequest_preemptive(request));
2.79.2.1 eric 597: #if 0
2.69 frystyk 598: net->protocol = protocol;
599: net->transport = tp; /* added - JTD:5/28/96 */
2.79.2.1 eric 600: #endif
601: net->event.priority = HTRequest_priority(request);
2.69 frystyk 602: net->request = request;
603: HTRequest_setNet(request, net);
2.79.2.1 eric 604: if (!(cbf = HTProtocol_server(protocol))) {
2.74 frystyk 605: if (CORE_TRACE) HTTrace("Net Object.. NO CALL BACK FUNCTION!\n");
2.67 frystyk 606: return NO;
2.37 frystyk 607: }
2.74 frystyk 608:
609: /* Increase the number of retrys for this download */
610: HTRequest_addRetry(request);
2.37 frystyk 611:
612: /* Start the server request */
2.58 hallam 613: if (CORE_TRACE)
2.74 frystyk 614: HTTrace("Net Object.. starting SERVER request %p with net object %p\n", request, net);
2.79.2.1 eric 615: (*(cbf))(HTNet_socket(net), request);
2.37 frystyk 616: return YES;
617: }
2.36 frystyk 618:
2.30 frystyk 619: /* HTNet_new
620: ** ---------
2.23 frystyk 621: ** Create a new HTNet object as a new request to be handled. If we have
2.74 frystyk 622: ** more than MaxActive connections already then put this into the
2.23 frystyk 623: ** pending queue, else start the request by calling the call back
624: ** function registered with this access method.
625: ** Returns YES if OK, else NO
626: */
2.37 frystyk 627: PUBLIC BOOL HTNet_newClient (HTRequest * request)
2.23 frystyk 628: {
2.74 frystyk 629: HTParentAnchor * anchor = HTRequest_anchor(request);
2.59 frystyk 630: HTNet * me = NULL;
631: HTProtocol * protocol = NULL;
632: HTTransport * tp = NULL;
2.37 frystyk 633: char * physical = NULL;
2.74 frystyk 634: int status;
2.79.2.1 eric 635: HTProtCallback * cbf;
636:
2.27 frystyk 637: if (!request) return NO;
2.33 frystyk 638: /*
639: ** First we do all the "BEFORE" callbacks in order to see if we are to
640: ** continue with this request or not. If we receive a callback status
641: ** that is NOT HT_OK then jump directly to the after callbacks and return
642: */
2.79 frystyk 643: if ((status = HTNet_executeBeforeAll(request)) != HT_OK) {
644: HTNet_executeAfterAll(request, status);
2.33 frystyk 645: return YES;
646: }
647:
2.36 frystyk 648: /*
2.79 frystyk 649: ** If no translation was provided by the filters then use the anchor
2.36 frystyk 650: ** address directly
651: */
2.74 frystyk 652: if (!(physical = HTAnchor_physical(anchor))) {
653: char * addr = HTAnchor_address((HTAnchor *) anchor);
654: if (CORE_TRACE) HTTrace("Net Object.. Using default address\n");
655: HTAnchor_setPhysical(anchor, addr);
656: physical = HTAnchor_physical(anchor);
2.49 frystyk 657: HT_FREE(addr);
2.33 frystyk 658: }
659:
2.37 frystyk 660: /* Find a protocol object for this access scheme */
661: {
662: char * access = HTParse(physical, "", PARSE_ACCESS);
663: if ((protocol = HTProtocol_find(request, access)) == NULL) {
2.74 frystyk 664: if (CORE_TRACE) HTTrace("Net Object.. NO PROTOCOL OBJECT\n");
2.49 frystyk 665: HT_FREE(access);
2.37 frystyk 666: return NO;
667: }
2.49 frystyk 668: HT_FREE(access);
2.37 frystyk 669: }
2.59 frystyk 670:
671: /* Find a transport object for this protocol */
672: tp = HTTransport_find(request, HTProtocol_transport(protocol));
673: if (tp == NULL) {
2.74 frystyk 674: if (CORE_TRACE) HTTrace("Net Object.. NO TRANSPORT OBJECT\n");
2.59 frystyk 675: return NO;
676: }
677:
2.23 frystyk 678: /* Create new net object and bind it to the request object */
2.69 frystyk 679: if ((me = create_object()) == NULL) return NO;
2.74 frystyk 680: me->preemptive = (HTProtocol_preemptive(protocol) || HTRequest_preemptive(request));
2.79.2.1 eric 681: #if 0
2.69 frystyk 682: me->priority = HTRequest_priority(request);
2.79.2.1 eric 683: #endif
684: HTNet_setEventPriority(me, HTRequest_priority(request));
2.59 frystyk 685: me->protocol = protocol;
686: me->transport = tp;
2.69 frystyk 687: me->request = request;
688: HTRequest_setNet(request, me);
2.79.2.1 eric 689: if (!(cbf = HTProtocol_client(protocol))) {
2.74 frystyk 690: if (CORE_TRACE) HTTrace("Net Object.. NO CALL BACK FUNCTION!\n");
2.49 frystyk 691: HT_FREE(me);
2.23 frystyk 692: return NO;
693: }
2.74 frystyk 694:
695: /* Increase the number of retrys for this download */
696: HTRequest_addRetry(request);
2.23 frystyk 697:
698: /*
699: ** Check if we can start the request, else put it into pending queue
700: ** If so then call the call back function associated with the anchor.
701: ** We use the INVSOC as we don't have a valid socket yet!
702: */
2.74 frystyk 703: if (CORE_TRACE)
704: HTTrace("Net Object.. starting request %p (retry=%d) with net object %p\n",
705: request, HTRequest_retrys(request), me);
2.79.2.1 eric 706: (*(cbf))(INVSOC, request);
2.36 frystyk 707: return YES;
708: }
709:
2.23 frystyk 710: /* delete_object
711: ** -------------
712: ** Deletes an HTNet object
2.40 frystyk 713: ** Return YES if OK, else NO
2.15 frystyk 714: */
2.79.2.5 frystyk 715: PRIVATE BOOL delete_object (HTNet * net)
2.15 frystyk 716: {
2.74 frystyk 717: if (CORE_TRACE) HTTrace("Net Object.. Remove object %p\n", net);
2.23 frystyk 718: if (net) {
719:
720: /* Close socket */
2.74 frystyk 721: /*
722: ** As we may have a socket available we check for whether
723: ** we can start any pending requests. We do this by asking for
724: ** pending Host objects. If none then use the current object
725: */
2.79.2.1 eric 726: /* (*net->input->isa->consumed)(net->input, net->header_length + net->bytes_read);
727: */
2.74 frystyk 728: HTHost_launchPending(net->host);
729:
730: /*
731: ** Break the link to the request and free the Net object
732: */
733: HTRequest_setNet(net->request, NULL);
2.49 frystyk 734: HT_FREE(net);
2.79.2.5 frystyk 735: return YES;
736: }
737: return NO;
738: }
739:
740: PRIVATE BOOL remove_net (HTNet * net)
741: {
742: if (net && NetTable) {
743: HTList * list = NetTable[net->hash];
744: if (list) {
745: HTList_removeObject(list, (void *) net);
746: delete_object(net);
747: HTNetCount--;
748: return YES;
749: }
2.23 frystyk 750: }
751: return NO;
752: }
753:
2.74 frystyk 754: /*
755: ** Clears the contents of the Net object so that we can use it again.
756: */
757: PUBLIC BOOL HTNet_clear (HTNet * net)
758: {
759: if (net) {
2.79.2.1 eric 760: net->host->channel = NULL;
761: net->readStream = NULL;
762: net->bytesRead = 0;
763: net->bytesWritten = 0;
764: net->headerLength = 0;
2.74 frystyk 765: return YES;
766: }
767: return NO;
768: }
769:
2.23 frystyk 770: /* HTNet_delete
771: ** ------------
772: ** Deletes the HTNet object from the list of active requests and calls
773: ** any registered call back functions IF not the status is HT_IGNORE.
774: ** This is used if we have internal requests that the app doesn't know
775: ** about. We also see if we have pending requests that can be started
776: ** up now when we have a socket free.
777: ** The callback functions are called in the reverse order of which they
778: ** were registered (last one first)
2.40 frystyk 779: ** Return YES if OK, else NO
2.23 frystyk 780: */
781: PUBLIC BOOL HTNet_delete (HTNet * net, int status)
782: {
2.58 hallam 783: if (CORE_TRACE)
2.74 frystyk 784: HTTrace("Net Object.. Delete %p and call AFTER filters\n", net);
785: if (net) {
786: HTRequest * request = net->request;
2.23 frystyk 787:
2.25 frystyk 788: /*
2.74 frystyk 789: ** If we have a premature close then recover the request. Otherwise
790: ** break the link to the Host object and continue deleting the net
791: ** object
2.25 frystyk 792: */
2.74 frystyk 793: if (net->host) {
794: if (status == HT_RECOVER_PIPE) {
795: if (CORE_TRACE) HTTrace("Net Object.. Recovering %p\n", net);
2.79.2.1 eric 796: HTChannel_setSemaphore(net->host->channel, 0);
2.74 frystyk 797: HTHost_clearChannel(net->host, HT_INTERRUPTED);
798: HTHost_setMode(net->host, HT_TP_SINGLE);
799: HTNet_clear(net);
2.58 hallam 800: if (CORE_TRACE)
2.74 frystyk 801: HTTrace("Net Object.. Restarting request %p (retry=%d) with net object %p\n",
802: request, HTRequest_retrys(request), net);
2.78 frystyk 803: #if 0
2.74 frystyk 804: HTHost_launchPending(net->host);
805: return YES;
2.78 frystyk 806: #else
807: return HTNet_start(net);
808: #endif
2.79.2.1 eric 809: }
2.79.2.3 eric 810: HTHost_unregister (net->host, net, HTEvent_READ);
811: HTHost_unregister (net->host, net, HTEvent_WRITE);
2.79.2.1 eric 812: HTHost_free(net->host, status);
813: HTHost_deleteNet(net->host, net);
2.74 frystyk 814: }
815:
816: /* Remove object from the table of Net Objects */
2.79.2.5 frystyk 817: remove_net(net);
818: #if 0
2.74 frystyk 819: if (NetTable) {
820: HTList * list = NetTable[net->hash];
821: if (list) {
822: HTList_removeObject(list, (void *) net);
2.79.2.5 frystyk 823: delete_object(net);
2.74 frystyk 824: HTNetCount--;
2.23 frystyk 825: }
826: }
2.79.2.5 frystyk 827: #endif
2.74 frystyk 828:
829: /* Call AFTER filters */
2.79 frystyk 830: HTNet_executeAfterAll(request, status);
2.74 frystyk 831: return YES;
2.23 frystyk 832: }
833: return NO;
834: }
835:
836: /* HTNet_deleteAll
837: ** ---------------
838: ** Deletes all HTNet object that might either be active or pending
2.74 frystyk 839: ** We DO NOT call the AFTER filters - A crude way of saying goodbye!
2.23 frystyk 840: */
841: PUBLIC BOOL HTNet_deleteAll (void)
842: {
2.58 hallam 843: if (CORE_TRACE)
2.74 frystyk 844: HTTrace("Net Object.. Remove all Net objects, NO filters\n");
845: if (NetTable) {
846: HTList * cur = NULL;
847: HTNet * pres = NULL;
848: int cnt;
849: for (cnt=0; cnt<HASH_SIZE; cnt++) {
850: if ((cur = NetTable[cnt])) {
851: while ((pres = (HTNet *) HTList_nextObject(cur)) != NULL)
2.79.2.5 frystyk 852: delete_object(pres);
2.74 frystyk 853: }
854: HTList_delete(NetTable[cnt]);
2.25 frystyk 855: }
2.74 frystyk 856: HT_FREE(NetTable);
857: HTNetCount = 0;
858: return YES;
2.25 frystyk 859: }
860: return NO;
861: }
862:
2.23 frystyk 863: /* HTNet_kill
864: ** ----------
865: ** Kill the request by calling the call back function with a request for
866: ** closing the connection. Does not remove the object. This is done by
867: ** HTNet_delete() function which is called by the load routine.
868: ** Returns OK if success, NO on error
869: */
2.74 frystyk 870: PUBLIC BOOL HTNet_kill (HTNet * net)
2.23 frystyk 871: {
2.79.2.5 frystyk 872: if (net) {
873: if (CORE_TRACE) HTTrace("Net Object.. Killing %p\n", net);
874: if (net->event.cbf) {
875: (*(net->event.cbf))(HTNet_socket(net), net->event.param, HTEvent_CLOSE);
876: return YES;
877: }
878: return remove_net(net);
2.23 frystyk 879: }
2.79.2.2 frystyk 880: if (CORE_TRACE) HTTrace("Net Object.. No object to kill\n");
2.23 frystyk 881: return NO;
882: }
883:
884: /* HTNet_killAll
885: ** -------------
2.74 frystyk 886: ** Kills all registered net objects by calling the call
2.23 frystyk 887: ** back function with a request for closing the connection. We do not
888: ** remove the HTNet object as it is done by HTNet_delete().
889: ** Returns OK if success, NO on error
890: */
891: PUBLIC BOOL HTNet_killAll (void)
892: {
2.74 frystyk 893: if (CORE_TRACE) HTTrace("Net Object.. Kill ALL Net objects!!!\n");
894: if (NetTable) {
895: HTList * cur = NULL;
896: HTNet * pres = NULL;
897: int cnt;
898: for (cnt=0; cnt<HASH_SIZE; cnt++) {
899: if ((cur = NetTable[cnt])) {
2.75 frystyk 900: while ((pres = (HTNet *) HTList_lastObject(cur)) != NULL)
2.74 frystyk 901: HTNet_kill(pres);
902: }
2.25 frystyk 903: }
2.74 frystyk 904: return YES;
2.25 frystyk 905: }
2.74 frystyk 906: if (CORE_TRACE) HTTrace("Net Object.. No objects to kill\n");
907: return NO;
2.23 frystyk 908: }
2.38 frystyk 909:
910: /* ------------------------------------------------------------------------- */
2.59 frystyk 911: /* Connection Specifics */
912: /* ------------------------------------------------------------------------- */
913:
2.74 frystyk 914: /* HTNet_priority
915: ** --------------
916: ** Get the current priority of the Net object
917: */
918: PUBLIC HTPriority HTNet_priority (HTNet * net)
919: {
2.79.2.1 eric 920: return (net ? net->event.priority : HT_PRIORITY_INV);
2.74 frystyk 921: }
922:
923: /* HTNet_setPriority
924: ** -----------------
925: ** Set the current priority of the Net object
926: ** This will change the priority next time the thread is blocked
927: */
928: PUBLIC BOOL HTNet_setPriority (HTNet * net, HTPriority priority)
929: {
930: if (net) {
2.79.2.1 eric 931: net->event.priority = priority;
2.74 frystyk 932: return YES;
933: }
934: return NO;
935: }
936:
2.59 frystyk 937: /* HTNet_Persistent
938: ** ----------------
939: ** Check whether the net object handles persistent connections
940: ** If we have a DNS entry then check that as well.
941: */
942: PUBLIC BOOL HTNet_persistent (HTNet * net)
943: {
944: return (net && HTHost_isPersistent(net->host));
945: }
946:
947: /* HTNet_persistent
948: ** ----------------
949: ** Set the net object to handle persistent connections
950: ** If we also have a DNS entry then update that as well
951: */
2.74 frystyk 952: PUBLIC BOOL HTNet_setPersistent (HTNet * net,
953: BOOL persistent,
954: HTTransportMode mode)
2.59 frystyk 955: {
956: if (net) {
2.79.2.1 eric 957: BOOL result = HTHost_setPersistent(net->host, persistent, mode);
2.74 frystyk 958: if (CORE_TRACE)
959: HTTrace("Net Object.. Persistent connection set %s %s\n",
960: persistent ? "ON" : "OFF",
961: result ? "succeeded" : "failed");
2.79.2.1 eric 962: return result;
2.59 frystyk 963: }
964: return NO;
965: }
966:
2.66 frystyk 967: /*
968: ** Context pointer to be used in context call back function
969: */
970: PUBLIC BOOL HTNet_setContext (HTNet * net, void * context)
971: {
972: if (net) {
973: net->context = context;
974: return YES;
975: }
976: return NO;
977: }
978:
979: PUBLIC void * HTNet_context (HTNet * net)
980: {
981: return net ? net->context : NULL;
982: }
2.38 frystyk 983:
984: /*
2.60 frystyk 985: ** Get and set the socket number
986: */
987: PUBLIC BOOL HTNet_setSocket (HTNet * net, SOCKET sockfd)
988: {
2.79.2.1 eric 989: if (net && net->host && net->host->channel) {
990: HTChannel_setSocket(net->host->channel, sockfd);
2.60 frystyk 991: return YES;
992: }
993: return NO;
994: }
995:
996: PUBLIC SOCKET HTNet_socket (HTNet * net)
997: {
2.79.2.1 eric 998: return (net && net->host && net->host->channel ? HTChannel_socket(net->host->channel) : INVSOC);
2.69 frystyk 999: }
1000:
1001: /*
1002: ** Get and set the HTRequest object
1003: */
1004: PUBLIC BOOL HTNet_setRequest (HTNet * net, HTRequest * request)
1005: {
1006: if (net && request) {
1007: net->request = request;
1008: return YES;
1009: }
1010: return NO;
1011: }
1012:
1013: PUBLIC HTRequest * HTNet_request (HTNet * net)
1014: {
1015: return (net ? net->request : NULL);
2.60 frystyk 1016: }
1017:
2.79.2.1 eric 1018: #if 0
2.60 frystyk 1019: /*
2.59 frystyk 1020: ** Get and set the HTTransport object
2.38 frystyk 1021: */
2.79.2.1 eric 1022: PUBLIC BOOL HTHost_setTransport (HTHost * me, HTTransport * tp)
2.38 frystyk 1023: {
2.79.2.1 eric 1024: if (me && tp) {
1025: me->transport = tp;
2.38 frystyk 1026: return YES;
1027: }
1028: return NO;
1029: }
1030:
2.79.2.1 eric 1031: PUBLIC HTTransport * HTHost_transport (HTHost * me)
2.38 frystyk 1032: {
2.79.2.1 eric 1033: return (me ? me->transport : NULL);
2.38 frystyk 1034: }
2.79.2.1 eric 1035: #endif
2.38 frystyk 1036:
2.55 frystyk 1037: /*
2.59 frystyk 1038: ** Get and set the HTChannel object
2.55 frystyk 1039: */
2.59 frystyk 1040: PUBLIC BOOL HTNet_setChannel (HTNet * net, HTChannel * channel)
2.55 frystyk 1041: {
2.79.2.8! frystyk 1042: return (net && channel) ? HTHost_setChannel(net->host, channel) : NO;
2.55 frystyk 1043: }
1044:
2.59 frystyk 1045: PUBLIC HTChannel * HTNet_channel (HTNet * net)
2.55 frystyk 1046: {
2.79.2.8! frystyk 1047: return net ? HTHost_channel(net->host) : NULL;
2.59 frystyk 1048: }
1049:
1050: /*
1051: ** Get and set the HTHost object
1052: */
1053: PUBLIC BOOL HTNet_setHost (HTNet * net, HTHost * host)
1054: {
1055: if (net && host) {
1056: net->host = host;
1057: return YES;
1058: }
1059: return NO;
1060: }
1061:
1062: PUBLIC HTHost * HTNet_host (HTNet * net)
1063: {
1064: return (net ? net->host : NULL);
1065: }
1066:
1067: /*
1068: ** Get and set the HTdns object
1069: */
1070: PUBLIC BOOL HTNet_setDns (HTNet * net, HTdns * dns)
1071: {
1072: if (net && dns) {
2.79.2.1 eric 1073: net->host->dns = dns;
2.59 frystyk 1074: return YES;
1075: }
1076: return NO;
1077: }
1078:
1079: PUBLIC HTdns * HTNet_dns (HTNet * net)
1080: {
2.79.2.1 eric 1081: return (net ? net->host->dns : NULL);
2.79.2.4 frystyk 1082: }
1083:
1084: PUBLIC BOOL HTNet_setProtocol (HTNet * net, HTProtocol * protocol)
1085: {
1086: if (net && protocol) {
1087: net->protocol = protocol;
1088: return YES;
1089: }
1090: return NO;
1091: }
1092:
1093: PUBLIC HTProtocol * HTNet_protocol (HTNet * net)
1094: {
1095: return (net ? net->protocol : NULL);
2.59 frystyk 1096: }
1097:
2.72 frystyk 1098: PUBLIC int HTNet_home (HTNet * net)
1099: {
1100: return (net ? net->home : 0);
1101: }
2.59 frystyk 1102:
1103: /*
1104: ** Create the output stream and bind it to the channel
1105: ** Please read the description in the HTIOStream module on the parameters
1106: */
2.79.2.1 eric 1107: PUBLIC HTOutputStream * HTNet_getOutput (HTNet * me, void * param, int mode)
2.59 frystyk 1108: {
2.79.2.1 eric 1109: if (me && me->host && me->host->channel && me->transport) {
1110: HTTransport * tp = me->transport;
1111: HTChannel * ch = me->host->channel;
2.79.2.2 frystyk 1112: HTOutputStream * output = (*tp->output_new)(me->host, ch, param, mode);
2.74 frystyk 1113: HTChannel_setOutput(ch, output);
2.59 frystyk 1114: return output;
1115: }
2.79.2.1 eric 1116: if (CORE_TRACE) HTTrace("Host Object.. Can't create output stream\n");
2.59 frystyk 1117: return NULL;
2.55 frystyk 1118: }
2.79.2.1 eric 1119:
1120: PUBLIC BOOL HTNet_setEventParam(HTNet * net, void * eventParam)
1121: {
1122: if (net) return HTEvent_setParam(&net->event, eventParam);
1123: return NO;
1124: }
1125:
1126: PUBLIC void* HTNet_eventParam(HTNet * net)
1127: {
1128: return net->event.param;
1129: }
1130:
1131: PUBLIC BOOL HTNet_setEventCallback(HTNet * net, HTEventCallback * cbf)
1132: {
1133: if (net) return HTEvent_setCallback(&net->event, cbf);
1134: return NO;
1135: }
1136:
1137: PUBLIC HTEventCallback * HTNet_eventCallback(HTNet * net)
1138: {
1139: return net->event.cbf;
1140: }
1141:
1142: PUBLIC BOOL HTNet_setEventPriority(HTNet * net, HTPriority priority)
1143: {
1144: if (net) return HTEvent_setPriority(&net->event, priority);
1145: return NO;
1146: }
1147:
1148: PUBLIC HTPriority HTNet_eventPriority(HTNet * net)
1149: {
1150: return net->event.priority;
1151: }
1152:
2.79.2.2 frystyk 1153: PUBLIC HTStream * HTNet_readStream(HTNet * net)
2.79.2.1 eric 1154: {
1155: if (!net) return NULL;
1156: return net->readStream;
1157: }
1158:
2.79.2.2 frystyk 1159: PUBLIC BOOL HTNet_setReadStream (HTNet * net, HTStream * stream)
1160: {
1161: if (net) {
1162: net->readStream = stream;
1163: return YES;
1164: }
1165: return NO;
1166: }
Webmaster