Annotation of libwww/Library/src/HTNet.c, revision 2.61

2.23      frystyk     1: /*                                                                  HTNet.c
                      2: **     ASYNCRONOUS SOCKET MANAGEMENT
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.61    ! eric        6: **     @(#) $Id: HTNet.c,v 2.60 1996/04/14 01:23:14 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.23      frystyk    27: #include "HTReqMan.h"
2.17      frystyk    28: #include "HTEvntrg.h"
2.23      frystyk    29: #include "HTStream.h"
2.24      frystyk    30: #include "HTNetMan.h"                                   /* Implemented here */
2.1       frystyk    31: 
2.23      frystyk    32: #ifndef HT_MAX_SOCKETS
                     33: #define HT_MAX_SOCKETS 6
                     34: #endif
                     35: 
2.33      frystyk    36: typedef struct _NetCall {
2.30      frystyk    37:     HTNetCallback *    cbf;
2.60      frystyk    38:     void *             param;                              /* Local context */
2.23      frystyk    39:     int                status;      /* Status associated with this callback */
2.33      frystyk    40: } NetCall;
2.23      frystyk    41: 
                     42: struct _HTStream {
2.52      frystyk    43:     const HTStreamClass *      isa;
2.23      frystyk    44:     /* ... */
                     45: };
                     46: 
                     47: PRIVATE int    HTMaxActive = HT_MAX_SOCKETS;         /* Max active requests */
2.33      frystyk    48: PRIVATE HTList *HTBefore = NULL;             /* List of call back functions */
                     49: PRIVATE HTList *HTAfter = NULL;                      /* List of call back functions */
2.24      frystyk    50: 
2.23      frystyk    51: PRIVATE HTList *HTNetActive = NULL;               /* List of active requests */
                     52: PRIVATE HTList *HTNetPending = NULL;            /* List of pending requests */
2.24      frystyk    53: PRIVATE HTList *HTNetPersistent = NULL;           /* List of persistent connections */
2.1       frystyk    54: 
                     55: /* ------------------------------------------------------------------------- */
                     56: 
2.23      frystyk    57: /*
                     58: **     Set the max number of simultanous sockets. Default is HT_MAX_SOCKETS
2.1       frystyk    59: */
2.23      frystyk    60: PUBLIC BOOL HTNet_setMaxSocket (int newmax)
                     61: {
                     62:     if (newmax > 0) {
                     63:        HTMaxActive = newmax;
                     64:        return YES;
                     65:     }
                     66:     return NO;
                     67: }
                     68: 
                     69: PUBLIC int HTNet_maxSocket (void)
2.1       frystyk    70: {
2.23      frystyk    71:     return HTMaxActive;
                     72: }
                     73: 
                     74: /* ------------------------------------------------------------------------- */
2.33      frystyk    75: /*                             Call Back Functions                          */
2.23      frystyk    76: /* ------------------------------------------------------------------------- */
                     77: 
2.33      frystyk    78: /*     HTNetCall_add
                     79: **     -------------
                     80: **     Register a call back function that is to be called on every request.
                     81: **     Several call back functions can be registered
2.23      frystyk    82: **     in which case all of them are called in the order of which they
                     83: **     were registered.
                     84: **
                     85: **     The status signifies which call back function to call depending of the 
                     86: **     result of the request. This can be
                     87: **
                     88: **             HT_ERROR        An error occured
                     89: **             HT_LOADED       The document was loaded
                     90: **             HT_NO_DATA      OK, but no data
2.33      frystyk    91: **             HT_REDIRECT     If we received a redirection
2.23      frystyk    92: **             HT_RETRY        Retry request after at a later time
                     93: **             HT_ALL          All of above
                     94: */
2.60      frystyk    95: PUBLIC BOOL HTNetCall_add (HTList * list, HTNetCallback * cbf,
                     96:                           void * param, int status)
2.23      frystyk    97: {
2.58      hallam     98:     if (CORE_TRACE) 
2.60      frystyk    99:        HTTrace("Call Add.... HTNetCallback %p with context %p\n",
                    100:                (void *) cbf, param);
2.33      frystyk   101:     if (list && cbf) {
2.49      frystyk   102:        NetCall *me;
                    103:        if ((me = (NetCall  *) HT_CALLOC(1, sizeof(NetCall))) == NULL)
                    104:            HT_OUTOFMEM("HTNetCall_add");
2.33      frystyk   105:        me->cbf = cbf;
2.60      frystyk   106:        me->param = param;
2.33      frystyk   107:        me->status = status;
                    108:        return HTList_addObject(list, (void *) me);
2.23      frystyk   109:     }
                    110:     return NO;
                    111: }
                    112: 
2.33      frystyk   113: /*     HTNetCall_delete
                    114: **     ----------------
                    115: **     Unregister a call back function from a list
2.23      frystyk   116: */
2.33      frystyk   117: PUBLIC BOOL HTNetCall_delete (HTList * list, HTNetCallback *cbf)
2.23      frystyk   118: {
2.58      hallam    119:     if (CORE_TRACE) 
2.50      eric      120:        HTTrace("Call delete HTNetCallback %p\n", (void *) cbf);
2.33      frystyk   121:     if (list && cbf) {
                    122:        HTList *cur = list;
                    123:        NetCall *pres;
                    124:        while ((pres = (NetCall *) HTList_nextObject(cur))) {
2.23      frystyk   125:            if (pres->cbf == cbf) {
2.33      frystyk   126:                HTList_removeObject(list, (void *) pres);
2.49      frystyk   127:                HT_FREE(pres);
2.23      frystyk   128:                return YES;
                    129:            }
                    130:        }
                    131:     }
                    132:     return NO;
                    133: }
