Annotation of libwww/Library/src/HTNet.c, revision 2.87
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.87 ! frystyk 6: ** @(#) $Id: HTNet.c,v 2.86 1997/02/11 23:15:28 frystyk 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.81 frystyk 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.81 frystyk 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:
2.80 frystyk 90: PRIVATE int check_order (HTFilterOrder order)
2.79 frystyk 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,
2.80 frystyk 103: HTFilterOrder order)
2.79 frystyk 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,
2.80 frystyk 199: int status, HTFilterOrder order)
2.79 frystyk 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,
2.80 frystyk 337: void * param, HTFilterOrder 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,
2.80 frystyk 379: void * param, int status, HTFilterOrder 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++;
2.87 ! frystyk 431: if (CORE_TRACE)
! 432: HTTrace("Net Manager. Increasing active sockets to %d, %d persistent sockets\n",
! 433: Active, Persistent);
2.74 frystyk 434: }
435:
436: PUBLIC void HTNet_decreaseSocket (void)
437: {
438: if (--Active < 0) Active = 0;
2.87 ! frystyk 439: if (CORE_TRACE)
! 440: HTTrace("Net Manager. Decreasing active sockets to %d, %d persistent sockets\n",
! 441: Active, Persistent);
2.74 frystyk 442: }
443:
444: PUBLIC int HTNet_availableSockets (void)
445: {
446: int available = MaxActive - Active;
447: return available > 0 ? available : 0;
448: }
449:
450: PUBLIC void HTNet_increasePersistentSocket (void)
451: {
452: Persistent++;
2.87 ! frystyk 453: if (CORE_TRACE)
! 454: HTTrace("Net Manager. %d active sockets, increasing persistent sockets to %d\n",
! 455: Active, Persistent);
2.74 frystyk 456: }
457:
458: PUBLIC void HTNet_decreasePersistentSocket (void)
2.23 frystyk 459: {
2.74 frystyk 460: if (--Persistent < 0) Persistent = 0;
2.87 ! frystyk 461: if (CORE_TRACE)
! 462: HTTrace("Net Manager. %d active sockets, decreasing persistent sockets to %d\n",
! 463: Active, Persistent);
2.23 frystyk 464: }
2.17 frystyk 465:
2.74 frystyk 466: PUBLIC int HTNet_availablePersistentSockets (void)
2.28 frystyk 467: {
2.74 frystyk 468: int available = MaxActive - 2 - Persistent;
469: return available > 0 ? available : 0;
2.28 frystyk 470: }
471:
2.74 frystyk 472: /*
473: ** Returns whether there are any Net objects pending or active
2.40 frystyk 474: */
2.74 frystyk 475: PUBLIC BOOL HTNet_isIdle (void)
2.40 frystyk 476: {
2.74 frystyk 477: return (HTNetCount > 0);
2.40 frystyk 478: }
479:
2.74 frystyk 480: PUBLIC BOOL HTNet_isEmpty (void)
2.1 frystyk 481: {
2.74 frystyk 482: return (HTNetCount <= 0);
2.1 frystyk 483: }
484:
2.81 frystyk 485: PUBLIC int HTNet_count (void)
486: {
487: return HTNetCount;
488: }
489:
2.23 frystyk 490: /* ------------------------------------------------------------------------- */
491: /* Creation and deletion methods */
492: /* ------------------------------------------------------------------------- */
493:
2.74 frystyk 494: PRIVATE HTNet * create_object (void)
495: {
496: static int net_hash = 0;
497: HTNet * me = NULL;
498:
499: /* Create new object */
500: if ((me = (HTNet *) HT_CALLOC(1, sizeof(HTNet))) == NULL)
501: HT_OUTOFMEM("HTNet_new");
502: me->hash = net_hash++ % HASH_SIZE;
503:
504: /* Insert into hash table */
505: if (!NetTable) {
506: if ((NetTable = (HTList **) HT_CALLOC(HASH_SIZE, sizeof(HTList *))) == NULL)
507: HT_OUTOFMEM("create_object");
508: }
509: if (!NetTable[me->hash]) NetTable[me->hash] = HTList_new();
510: HTList_addObject(NetTable[me->hash], (void *) me);
511: HTNetCount++;
512: if (CORE_TRACE)
513: HTTrace("Net Object.. %p created with hash %d\n",me, me->hash);
514: return me;
515: }
516:
2.27 frystyk 517: /* HTNet_duplicate
518: ** ---------------
519: ** Creates a new HTNet object as a duplicate of the same request.
520: ** Returns YES if OK, else NO
521: ** BUG: We do not check if we have a socket free!
522: */
2.43 frystyk 523: PUBLIC HTNet * HTNet_dup (HTNet * src)
2.27 frystyk 524: {
2.74 frystyk 525: if (src) {
526: HTNet * me;
2.75 frystyk 527: int hash;
2.74 frystyk 528: if ((me = create_object()) == NULL) return NULL;
2.75 frystyk 529: hash = me->hash;
2.74 frystyk 530: if (CORE_TRACE) HTTrace("Net Object.. Duplicated %p\n", src);
531: memcpy((void *) me, src, sizeof(HTNet));
2.75 frystyk 532: me->hash = hash; /* Carry over hash entry */
2.74 frystyk 533: return me;
534: }
535: return NULL;
2.27 frystyk 536: }
537:
2.81 frystyk 538: PUBLIC BOOL HTNet_execute (HTNet * net, HTEventType type)
539: {
540: if (net && net->event.cbf && net->request) {
541: if (CORE_TRACE)
2.82 frystyk 542: HTTrace("Net Object.. %p calling %p with event type %d and context %p\n",
543: net, net->event.cbf, type, net->event.param);
544: (*(net->event.cbf))(HTNet_socket(net), net->event.param, type);
2.81 frystyk 545: return YES;
546: }
547: return NO;
548: }
549:
2.74 frystyk 550: /*
551: ** Start a Net obejct by calling the protocol module.
2.30 frystyk 552: */
2.74 frystyk 553: PUBLIC BOOL HTNet_start (HTNet * net)
2.30 frystyk 554: {
2.81 frystyk 555: if (net && net->event.cbf && net->request) {
2.74 frystyk 556: if (CORE_TRACE) HTTrace("Net Object.. Launching %p\n", net);
2.81 frystyk 557: (*(net->event.cbf))(HTNet_socket(net), net->event.param, HTEvent_BEGIN);
2.30 frystyk 558: return YES;
559: }
560: return NO;
561: }
562:
2.37 frystyk 563: /* HTNet_new
564: ** ---------
565: ** This function creates a new HTNet object and assigns the socket number
566: ** to it. This is intended to be used when you are going to listen on a
567: ** socket using the HTDoListen() function in HTTCP.c. The function do NOT
568: ** call any of the callback functions.
569: ** Returns new object or NULL on error
570: */
2.81 frystyk 571: PUBLIC HTNet * HTNet_new (HTRequest * request)
2.37 frystyk 572: {
2.81 frystyk 573: HTNet * me;
574: if ((me = create_object()) == NULL) return NULL;
575: me->preemptive = HTRequest_preemptive(request);
576: HTNet_setEventPriority(me, HTRequest_priority(request));
577: me->request = request;
578: HTRequest_setNet(request, me);
579: return me;
2.37 frystyk 580: }
581:
2.67 frystyk 582: /* HTNet_newServer
583: ** ---------------
584: ** Create a new HTNet object as a new request to be handled. If we have
2.74 frystyk 585: ** more than MaxActive connections already then return NO.
2.67 frystyk 586: ** Returns YES if OK, else NO
2.37 frystyk 587: */
2.81 frystyk 588:
2.69 frystyk 589: PUBLIC BOOL HTNet_newServer (HTRequest * request, HTNet * net, char * access)
2.37 frystyk 590: {
591: HTProtocol * protocol;
2.67 frystyk 592: HTTransport * tp = NULL; /* added JTD:5/28/96 */
2.81 frystyk 593: HTProtCallback * cbf;
2.37 frystyk 594: if (!request) return NO;
595:
596: /* Find a protocol object for this access scheme */
2.46 frystyk 597: protocol = HTProtocol_find(request, access);
2.67 frystyk 598:
599: /* added - JTD:5/28/96 */
600: /* Find a transport object for this protocol */
601: tp = HTTransport_find(request, HTProtocol_transport(protocol));
602: if (tp == NULL) {
2.74 frystyk 603: if (CORE_TRACE) HTTrace("Net Object.. NO TRANSPORT OBJECT\n");
2.67 frystyk 604: return NO;
605: }
606: /* end of additions - JTD:5/28/96 */
607:
2.69 frystyk 608: /* Fill out the net object and bind it to the request object */
2.74 frystyk 609: net->preemptive = (HTProtocol_preemptive(protocol) || HTRequest_preemptive(request));
2.81 frystyk 610: #if 0
2.69 frystyk 611: net->protocol = protocol;
612: net->transport = tp; /* added - JTD:5/28/96 */
2.81 frystyk 613: #endif
614: net->event.priority = HTRequest_priority(request);
2.69 frystyk 615: net->request = request;
616: HTRequest_setNet(request, net);
2.81 frystyk 617: if (!(cbf = HTProtocol_server(protocol))) {
2.74 frystyk 618: if (CORE_TRACE) HTTrace("Net Object.. NO CALL BACK FUNCTION!\n");
2.67 frystyk 619: return NO;
2.37 frystyk 620: }
2.74 frystyk 621:
622: /* Increase the number of retrys for this download */
623: HTRequest_addRetry(request);
2.37 frystyk 624:
625: /* Start the server request */
2.58 hallam 626: if (CORE_TRACE)
2.74 frystyk 627: HTTrace("Net Object.. starting SERVER request %p with net object %p\n", request, net);
2.81 frystyk 628: (*(cbf))(HTNet_socket(net), request);
2.37 frystyk 629: return YES;
630: }
2.36 frystyk 631:
2.30 frystyk 632: /* HTNet_new
633: ** ---------
2.23 frystyk 634: ** Create a new HTNet object as a new request to be handled. If we have
2.74 frystyk 635: ** more than MaxActive connections already then put this into the
2.23 frystyk 636: ** pending queue, else start the request by calling the call back
637: ** function registered with this access method.
638: ** Returns YES if OK, else NO
639: */
2.37 frystyk 640: PUBLIC BOOL HTNet_newClient (HTRequest * request)
2.23 frystyk 641: {
2.74 frystyk 642: HTParentAnchor * anchor = HTRequest_anchor(request);
2.59 frystyk 643: HTNet * me = NULL;
644: HTProtocol * protocol = NULL;
645: HTTransport * tp = NULL;
2.37 frystyk 646: char * physical = NULL;
2.74 frystyk 647: int status;
2.81 frystyk 648: HTProtCallback * cbf;
649:
2.27 frystyk 650: if (!request) return NO;
2.33 frystyk 651: /*
652: ** First we do all the "BEFORE" callbacks in order to see if we are to
653: ** continue with this request or not. If we receive a callback status
654: ** that is NOT HT_OK then jump directly to the after callbacks and return
655: */
2.79 frystyk 656: if ((status = HTNet_executeBeforeAll(request)) != HT_OK) {
657: HTNet_executeAfterAll(request, status);
2.33 frystyk 658: return YES;
659: }
660:
2.36 frystyk 661: /*
2.79 frystyk 662: ** If no translation was provided by the filters then use the anchor
2.36 frystyk 663: ** address directly
664: */
2.74 frystyk 665: if (!(physical = HTAnchor_physical(anchor))) {
666: char * addr = HTAnchor_address((HTAnchor *) anchor);
667: if (CORE_TRACE) HTTrace("Net Object.. Using default address\n");
668: HTAnchor_setPhysical(anchor, addr);
669: physical = HTAnchor_physical(anchor);
2.49 frystyk 670: HT_FREE(addr);
2.33 frystyk 671: }
672:
2.37 frystyk 673: /* Find a protocol object for this access scheme */
674: {
2.81 frystyk 675: char * proxy = HTRequest_proxy(request);
676: char * access = HTParse(proxy ? proxy : physical, "", PARSE_ACCESS);
2.37 frystyk 677: if ((protocol = HTProtocol_find(request, access)) == NULL) {
2.74 frystyk 678: if (CORE_TRACE) HTTrace("Net Object.. NO PROTOCOL OBJECT\n");
2.49 frystyk 679: HT_FREE(access);
2.37 frystyk 680: return NO;
681: }
2.49 frystyk 682: HT_FREE(access);
2.37 frystyk 683: }
2.59 frystyk 684:
685: /* Find a transport object for this protocol */
686: tp = HTTransport_find(request, HTProtocol_transport(protocol));
687: if (tp == NULL) {
2.74 frystyk 688: if (CORE_TRACE) HTTrace("Net Object.. NO TRANSPORT OBJECT\n");
2.59 frystyk 689: return NO;
690: }
691:
2.23 frystyk 692: /* Create new net object and bind it to the request object */
2.69 frystyk 693: if ((me = create_object()) == NULL) return NO;
2.74 frystyk 694: me->preemptive = (HTProtocol_preemptive(protocol) || HTRequest_preemptive(request));
2.81 frystyk 695: #if 0
2.69 frystyk 696: me->priority = HTRequest_priority(request);
2.81 frystyk 697: #endif
698: HTNet_setEventPriority(me, HTRequest_priority(request));
2.59 frystyk 699: me->protocol = protocol;
700: me->transport = tp;
2.69 frystyk 701: me->request = request;
702: HTRequest_setNet(request, me);
2.81 frystyk 703: if (!(cbf = HTProtocol_client(protocol))) {
2.74 frystyk 704: if (CORE_TRACE) HTTrace("Net Object.. NO CALL BACK FUNCTION!\n");
2.49 frystyk 705: HT_FREE(me);
2.23 frystyk 706: return NO;
707: }
2.74 frystyk 708:
709: /* Increase the number of retrys for this download */
710: HTRequest_addRetry(request);
2.23 frystyk 711:
712: /*
713: ** Check if we can start the request, else put it into pending queue
714: ** If so then call the call back function associated with the anchor.
715: ** We use the INVSOC as we don't have a valid socket yet!
716: */
2.74 frystyk 717: if (CORE_TRACE)
718: HTTrace("Net Object.. starting request %p (retry=%d) with net object %p\n",
719: request, HTRequest_retrys(request), me);
2.81 frystyk 720: (*(cbf))(INVSOC, request);
2.36 frystyk 721: return YES;
722: }
723:
2.23 frystyk 724: /* delete_object
725: ** -------------
726: ** Deletes an HTNet object
2.40 frystyk 727: ** Return YES if OK, else NO
2.15 frystyk 728: */
2.81 frystyk 729: PRIVATE BOOL delete_object (HTNet * net)
2.15 frystyk 730: {
2.74 frystyk 731: if (CORE_TRACE) HTTrace("Net Object.. Remove object %p\n", net);
2.23 frystyk 732: if (net) {
733:
734: /* Close socket */
2.74 frystyk 735: /*
736: ** As we may have a socket available we check for whether
737: ** we can start any pending requests. We do this by asking for
738: ** pending Host objects. If none then use the current object
739: */
2.81 frystyk 740: /* (*net->input->isa->consumed)(net->input, net->header_length + net->bytes_read);
741: */
2.74 frystyk 742: HTHost_launchPending(net->host);
743:
744: /*
745: ** Break the link to the request and free the Net object
746: */
747: HTRequest_setNet(net->request, NULL);
2.49 frystyk 748: HT_FREE(net);
2.81 frystyk 749: return YES;
750: }
751: return NO;
752: }
753:
754: PRIVATE BOOL remove_net (HTNet * net)
755: {
756: if (net && NetTable) {
757: HTList * list = NetTable[net->hash];
758: if (list) {
759: HTList_removeObject(list, (void *) net);
760: delete_object(net);
761: HTNetCount--;
762: return YES;
763: }
2.23 frystyk 764: }
765: return NO;
766: }
767:
2.74 frystyk 768: /*
769: ** Clears the contents of the Net object so that we can use it again.
770: */
771: PUBLIC BOOL HTNet_clear (HTNet * net)
772: {
773: if (net) {
2.81 frystyk 774: net->host->channel = NULL;
775: net->readStream = NULL;
776: net->bytesRead = 0;
777: net->bytesWritten = 0;
778: net->headerLength = 0;
2.74 frystyk 779: return YES;
780: }
781: return NO;
782: }
783:
2.23 frystyk 784: /* HTNet_delete
785: ** ------------
786: ** Deletes the HTNet object from the list of active requests and calls
787: ** any registered call back functions IF not the status is HT_IGNORE.
788: ** This is used if we have internal requests that the app doesn't know
789: ** about. We also see if we have pending requests that can be started
790: ** up now when we have a socket free.
791: ** The callback functions are called in the reverse order of which they
792: ** were registered (last one first)
2.40 frystyk 793: ** Return YES if OK, else NO
2.23 frystyk 794: */
795: PUBLIC BOOL HTNet_delete (HTNet * net, int status)
796: {
2.58 hallam 797: if (CORE_TRACE)
2.74 frystyk 798: HTTrace("Net Object.. Delete %p and call AFTER filters\n", net);
799: if (net) {
800: HTRequest * request = net->request;
2.23 frystyk 801:
2.25 frystyk 802: /*
2.74 frystyk 803: ** If we have a premature close then recover the request. Otherwise
804: ** break the link to the Host object and continue deleting the net
805: ** object
2.25 frystyk 806: */
2.74 frystyk 807: if (net->host) {
2.81 frystyk 808: HTHost_unregister (net->host, net, HTEvent_READ);
809: HTHost_unregister (net->host, net, HTEvent_WRITE);
2.74 frystyk 810: if (status == HT_RECOVER_PIPE) {
811: HTNet_clear(net);
2.58 hallam 812: if (CORE_TRACE)
2.74 frystyk 813: HTTrace("Net Object.. Restarting request %p (retry=%d) with net object %p\n",
814: request, HTRequest_retrys(request), net);
815: return YES;
2.81 frystyk 816: }
817: HTHost_free(net->host, status);
818: HTHost_deleteNet(net->host, net);
2.74 frystyk 819: }
820:
821: /* Remove object from the table of Net Objects */
2.81 frystyk 822: remove_net(net);
2.82 frystyk 823:
2.74 frystyk 824: /* Call AFTER filters */
2.79 frystyk 825: HTNet_executeAfterAll(request, status);
2.74 frystyk 826: return YES;
2.23 frystyk 827: }
828: return NO;
829: }
830:
831: /* HTNet_deleteAll
832: ** ---------------
833: ** Deletes all HTNet object that might either be active or pending
2.74 frystyk 834: ** We DO NOT call the AFTER filters - A crude way of saying goodbye!
2.23 frystyk 835: */
836: PUBLIC BOOL HTNet_deleteAll (void)
837: {
2.58 hallam 838: if (CORE_TRACE)
2.74 frystyk 839: HTTrace("Net Object.. Remove all Net objects, NO filters\n");
840: if (NetTable) {
841: HTList * cur = NULL;
842: HTNet * pres = NULL;
843: int cnt;
844: for (cnt=0; cnt<HASH_SIZE; cnt++) {
845: if ((cur = NetTable[cnt])) {
846: while ((pres = (HTNet *) HTList_nextObject(cur)) != NULL)
2.81 frystyk 847: delete_object(pres);
2.74 frystyk 848: }
849: HTList_delete(NetTable[cnt]);
2.25 frystyk 850: }
2.74 frystyk 851: HT_FREE(NetTable);
852: HTNetCount = 0;
853: return YES;
2.25 frystyk 854: }
855: return NO;
856: }
857:
2.23 frystyk 858: /* HTNet_kill
859: ** ----------
860: ** Kill the request by calling the call back function with a request for
861: ** closing the connection. Does not remove the object. This is done by
862: ** HTNet_delete() function which is called by the load routine.
863: ** Returns OK if success, NO on error
864: */
2.74 frystyk 865: PUBLIC BOOL HTNet_kill (HTNet * net)
2.23 frystyk 866: {
2.81 frystyk 867: if (net) {
868: if (CORE_TRACE) HTTrace("Net Object.. Killing %p\n", net);
869: if (net->event.cbf) {
870: (*(net->event.cbf))(HTNet_socket(net), net->event.param, HTEvent_CLOSE);
871: return YES;
872: }
873: return remove_net(net);
2.23 frystyk 874: }
2.81 frystyk 875: if (CORE_TRACE) HTTrace("Net Object.. No object to kill\n");
2.23 frystyk 876: return NO;
877: }
878:
879: /* HTNet_killAll
880: ** -------------
2.74 frystyk 881: ** Kills all registered net objects by calling the call
2.23 frystyk 882: ** back function with a request for closing the connection. We do not
883: ** remove the HTNet object as it is done by HTNet_delete().
884: ** Returns OK if success, NO on error
885: */
886: PUBLIC BOOL HTNet_killAll (void)
887: {
2.74 frystyk 888: if (CORE_TRACE) HTTrace("Net Object.. Kill ALL Net objects!!!\n");
889: if (NetTable) {
890: HTList * cur = NULL;
891: HTNet * pres = NULL;
892: int cnt;
893: for (cnt=0; cnt<HASH_SIZE; cnt++) {
894: if ((cur = NetTable[cnt])) {
2.75 frystyk 895: while ((pres = (HTNet *) HTList_lastObject(cur)) != NULL)
2.74 frystyk 896: HTNet_kill(pres);
897: }
2.25 frystyk 898: }
2.74 frystyk 899: return YES;
2.25 frystyk 900: }
2.74 frystyk 901: if (CORE_TRACE) HTTrace("Net Object.. No objects to kill\n");
902: return NO;
2.23 frystyk 903: }
2.38 frystyk 904:
905: /* ------------------------------------------------------------------------- */
2.59 frystyk 906: /* Connection Specifics */
907: /* ------------------------------------------------------------------------- */
908:
2.74 frystyk 909: /* HTNet_priority
910: ** --------------
911: ** Get the current priority of the Net object
912: */
913: PUBLIC HTPriority HTNet_priority (HTNet * net)
914: {
2.81 frystyk 915: return (net ? net->event.priority : HT_PRIORITY_INV);
2.74 frystyk 916: }
917:
918: /* HTNet_setPriority
919: ** -----------------
920: ** Set the current priority of the Net object
921: ** This will change the priority next time the thread is blocked
922: */
923: PUBLIC BOOL HTNet_setPriority (HTNet * net, HTPriority priority)
924: {
925: if (net) {
2.81 frystyk 926: net->event.priority = priority;
2.74 frystyk 927: return YES;
928: }
929: return NO;
930: }
931:
2.59 frystyk 932: /* HTNet_Persistent
933: ** ----------------
934: ** Check whether the net object handles persistent connections
935: ** If we have a DNS entry then check that as well.
936: */
937: PUBLIC BOOL HTNet_persistent (HTNet * net)
938: {
939: return (net && HTHost_isPersistent(net->host));
940: }
941:
942: /* HTNet_persistent
943: ** ----------------
944: ** Set the net object to handle persistent connections
945: ** If we also have a DNS entry then update that as well
946: */
2.74 frystyk 947: PUBLIC BOOL HTNet_setPersistent (HTNet * net,
948: BOOL persistent,
949: HTTransportMode mode)
2.59 frystyk 950: {
951: if (net) {
2.81 frystyk 952: BOOL result = HTHost_setPersistent(net->host, persistent, mode);
2.74 frystyk 953: if (CORE_TRACE)
954: HTTrace("Net Object.. Persistent connection set %s %s\n",
955: persistent ? "ON" : "OFF",
956: result ? "succeeded" : "failed");
2.81 frystyk 957: return result;
2.59 frystyk 958: }
959: return NO;
960: }
961:
2.66 frystyk 962: /*
963: ** Context pointer to be used in context call back function
964: */
965: PUBLIC BOOL HTNet_setContext (HTNet * net, void * context)
966: {
967: if (net) {
968: net->context = context;
969: return YES;
970: }
971: return NO;
972: }
973:
974: PUBLIC void * HTNet_context (HTNet * net)
975: {
976: return net ? net->context : NULL;
977: }
2.38 frystyk 978:
979: /*
2.60 frystyk 980: ** Get and set the socket number
981: */
982: PUBLIC BOOL HTNet_setSocket (HTNet * net, SOCKET sockfd)
983: {
2.81 frystyk 984: if (net && net->host && net->host->channel) {
985: HTChannel_setSocket(net->host->channel, sockfd);
2.60 frystyk 986: return YES;
987: }
988: return NO;
989: }
990:
991: PUBLIC SOCKET HTNet_socket (HTNet * net)
992: {
2.81 frystyk 993: return (net && net->host && net->host->channel ? HTChannel_socket(net->host->channel) : INVSOC);
2.69 frystyk 994: }
995:
996: /*
997: ** Get and set the HTRequest object
998: */
999: PUBLIC BOOL HTNet_setRequest (HTNet * net, HTRequest * request)
1000: {
1001: if (net && request) {
1002: net->request = request;
1003: return YES;
1004: }
1005: return NO;
1006: }
1007:
1008: PUBLIC HTRequest * HTNet_request (HTNet * net)
1009: {
1010: return (net ? net->request : NULL);
2.60 frystyk 1011: }
1012:
1013: /*
2.59 frystyk 1014: ** Get and set the HTChannel object
2.55 frystyk 1015: */
2.59 frystyk 1016: PUBLIC BOOL HTNet_setChannel (HTNet * net, HTChannel * channel)
2.55 frystyk 1017: {
2.81 frystyk 1018: return (net && channel) ? HTHost_setChannel(net->host, channel) : NO;
2.55 frystyk 1019: }
1020:
2.59 frystyk 1021: PUBLIC HTChannel * HTNet_channel (HTNet * net)
2.55 frystyk 1022: {
2.81 frystyk 1023: return net ? HTHost_channel(net->host) : NULL;
2.59 frystyk 1024: }
1025:
1026: /*
1027: ** Get and set the HTHost object
1028: */
1029: PUBLIC BOOL HTNet_setHost (HTNet * net, HTHost * host)
1030: {
1031: if (net && host) {
1032: net->host = host;
1033: return YES;
1034: }
1035: return NO;
1036: }
1037:
1038: PUBLIC HTHost * HTNet_host (HTNet * net)
1039: {
1040: return (net ? net->host : NULL);
1041: }
1042:
1043: /*
1044: ** Get and set the HTdns object
1045: */
1046: PUBLIC BOOL HTNet_setDns (HTNet * net, HTdns * dns)
1047: {
1048: if (net && dns) {
2.81 frystyk 1049: net->host->dns = dns;
2.59 frystyk 1050: return YES;
1051: }
1052: return NO;
1053: }
1054:
1055: PUBLIC HTdns * HTNet_dns (HTNet * net)
1056: {
2.81 frystyk 1057: return (net ? net->host->dns : NULL);
2.59 frystyk 1058: }
1059:
2.81 frystyk 1060: PUBLIC BOOL HTNet_setProtocol (HTNet * net, HTProtocol * protocol)
1061: {
1062: if (net && protocol) {
1063: net->protocol = protocol;
1064: return YES;
1065: }
1066: return NO;
1067: }
1068:
1069: PUBLIC HTProtocol * HTNet_protocol (HTNet * net)
2.72 frystyk 1070: {
2.81 frystyk 1071: return (net ? net->protocol : NULL);
2.72 frystyk 1072: }
2.59 frystyk 1073:
2.86 frystyk 1074: PUBLIC BOOL HTNet_setTransport (HTNet * net, HTTransport * tp)
1075: {
1076: if (net && tp) {
1077: net->transport = tp;
1078: return YES;
1079: }
1080: return NO;
1081: }
1082:
1083: PUBLIC HTTransport * HTNet_transport (HTNet * net)
1084: {
1085: return (net ? net->transport : NULL);
1086: }
1087:
1088: PUBLIC BOOL HTNet_preemptive (HTNet * net)
1089: {
1090: return (net ? net->preemptive : NO);
1091: }
1092:
2.59 frystyk 1093: /*
1094: ** Create the output stream and bind it to the channel
1095: ** Please read the description in the HTIOStream module on the parameters
1096: */
2.81 frystyk 1097: PUBLIC HTOutputStream * HTNet_getOutput (HTNet * me, void * param, int mode)
2.59 frystyk 1098: {
2.81 frystyk 1099: if (me && me->host && me->host->channel && me->transport) {
1100: HTTransport * tp = me->transport;
1101: HTChannel * ch = me->host->channel;
1102: HTOutputStream * output = (*tp->output_new)(me->host, ch, param, mode);
2.74 frystyk 1103: HTChannel_setOutput(ch, output);
2.59 frystyk 1104: return output;
1105: }
2.81 frystyk 1106: if (CORE_TRACE) HTTrace("Host Object.. Can't create output stream\n");
2.59 frystyk 1107: return NULL;
2.81 frystyk 1108: }
1109:
2.87 ! frystyk 1110: PUBLIC HTEvent * HTNet_event (HTNet * net)
2.81 frystyk 1111: {
2.87 ! frystyk 1112: return net ? &net->event : NULL;
! 1113: }
! 1114:
! 1115: PUBLIC BOOL HTNet_setEventParam (HTNet * net, void * eventParam)
! 1116: {
2.81 frystyk 1117: if (net) return HTEvent_setParam(&net->event, eventParam);
1118: return NO;
1119: }
1120:
2.87 ! frystyk 1121: PUBLIC void * HTNet_eventParam (HTNet * net)
2.81 frystyk 1122: {
2.87 ! frystyk 1123: return net ? net->event.param : NULL;
2.81 frystyk 1124: }
1125:
1126: PUBLIC BOOL HTNet_setEventCallback(HTNet * net, HTEventCallback * cbf)
1127: {
1128: if (net) return HTEvent_setCallback(&net->event, cbf);
1129: return NO;
1130: }
1131:
1132: PUBLIC HTEventCallback * HTNet_eventCallback(HTNet * net)
1133: {
1134: return net->event.cbf;
1135: }
1136:
1137: PUBLIC BOOL HTNet_setEventPriority(HTNet * net, HTPriority priority)
1138: {
1139: if (net) return HTEvent_setPriority(&net->event, priority);
1140: return NO;
1141: }
1142:
1143: PUBLIC HTPriority HTNet_eventPriority(HTNet * net)
1144: {
1145: return net->event.priority;
1146: }
1147:
1148: PUBLIC HTStream * HTNet_readStream(HTNet * net)
1149: {
1150: if (!net) return NULL;
1151: return net->readStream;
1152: }
1153:
1154: PUBLIC BOOL HTNet_setReadStream (HTNet * net, HTStream * stream)
1155: {
1156: if (net) {
1157: net->readStream = stream;
1158: return YES;
1159: }
1160: return NO;
2.55 frystyk 1161: }
Webmaster