2.1       frystyk   134: 
2.33      frystyk   135: /*     HTNetCall_deleteAll
2.23      frystyk   136: **     -------------------
                    137: **     Unregisters all call back functions
                    138: */
2.33      frystyk   139: PUBLIC BOOL HTNetCall_deleteAll (HTList * list)
2.23      frystyk   140: {
2.58      hallam    141:     if (CORE_TRACE) 
2.50      eric      142:        HTTrace("Call delete All callback functions\n");
2.33      frystyk   143:     if (list) {
                    144:        HTList *cur = list;
                    145:        NetCall *pres;
                    146:        while ((pres = (NetCall *) HTList_nextObject(cur))) {
                    147:            HTList_removeObject(list, (void *) pres);
2.49      frystyk   148:            HT_FREE(pres);
2.23      frystyk   149:        }
2.33      frystyk   150:        HTList_delete(list);
2.23      frystyk   151:        return YES;
                    152:     }
                    153:     return NO;
                    154: }
                    155: 
2.33      frystyk   156: /*     HTNetCall_execute
                    157: **     -----------------
2.23      frystyk   158: **     Call all the call back functions registered in the list IF not the 
                    159: **     status is HT_IGNORE.
                    160: **     The callback functions are called in the order of which they
                    161: **     were registered. At the moment an application callback function is
                    162: **     called, it can free the request object - it is no longer used by the
                    163: **     Library.
2.33      frystyk   164: **     Returns what the last callback function returns
2.23      frystyk   165: */
2.33      frystyk   166: PUBLIC int HTNetCall_execute (HTList * list, HTRequest * request, int status)
2.23      frystyk   167: {
2.33      frystyk   168:     int ret = HT_OK;
                    169:     if (list && request && status != HT_IGNORE) {      
                    170:        int cnt = HTList_count(list);
2.23      frystyk   171:        while (--cnt >= 0) {
2.33      frystyk   172:            NetCall *pres = (NetCall *) HTList_objectAt(list, cnt);
2.23      frystyk   173:            if (pres && (pres->status == status || pres->status == HT_ALL)) {
2.58      hallam    174:                if (CORE_TRACE)
2.50      eric      175:                    HTTrace("Net callback %p (request=%p, status=%d)\n",
2.23      frystyk   176:                            (void *) pres->cbf, request, status);
2.60      frystyk   177:                if ((ret=(*(pres->cbf))(request, pres->param,status)) != HT_OK)
                    178:                    break;
2.23      frystyk   179:            }
                    180:        }
2.1       frystyk   181:     }
2.33      frystyk   182:     return ret;
                    183: }
                    184: 
                    185: /*
                    186: **     Global set of callback functions BEFORE the request is issued
                    187: **     list can be NULL
                    188: */
                    189: PUBLIC BOOL HTNet_setBefore (HTList *list)
                    190: {
2.57      eric      191: /*    if (HTBefore) HTNetCall_deleteAll(HTBefore); */
2.33      frystyk   192:     HTBefore = list;
                    193:     return YES;
                    194: }
                    195: 
                    196: PUBLIC HTList * HTNet_before (void)
                    197: {
                    198:     return HTBefore;
                    199: }
                    200: 
                    201: PUBLIC int HTNet_callBefore (HTRequest *request, int status)
                    202: {
2.58      hallam    203:     int ret;
                    204:     BOOL override = NO;
                    205:     HTList * befores;
                    206: 
                    207:     if ((befores = HTRequest_before(request, &override))) {
                    208:          if ((ret = HTNetCall_execute(befores, request, status)) != HT_OK)
                    209:             return ret;
                    210:     }
                    211:     if (override)
                    212:         return HT_OK;
2.33      frystyk   213:     return HTNetCall_execute(HTBefore, request, status);
                    214: }
                    215: 
2.60      frystyk   216: PUBLIC BOOL HTNetCall_addBefore (HTNetCallback * cbf, void * param, int status)
2.33      frystyk   217: {
                    218:     if (!HTBefore) HTBefore = HTList_new();
2.60      frystyk   219:     return HTNetCall_add(HTBefore, cbf, param, status);
2.33      frystyk   220: }
                    221: 
                    222: /*
                    223: **     Global set of callback functions AFTER the request is issued
                    224: **     list can be NULL
                    225: */
                    226: PUBLIC BOOL HTNet_setAfter (HTList *list)
                    227: {
2.57      eric      228: /*    if (HTAfter) HTNetCall_deleteAll(HTAfter); */
2.33      frystyk   229:     HTAfter = list;
                    230:     return YES;
                    231: }
                    232: 
                    233: PUBLIC HTList * HTNet_after (void)
                    234: {
                    235:     return HTAfter;
                    236: }
                    237: 
                    238: PUBLIC int HTNet_callAfter (HTRequest *request, int status)
                    239: {
2.58      hallam    240:     int ret;
                    241:     BOOL override = NO;
                    242:     HTList * afters;
                    243: 
                    244:     if ((afters = HTRequest_after(request, &override))) {
                    245:          if ((ret = HTNetCall_execute(afters, request, status)) != HT_OK)
                    246:             return ret;
                    247:     }
                    248:     if (override)
                    249:         return HT_OK;
2.33      frystyk   250:     return HTNetCall_execute(HTAfter, request, status);
                    251: }
                    252: 
2.60      frystyk   253: PUBLIC BOOL HTNetCall_addAfter (HTNetCallback * cbf, void * param, int status)
2.33      frystyk   254: {
                    255:     if (!HTAfter) HTAfter = HTList_new();
2.60      frystyk   256:     return HTNetCall_add(HTAfter, cbf, param, status);
2.1       frystyk   257: }
                    258: 
2.23      frystyk   259: /* ------------------------------------------------------------------------- */
                    260: /*                             Request Queue                                */
                    261: /* ------------------------------------------------------------------------- */
2.1       frystyk   262: 
2.23      frystyk   263: /*     HTNet_activeQueue
                    264: **     -----------------
                    265: **     Returns the list of active requests that are currently having an open
                    266: **     connection.
                    267: **     Returns list of HTNet objects or NULL if error
2.1       frystyk   268: */
2.23      frystyk   269: PUBLIC HTList *HTNet_activeQueue (void)
                    270: {
                    271:     return HTNetActive;
                    272: }
2.17      frystyk   273: 
2.40      frystyk   274: /*     HTNet_idle
                    275: **     ----------
                    276: **     Returns whether there are active requests
2.28      frystyk   277: */
2.29      frystyk   278: PUBLIC BOOL HTNet_idle (void)
2.28      frystyk   279: {
2.29      frystyk   280:     return HTList_isEmpty(HTNetActive);
2.28      frystyk   281: }
                    282: 
2.40      frystyk   283: /*     HTNet_empty
                    284: **     -----------
                    285: **     Returns whether there are requests registered or not
                    286: */
                    287: PUBLIC BOOL HTNet_isEmpty (void)
                    288: {
                    289:     return (HTList_isEmpty(HTNetActive) && HTList_isEmpty(HTNetPersistent) &&
                    290:            HTList_isEmpty(HTNetPending));
                    291: }
                    292: 
2.23      frystyk   293: /*     HTNet_pendingQueue
                    294: **     ------------------
                    295: **     Returns the list of pending requests that are waiting to become active
                    296: **     Returns list of HTNet objects or NULL if error
                    297: */
                    298: PUBLIC HTList *HTNet_pendingQueue (void)
2.1       frystyk   299: {
2.23      frystyk   300:     return HTNetPending;
2.1       frystyk   301: }
                    302: 
2.23      frystyk   303: /* ------------------------------------------------------------------------- */
                    304: /*                       Creation and deletion methods                      */
                    305: /* ------------------------------------------------------------------------- */
                    306: 
2.27      frystyk   307: /*     HTNet_duplicate
                    308: **     ---------------
                    309: **     Creates a new HTNet object as a duplicate of the same request.
                    310: **     Returns YES if OK, else NO
                    311: **     BUG: We do not check if we have a socket free!
                    312: */
2.43      frystyk   313: PUBLIC HTNet * HTNet_dup (HTNet * src)
2.27      frystyk   314: {
2.43      frystyk   315:     HTNet * me;
2.54      eric      316:     if (!src) return 0;
2.49      frystyk   317:     if ((me = (HTNet *) HT_MALLOC(sizeof(HTNet))) == NULL)
                    318:        HT_OUTOFMEM("HTNet_dup");
2.44      frystyk   319:     memcpy((void *) me, src, sizeof(HTNet));
2.43      frystyk   320:     return me;
2.27      frystyk   321: }
                    322: 
2.30      frystyk   323: /*     HTNet_priority
                    324: **     --------------
                    325: **     Get the current priority of the Net object
                    326: */
                    327: PUBLIC HTPriority HTNet_priority (HTNet * net)
                    328: {
2.51      frystyk   329:     return (net ? net->priority : HT_PRIORITY_INV);
2.30      frystyk   330: }
                    331: 
                    332: /*     HTNet_setPriority
                    333: **     -----------------
                    334: **     Set the current priority of the Net object
                    335: **     This will change the priority next time the thread is blocked
                    336: */
                    337: PUBLIC BOOL HTNet_setPriority (HTNet * net, HTPriority priority)
                    338: {
                    339:     if (net) {
                    340:        net->priority = priority;
                    341:        return YES;
                    342:     }
                    343:     return NO;
                    344: }
                    345: 
2.36      frystyk   346: /*     create_object
                    347: **     -------------
                    348: **     Creates an HTNet object
                    349: */
                    350: PRIVATE HTNet * create_object (HTRequest * request)
                    351: {
                    352:     HTNet * me;
2.49      frystyk   353:     if ((me = (HTNet *) HT_CALLOC(1, sizeof(HTNet))) == NULL)
                    354:         HT_OUTOFMEM("HTNet_new");
2.36      frystyk   355:     me->request = request;
                    356:     request->net = me;
2.37      frystyk   357:     me->tcpstate = TCP_BEGIN;
2.47      frystyk   358:     if (!HTNetActive) HTNetActive = HTList_new();
2.36      frystyk   359:     return me;
                    360: }
                    361: 
2.37      frystyk   362: /*     HTNet_new
                    363: **     ---------
                    364: **     This function creates a new HTNet object and assigns the socket number
                    365: **     to it. This is intended to be used when you are going to listen on a 
                    366: **     socket using the HTDoListen() function in HTTCP.c. The function do NOT
                    367: **     call any of the callback functions.
                    368: **     Returns new object or NULL on error
                    369: */
                    370: PUBLIC HTNet * HTNet_new (HTRequest * request, SOCKET sockfd)
                    371: {
                    372:     HTNet * me;
2.58      hallam    373:     if (CORE_TRACE) HTTrace("HTNet_new... Create empty Net object\n");
2.37      frystyk   374:     if (!request || sockfd==INVSOC) return NULL;
                    375:     if ((me = create_object(request)) == NULL) return NULL;
2.45      frystyk   376:     me->preemptive = request->preemptive;
2.37      frystyk   377:     me->priority = request->priority;
                    378:     me->sockfd = sockfd;
                    379:     return me;
                    380: }
                    381: 
                    382: /*     HTNet_newServer
                    383: **     ---------------
                    384: **     Create a new HTNet object as a new request to be handled. If we have
                    385: **     more than HTMaxActive connections already then return NO.
                    386: **     Returns YES if OK, else NO
                    387: */
2.46      frystyk   388: PUBLIC BOOL HTNet_newServer (HTRequest * request, SOCKET sockfd, char * access)
2.37      frystyk   389: {
                    390:     HTNet * me;
                    391:     HTProtocol * protocol;
                    392:     if (!request) return NO;
                    393: 
                    394:     /* Check if we can start the request, else return immediately */
                    395:     if (HTList_count(HTNetActive) > HTMaxActive) {
2.60      frystyk   396:        if (CORE_TRACE) HTTrace("HTNet new... NO SOCKET AVAILABLE\n");
2.61    ! eric      397:        HTNet_callAfter(request, HT_RETRY);
2.37      frystyk   398:        return YES;
                    399:     }
                    400: 
                    401:     /* Find a protocol object for this access scheme */
2.46      frystyk   402:     protocol = HTProtocol_find(request, access);
2.37      frystyk   403:        
                    404:     /* Create new net object and bind it to the request object */
                    405:     if ((me = create_object(request)) == NULL) return NO;
2.45      frystyk   406:     me->preemptive = (HTProtocol_preemptive(protocol) || request->preemptive);
2.59      frystyk   407:     me->protocol = protocol;
2.37      frystyk   408:     me->priority = request->priority;
2.38      frystyk   409:     me->sockfd = sockfd;
2.37      frystyk   410:     if (!(me->cbf = HTProtocol_server(protocol))) {
2.58      hallam    411:        if (CORE_TRACE) HTTrace("HTNet_new... NO CALL BACK FUNCTION!\n");
2.49      frystyk   412:        HT_FREE(me);
2.37      frystyk   413:        return NO;
                    414:     }
                    415:     request->retrys++;
                    416: 
                    417:     /* Start the server request */
                    418:     HTList_addObject(HTNetActive, (void *) me);
2.58      hallam    419:     if (CORE_TRACE)
2.50      eric      420:        HTTrace("HTNet_new... starting SERVER request %p with net object %p\n", request, me);
2.37      frystyk   421:     (*(me->cbf))(me->sockfd, request, FD_NONE);
                    422:     return YES;
                    423: }
2.36      frystyk   424: 
2.30      frystyk   425: /*     HTNet_new
                    426: **     ---------
2.23      frystyk   427: **     Create a new HTNet object as a new request to be handled. If we have
                    428: **     more than HTMaxActive connections already then put this into the
                    429: **     pending queue, else start the request by calling the call back
                    430: **     function registered with this access method. 
                    431: **     Returns YES if OK, else NO
                    432: */
2.37      frystyk   433: PUBLIC BOOL HTNet_newClient (HTRequest * request)
2.23      frystyk   434: {
2.33      frystyk   435:     int status;
2.59      frystyk   436:     HTNet * me = NULL;
                    437:     HTProtocol * protocol = NULL;
                    438:     HTTransport * tp = NULL;
2.37      frystyk   439:     char * physical = NULL;
2.27      frystyk   440:     if (!request) return NO;
2.33      frystyk   441:     /*
                    442:     ** First we do all the "BEFORE" callbacks in order to see if we are to
                    443:     ** continue with this request or not. If we receive a callback status
                    444:     ** that is NOT HT_OK then jump directly to the after callbacks and return
                    445:     */
2.58      hallam    446:     if ((status = HTNet_callBefore(request, HT_OK)) != HT_OK) {
                    447:        HTNet_callAfter(request, status);
2.33      frystyk   448:        return YES;
                    449:     }
                    450: 
2.36      frystyk   451:     /*
                    452:     ** If no translation was provided by the application then use the anchor
                    453:     ** address directly
                    454:     */
2.33      frystyk   455:     if (!(physical = HTAnchor_physical(request->anchor)) || !*physical) {
2.36      frystyk   456:        char * addr = HTAnchor_address((HTAnchor *) request->anchor);
2.58      hallam    457:        if (CORE_TRACE) HTTrace("HTNet New... Using default address\n");
2.36      frystyk   458:        HTAnchor_setPhysical(request->anchor, addr);
2.37      frystyk   459:        physical = HTAnchor_physical(request->anchor);
2.49      frystyk   460:        HT_FREE(addr);
2.33      frystyk   461:     }
                    462: 
2.37      frystyk   463:     /* Find a protocol object for this access scheme */
                    464:     {
                    465:        char * access = HTParse(physical, "", PARSE_ACCESS);
                    466:        if ((protocol = HTProtocol_find(request, access)) == NULL) {
2.58      hallam    467:            if (CORE_TRACE) HTTrace("HTNet_new... NO PROTOCOL OBJECT\n");
2.49      frystyk   468:            HT_FREE(access);
2.37      frystyk   469:            return NO;
                    470:        }
2.49      frystyk   471:        HT_FREE(access);
2.37      frystyk   472:     }
2.59      frystyk   473: 
                    474:     /* Find a transport object for this protocol */
                    475:     tp = HTTransport_find(request, HTProtocol_transport(protocol));
                    476:     if (tp == NULL) {
2.60      frystyk   477:        if (CORE_TRACE) HTTrace("HTNet....... NO TRANSPORT OBJECT\n");
2.59      frystyk   478:        return NO;
                    479:     }
                    480: 
2.23      frystyk   481:     /* Create new net object and bind it to the request object */
2.36      frystyk   482:     if ((me = create_object(request)) == NULL) return NO;
2.45      frystyk   483:     me->preemptive = (HTProtocol_preemptive(protocol) || request->preemptive);
2.30      frystyk   484:     me->priority = request->priority;
2.23      frystyk   485:     me->sockfd = INVSOC;
2.59      frystyk   486:     me->protocol = protocol;
                    487:     me->transport = tp;
2.37      frystyk   488:     if (!(me->cbf = HTProtocol_client(protocol))) {
2.58      hallam    489:        if (CORE_TRACE) HTTrace("HTNet_new... NO CALL BACK FUNCTION!\n");
2.49      frystyk   490:        HT_FREE(me);
2.23      frystyk   491:        return NO;
                    492:     }
2.25      frystyk   493:     request->retrys++;
2.23      frystyk   494: 
                    495:     /*
                    496:     ** Check if we can start the request, else put it into pending queue
                    497:     ** If so then call the call back function associated with the anchor.
                    498:     ** We use the INVSOC as we don't have a valid socket yet!
                    499:     */
                    500:     if (HTList_count(HTNetActive) < HTMaxActive) {
                    501:        HTList_addObject(HTNetActive, (void *) me);
2.58      hallam    502:        if (CORE_TRACE)
2.50      eric      503:            HTTrace("HTNet_new... starting request %p (retry=%d) with net object %p\n",
2.43      frystyk   504:                    request, request->retrys, me);
2.25      frystyk   505:        (*(me->cbf))(me->sockfd, request, FD_NONE);
2.23      frystyk   506:     } else {
2.35      frystyk   507:        HTAlertCallback *cbf = HTAlert_find(HT_PROG_WAIT);
2.23      frystyk   508:        if (!HTNetPending) HTNetPending = HTList_new();
2.58      hallam    509:        if (CORE_TRACE)
2.50      eric      510:            HTTrace("HTNet_new... request %p registered as pending\n",
2.25      frystyk   511:                    request);
2.35      frystyk   512:        if (cbf) (*cbf)(request, HT_PROG_WAIT, HT_MSG_NULL, NULL, NULL, NULL);
2.25      frystyk   513:        HTList_addObject(HTNetPending, (void *) me);    
2.23      frystyk   514:     }
2.36      frystyk   515:     return YES;
                    516: }
                    517: 
2.23      frystyk   518: /*     delete_object
                    519: **     -------------
                    520: **     Deletes an HTNet object
2.40      frystyk   521: **     Return YES if OK, else NO
2.15      frystyk   522: */
2.23      frystyk   523: PRIVATE BOOL delete_object (HTNet *net, int status)
2.15      frystyk   524: {
2.58      hallam    525:     if (CORE_TRACE)
2.50      eric      526:        HTTrace("HTNet_delete Remove net object %p\n", net);
2.23      frystyk   527:     if (net) {
                    528: 
                    529:        /* Free stream with data FROM network to application */
2.59      frystyk   530: #if 0
2.23      frystyk   531:        if (net->target) {
                    532:            if (status == HT_INTERRUPTED)
                    533:                (*net->target->isa->abort)(net->target, NULL);
                    534:            else
                    535:                (*net->target->isa->_free)(net->target);
2.48      frystyk   536:            net->target = NULL;
2.23      frystyk   537:        }
2.59      frystyk   538: #endif
2.23      frystyk   539: 
                    540:        /* Close socket */
                    541:        if (net->sockfd != INVSOC) {
2.45      frystyk   542:            HTEvent_UnRegister(net->sockfd, (SockOps) FD_ALL);
2.59      frystyk   543:            HTChannel_downSemaphore(net->channel);
                    544:            if (HTHost_channel(net->host) == NULL) {
                    545:                HTChannel_delete(net->channel);
                    546:                if (CORE_TRACE)
                    547:                    HTTrace("HTNet_delete closing %d\n", net->sockfd);
2.24      frystyk   548:            } else {
2.59      frystyk   549:                if (CORE_TRACE)
                    550:                    HTTrace("HTNet_delete keeping %d\n", net->sockfd);
2.25      frystyk   551:                /* Here we should probably use a low priority */
                    552:                HTEvent_Register(net->sockfd, net->request, (SockOps) FD_READ,
2.59      frystyk   553:                                 HTHost_catchClose, net->priority);
2.24      frystyk   554:            }
2.23      frystyk   555:        }
                    556:        if (net->request)
                    557:            net->request->net = NULL;               /* Break link to request */
2.49      frystyk   558:        HT_FREE(net);
2.23      frystyk   559:        return status ? NO : YES;
                    560:     }
                    561:     return NO;
                    562: }
                    563: 
                    564: /*     HTNet_delete
                    565: **     ------------
                    566: **     Deletes the HTNet object from the list of active requests and calls
                    567: **     any registered call back functions IF not the status is HT_IGNORE.
                    568: **     This is used if we have internal requests that the app doesn't know
                    569: **     about. We also see if we have pending requests that can be started
                    570: **     up now when we have a socket free.
                    571: **     The callback functions are called in the reverse order of which they
                    572: **     were registered (last one first)
2.40      frystyk   573: **     Return YES if OK, else NO
2.23      frystyk   574: */
                    575: PUBLIC BOOL HTNet_delete (HTNet * net, int status)
                    576: {
2.58      hallam    577:     if (CORE_TRACE) 
2.50      eric      578:        HTTrace("HTNetDelete. Object and call callback functions\n");
2.23      frystyk   579:     if (HTNetActive && net) {
2.36      frystyk   580:        SOCKET cs = net->sockfd;                           /* Current sockfd */
2.23      frystyk   581: 
                    582:        /* Remove object and call callback functions */
                    583:        HTRequest *request = net->request;
2.42      frystyk   584:        if (HTList_removeObject(HTNetActive, (void *) net) != YES)
2.58      hallam    585:            if (CORE_TRACE)
2.50      eric      586:                HTTrace("HTNetDelete. %p not registered!\n", net);
2.23      frystyk   587:        delete_object(net, status);
2.61    ! eric      588:        HTNet_callAfter(request, status);
2.23      frystyk   589: 
2.25      frystyk   590:        /*
                    591:        ** See first if we have a persistent request queued up for this socket
                    592:        ** If not then see if there is a pending request
                    593:        */
                    594:        if (HTNetPersistent) {
                    595:            HTList *cur = HTNetPersistent;
                    596:            HTNet *next;
                    597:            while ((next = (HTNet *) HTList_nextObject(cur))) {
                    598:                if (next->sockfd == cs) {
2.58      hallam    599:                    if (CORE_TRACE)
2.50      eric      600:                        HTTrace("HTNet delete Launch request %p on WARM socket %d (net object %p)\n",
2.39      frystyk   601:                                 next->request, next->sockfd, next);
2.28      frystyk   602:                    HTList_addObject(HTNetActive, (void *) next);
                    603:                    HTList_removeObject(HTNetPersistent, (void *) next);
2.41      frystyk   604:                    (*(next->cbf))(next->sockfd, next->request, FD_WRITE);
2.25      frystyk   605:                    break;
                    606:                }
                    607:            }
                    608:        } else if (HTList_count(HTNetActive) < HTMaxActive &&
                    609:                   HTList_count(HTNetPending)) {
2.23      frystyk   610:            HTNet *next = (HTNet *) HTList_removeFirstObject(HTNetPending);
                    611:            if (next) {
                    612:                HTList_addObject(HTNetActive, (void *) next);
2.58      hallam    613:                if (CORE_TRACE)
2.50      eric      614:                    HTTrace("HTNet delete launch PENDING request %p\n",
2.23      frystyk   615:                            next->request);
                    616:                (*(next->cbf))(INVSOC, next->request, FD_NONE);
                    617:            }
                    618:        }
                    619:        return YES;
                    620:     }
                    621:     return NO;
                    622: }
                    623: 
                    624: /*     HTNet_deleteAll
                    625: **     ---------------
                    626: **     Deletes all HTNet object that might either be active or pending
2.25      frystyk   627: **     We DO NOT call the call back functions - A crude way of saying goodbye!
2.23      frystyk   628: */
                    629: PUBLIC BOOL HTNet_deleteAll (void)
                    630: {
2.58      hallam    631:     if (CORE_TRACE) 
2.50      eric      632:        HTTrace("HTNetDelete. Remove all Net objects, NO callback\n"); 
2.25      frystyk   633:     if (HTNetPersistent) {
                    634:        HTList *cur = HTNetPersistent;
                    635:        HTNet *pres;
                    636:        while ((pres = (HTNet *) HTList_nextObject(cur))) {
                    637:            pres->sockfd = INVSOC;          /* Don't close it more than once */
                    638:            delete_object(pres, HT_INTERRUPTED);
                    639:        }
                    640:        HTList_delete(HTNetPersistent);
                    641:        HTNetPersistent = NULL;
                    642:     }
2.23      frystyk   643:     if (HTNetPending) {
                    644:        HTList *cur = HTNetPending;
                    645:        HTNet *pres;
                    646:        while ((pres = (HTNet *) HTList_nextObject(cur)))
                    647:            delete_object(pres, HT_INTERRUPTED);
                    648:        HTList_delete(HTNetPending);
                    649:        HTNetPending = NULL;
                    650:     }
                    651:     if (HTNetActive) {
                    652:        HTList *cur = HTNetActive;
                    653:        HTNet *pres;
                    654:        while ((pres = (HTNet *) HTList_nextObject(cur)))
                    655:            delete_object(pres, HT_INTERRUPTED);
                    656:        HTList_delete(HTNetActive);
                    657:        HTNetActive = NULL;
                    658:     }
                    659:     return NO;
2.15      frystyk   660: }
                    661: 
2.25      frystyk   662: /*     HTNet_wait
                    663: **     ----------
                    664: **     Let a net object wait for a persistent socket. It will be launched
                    665: **     from the HTNet_delete() function
2.40      frystyk   666: **     Return YES if OK, else NO
2.25      frystyk   667: */
                    668: PUBLIC BOOL HTNet_wait (HTNet *net)
                    669: {
                    670:     if (net) {
2.58      hallam    671:        if (CORE_TRACE)
2.50      eric      672:            HTTrace("HTNet_wait.. request %p is waiting for presistent socket %d\n",
2.40      frystyk   673:                     net->request, net->sockfd);
                    674: 
                    675:        /* Take it out of the active queue and add it to persistent queue */
                    676:        if (HTList_removeObject(HTNetActive, (void *) net) != YES) {
2.58      hallam    677:            if (CORE_TRACE) HTTrace("HTNet_wait.. not registered!\n");
2.40      frystyk   678:            return NO;
                    679:        }
2.25      frystyk   680:        if (!HTNetPersistent) HTNetPersistent = HTList_new();
2.40      frystyk   681:        return HTList_addObject(HTNetPersistent, (void *) net); 
2.25      frystyk   682:     }
                    683:     return NO;
                    684: }
                    685: 
2.23      frystyk   686: /* ------------------------------------------------------------------------- */
                    687: /*                             Killing requests                             */
                    688: /* ------------------------------------------------------------------------- */
                    689: 
                    690: /*     HTNet_kill
                    691: **     ----------
                    692: **     Kill the request by calling the call back function with a request for 
                    693: **     closing the connection. Does not remove the object. This is done by
                    694: **     HTNet_delete() function which is called by the load routine.
                    695: **     Returns OK if success, NO on error
                    696: */
                    697: PUBLIC BOOL HTNet_kill (HTNet * me)
                    698: {
                    699:     if (HTNetActive && me) {
2.25      frystyk   700:        HTList *cur = HTNetActive;
2.23      frystyk   701:        HTNet *pres;
2.25      frystyk   702:        while ((pres = (HTNet *) HTList_nextObject(cur))) {
2.23      frystyk   703:            if (pres == me) {
2.25      frystyk   704:                (*(pres->cbf))(pres->sockfd, pres->request, FD_CLOSE);
2.23      frystyk   705:                return YES;
                    706:            }
                    707:        }
                    708:     }
2.58      hallam    709:     if (CORE_TRACE)
2.50      eric      710:        HTTrace("HTNet_kill.. object %p is not registered\n", me);
2.23      frystyk   711:     return NO;
                    712: }
                    713: 
                    714: /*     HTNet_killAll
                    715: **     -------------
                    716: **     Kills all registered (active+pending) requests by calling the call
                    717: **     back function with a request for closing the connection. We do not
                    718: **     remove the HTNet object as it is done by HTNet_delete().
                    719: **     Returns OK if success, NO on error
                    720: */
                    721: PUBLIC BOOL HTNet_killAll (void)
                    722: {
                    723:     HTNet *pres;
2.58      hallam    724:     if (CORE_TRACE)
2.50      eric      725:        HTTrace("HTNet_kill.. ALL registered requests!!!\n");
2.23      frystyk   726: 
2.25      frystyk   727:     /* We start off in persistent queue so we avoid racing */
                    728:     if (HTNetPersistent) {
                    729:        while ((pres = (HTNet *) HTList_lastObject(HTNetPersistent)) != NULL) {
                    730:            pres->sockfd = INVSOC;
                    731:            (*(pres->cbf))(pres->sockfd, pres->request, FD_CLOSE);
                    732:            HTList_removeObject(HTNetPersistent, pres);
                    733:        }
                    734:     }
2.23      frystyk   735:     if (HTNetPending) {
                    736:        while ((pres = (HTNet *) HTList_lastObject(HTNetPending)) != NULL) {
2.25      frystyk   737:            (*(pres->cbf))(pres->sockfd, pres->request, FD_CLOSE);
2.23      frystyk   738:            HTList_removeObject(HTNetPending, pres);
                    739:        }
                    740:     }
                    741:     if (HTNetActive) {
                    742:        while ((pres = (HTNet *) HTList_lastObject(HTNetActive)) != NULL)
2.25      frystyk   743:            (*(pres->cbf))(pres->sockfd, pres->request, FD_CLOSE);
2.23      frystyk   744:     }
                    745:     return YES;
                    746: }
2.38      frystyk   747: 
                    748: /* ------------------------------------------------------------------------- */
2.59      frystyk   749: /*                         Connection Specifics                             */
                    750: /* ------------------------------------------------------------------------- */
                    751: 
                    752: /*     HTNet_Persistent
                    753: **     ----------------
                    754: **     Check whether the net object handles persistent connections
                    755: **     If we have a DNS entry then check that as well.
                    756: */
                    757: PUBLIC BOOL HTNet_persistent (HTNet * net)
                    758: {
                    759:     return (net && HTHost_isPersistent(net->host));
                    760: }
                    761: 
                    762: /*     HTNet_persistent
                    763: **     ----------------
                    764: **     Set the net object to handle persistent connections
                    765: **     If we also have a DNS entry then update that as well
                    766: */
                    767: PUBLIC BOOL HTNet_setPersistent (HTNet * net, BOOL persistent)
                    768: {
                    769:     if (net) {
2.60      frystyk   770:        if (CORE_TRACE) HTTrace("Net......... Persistent connection set %s\n",
2.59      frystyk   771:                                persistent ? "ON" : "OFF");
                    772:        if (persistent)
                    773:            HTHost_setChannel(net->host, net->channel);
                    774:        else
                    775:            HTHost_clearChannel(net->host);
                    776:     }
                    777:     return NO;
                    778: }
                    779: 
                    780: /* ------------------------------------------------------------------------- */
2.38      frystyk   781: /*                           Data Access Methods                            */
                    782: /* ------------------------------------------------------------------------- */
                    783: 
                    784: /*
2.60      frystyk   785: **  Get and set the socket number
                    786: */
                    787: PUBLIC BOOL HTNet_setSocket (HTNet * net, SOCKET sockfd)
                    788: {
                    789:     if (net) {
                    790:        net->sockfd = sockfd;
                    791:        return YES;
                    792:     }
                    793:     return NO;
                    794: }
                    795: 
                    796: PUBLIC SOCKET HTNet_socket (HTNet * net)
                    797: {
                    798:     return (net ? net->sockfd : INVSOC);
                    799: }
                    800: 
                    801: /*
2.59      frystyk   802: **  Get and set the HTTransport object
2.38      frystyk   803: */
2.59      frystyk   804: PUBLIC BOOL HTNet_setTransport (HTNet * net, HTTransport * tp)
2.38      frystyk   805: {
2.59      frystyk   806:     if (net && tp) {
                    807:        net->transport = tp;
2.38      frystyk   808:        return YES;
                    809:     }
                    810:     return NO;
                    811: }
                    812: 
2.59      frystyk   813: PUBLIC HTTransport * HTNet_transport (HTNet * net)
2.38      frystyk   814: {
2.59      frystyk   815:     return (net ? net->transport : NULL);
2.38      frystyk   816: }
                    817: 
2.55      frystyk   818: /*
2.59      frystyk   819: **  Get and set the HTChannel object
2.55      frystyk   820: */
2.59      frystyk   821: PUBLIC BOOL HTNet_setChannel (HTNet * net, HTChannel * channel)
2.55      frystyk   822: {
2.59      frystyk   823:     if (net && channel) {
                    824:        net->channel = channel;
2.55      frystyk   825:        return YES;
                    826:     }
                    827:     return NO;
                    828: }
                    829: 
2.59      frystyk   830: PUBLIC HTChannel * HTNet_channel (HTNet * net)
2.55      frystyk   831: {
2.59      frystyk   832:     return (net ? net->channel : NULL);
                    833: }
                    834: 
                    835: /*
                    836: **  Get and set the HTHost object
                    837: */
                    838: PUBLIC BOOL HTNet_setHost (HTNet * net, HTHost * host)
                    839: {
                    840:     if (net && host) {
                    841:        net->host = host;
                    842:        return YES;
                    843:     }
                    844:     return NO;
                    845: }
                    846: 
                    847: PUBLIC HTHost * HTNet_host (HTNet * net)
                    848: {
                    849:     return (net ? net->host : NULL);
                    850: }
                    851: 
                    852: /*
                    853: **  Get and set the HTdns object
                    854: */
                    855: PUBLIC BOOL HTNet_setDns (HTNet * net, HTdns * dns)
                    856: {
                    857:     if (net && dns) {
                    858:        net->dns = dns;
                    859:        return YES;
                    860:     }
                    861:     return NO;
                    862: }
                    863: 
                    864: PUBLIC HTdns * HTNet_dns (HTNet * net)
                    865: {
                    866:     return (net ? net->dns : NULL);
                    867: }
                    868: 
                    869: 
                    870: /*
                    871: **     Create the input stream and bind it to the channel
                    872: **     Please read the description in the HTIOStream module for the parameters
                    873: */
                    874: PUBLIC HTInputStream * HTNet_getInput (HTNet * net, HTStream * target,
                    875:                                       void * param, int mode)
                    876: {
                    877:     if (net && net->channel && net->transport) {
                    878:        HTTransport * tp = net->transport;
                    879:        HTChannel * ch = net->channel;
                    880:        net->input = (*tp->input_new)(net, ch, target, param, mode);
                    881:        HTChannel_setInput(ch, net->input, tp->mode);
                    882:        return net->input;
                    883:     }
2.60      frystyk   884:     if (CORE_TRACE) HTTrace("Net......... Can't create input stream\n");
2.59      frystyk   885:     return NULL;
                    886: }
                    887: 
                    888: /*
                    889: **     Create the output stream and bind it to the channel
                    890: **     Please read the description in the HTIOStream module on the parameters
                    891: */
                    892: PUBLIC HTOutputStream * HTNet_getOutput (HTNet * net, void * param, int mode)
                    893: {
                    894:     if (net && net->request && net->channel && net->transport) {
                    895:        HTTransport * tp = net->transport;
                    896:        HTChannel * ch = net->channel;
                    897:        HTOutputStream * output = (*tp->output_new)(net, ch, param, mode);
                    898:        HTChannel_setOutput(ch, output, tp->mode);
                    899:        return output;
                    900:     }
2.60      frystyk   901:     if (CORE_TRACE) HTTrace("Net......... Can't create output stream\n");
2.59      frystyk   902:     return NULL;
2.55      frystyk   903: }

Webmaster