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

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.68    ! eric        6: **     @(#) $Id: HTNet.c,v 2.67 1996/06/01 17:46:52 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.65      frystyk    28: #include "HTEvent.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: 
2.67      frystyk   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
2.37      frystyk   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;
2.67      frystyk   392:     HTTransport * tp = NULL;           /* added JTD:5/28/96 */
2.37      frystyk   393:     if (!request) return NO;
                    394: 
                    395:     /* Check if we can start the request, else return immediately */
                    396:     if (HTList_count(HTNetActive) > HTMaxActive) {
2.67      frystyk   397:         if (CORE_TRACE) HTTrace("HTNet new... NO SOCKET AVAILABLE\n");
                    398:         HTNet_callAfter(request, HT_RETRY);
                    399:         return YES;
2.37      frystyk   400:     }
                    401: 
                    402:     /* Find a protocol object for this access scheme */
2.46      frystyk   403:     protocol = HTProtocol_find(request, access);
2.67      frystyk   404: 
                    405:     /* added - JTD:5/28/96 */
                    406:     /* Find a transport object for this protocol */
                    407:     tp = HTTransport_find(request, HTProtocol_transport(protocol));
                    408:     if (tp == NULL) {
                    409:         if (CORE_TRACE) HTTrace("HTNet....... NO TRANSPORT OBJECT\n");
                    410:         return NO;
                    411:     }
                    412:     /* end of additions - JTD:5/28/96 */
                    413: 
2.37      frystyk   414:     /* Create new net object and bind it to the request object */
                    415:     if ((me = create_object(request)) == NULL) return NO;
2.45      frystyk   416:     me->preemptive = (HTProtocol_preemptive(protocol) || request->preemptive);
2.59      frystyk   417:     me->protocol = protocol;
2.67      frystyk   418:     me->transport = tp;                /* added - JTD:5/28/96 */
2.37      frystyk   419:     me->priority = request->priority;
2.38      frystyk   420:     me->sockfd = sockfd;
2.37      frystyk   421:     if (!(me->cbf = HTProtocol_server(protocol))) {
2.67      frystyk   422:         if (CORE_TRACE) HTTrace("HTNet_new... NO CALL BACK FUNCTION!\n");
                    423:         HT_FREE(me);
                    424:         return NO;
2.37      frystyk   425:     }
                    426:     request->retrys++;
                    427: 
                    428:     /* Start the server request */
                    429:     HTList_addObject(HTNetActive, (void *) me);
2.58      hallam    430:     if (CORE_TRACE)
2.67      frystyk   431:         HTTrace("HTNet_new... starting SERVER request %p with net object %p\n", request, me);
2.37      frystyk   432:     (*(me->cbf))(me->sockfd, request, FD_NONE);
                    433:     return YES;
                    434: }
2.36      frystyk   435: 
2.30      frystyk   436: /*     HTNet_new
                    437: **     ---------
2.23      frystyk   438: **     Create a new HTNet object as a new request to be handled. If we have
                    439: **     more than HTMaxActive connections already then put this into the
                    440: **     pending queue, else start the request by calling the call back
                    441: **     function registered with this access method. 
                    442: **     Returns YES if OK, else NO
                    443: */
2.37      frystyk   444: PUBLIC BOOL HTNet_newClient (HTRequest * request)
2.23      frystyk   445: {
2.33      frystyk   446:     int status;
2.59      frystyk   447:     HTNet * me = NULL;
                    448:     HTProtocol * protocol = NULL;
                    449:     HTTransport * tp = NULL;
2.37      frystyk   450:     char * physical = NULL;
2.27      frystyk   451:     if (!request) return NO;
2.33      frystyk   452:     /*
                    453:     ** First we do all the "BEFORE" callbacks in order to see if we are to
                    454:     ** continue with this request or not. If we receive a callback status
                    455:     ** that is NOT HT_OK then jump directly to the after callbacks and return
                    456:     */
2.58      hallam    457:     if ((status = HTNet_callBefore(request, HT_OK)) != HT_OK) {
                    458:        HTNet_callAfter(request, status);
2.33      frystyk   459:        return YES;
                    460:     }
                    461: 
2.36      frystyk   462:     /*
                    463:     ** If no translation was provided by the application then use the anchor
                    464:     ** address directly
                    465:     */
2.33      frystyk   466:     if (!(physical = HTAnchor_physical(request->anchor)) || !*physical) {
2.36      frystyk   467:        char * addr = HTAnchor_address((HTAnchor *) request->anchor);
2.58      hallam    468:        if (CORE_TRACE) HTTrace("HTNet New... Using default address\n");
2.36      frystyk   469:        HTAnchor_setPhysical(request->anchor, addr);
2.37      frystyk   470:        physical = HTAnchor_physical(request->anchor);
2.49      frystyk   471:        HT_FREE(addr);
2.33      frystyk   472:     }
                    473: 
2.37      frystyk   474:     /* Find a protocol object for this access scheme */
                    475:     {
                    476:        char * access = HTParse(physical, "", PARSE_ACCESS);
                    477:        if ((protocol = HTProtocol_find(request, access)) == NULL) {
2.58      hallam    478:            if (CORE_TRACE) HTTrace("HTNet_new... NO PROTOCOL OBJECT\n");
2.49      frystyk   479:            HT_FREE(access);
2.37      frystyk   480:            return NO;
                    481:        }
2.49      frystyk   482:        HT_FREE(access);
2.37      frystyk   483:     }
2.59      frystyk   484: 
                    485:     /* Find a transport object for this protocol */
                    486:     tp = HTTransport_find(request, HTProtocol_transport(protocol));
                    487:     if (tp == NULL) {
2.60      frystyk   488:        if (CORE_TRACE) HTTrace("HTNet....... NO TRANSPORT OBJECT\n");
2.59      frystyk   489:        return NO;
                    490:     }
                    491: 
2.23      frystyk   492:     /* Create new net object and bind it to the request object */
2.36      frystyk   493:     if ((me = create_object(request)) == NULL) return NO;
2.45      frystyk   494:     me->preemptive = (HTProtocol_preemptive(protocol) || request->preemptive);
2.30      frystyk   495:     me->priority = request->priority;
2.23      frystyk   496:     me->sockfd = INVSOC;
2.59      frystyk   497:     me->protocol = protocol;
                    498:     me->transport = tp;
2.37      frystyk   499:     if (!(me->cbf = HTProtocol_client(protocol))) {
2.58      hallam    500:        if (CORE_TRACE) HTTrace("HTNet_new... NO CALL BACK FUNCTION!\n");
2.49      frystyk   501:        HT_FREE(me);
2.23      frystyk   502:        return NO;
                    503:     }
2.25      frystyk   504:     request->retrys++;
2.23      frystyk   505: 
                    506:     /*
                    507:     ** Check if we can start the request, else put it into pending queue
                    508:     ** If so then call the call back function associated with the anchor.
                    509:     ** We use the INVSOC as we don't have a valid socket yet!
                    510:     */
                    511:     if (HTList_count(HTNetActive) < HTMaxActive) {
                    512:        HTList_addObject(HTNetActive, (void *) me);
2.58      hallam    513:        if (CORE_TRACE)
2.50      eric      514:            HTTrace("HTNet_new... starting request %p (retry=%d) with net object %p\n",
2.43      frystyk   515:                    request, request->retrys, me);
2.25      frystyk   516:        (*(me->cbf))(me->sockfd, request, FD_NONE);
2.23      frystyk   517:     } else {
2.35      frystyk   518:        HTAlertCallback *cbf = HTAlert_find(HT_PROG_WAIT);
2.23      frystyk   519:        if (!HTNetPending) HTNetPending = HTList_new();
2.58      hallam    520:        if (CORE_TRACE)
2.50      eric      521:            HTTrace("HTNet_new... request %p registered as pending\n",
2.25      frystyk   522:                    request);
2.35      frystyk   523:        if (cbf) (*cbf)(request, HT_PROG_WAIT, HT_MSG_NULL, NULL, NULL, NULL);
2.25      frystyk   524:        HTList_addObject(HTNetPending, (void *) me);    
2.23      frystyk   525:     }
2.36      frystyk   526:     return YES;
                    527: }
                    528: 
2.23      frystyk   529: /*     delete_object
                    530: **     -------------
                    531: **     Deletes an HTNet object
2.40      frystyk   532: **     Return YES if OK, else NO
2.15      frystyk   533: */
2.23      frystyk   534: PRIVATE BOOL delete_object (HTNet *net, int status)
2.15      frystyk   535: {
2.58      hallam    536:     if (CORE_TRACE)
2.50      eric      537:        HTTrace("HTNet_delete Remove net object %p\n", net);
2.23      frystyk   538:     if (net) {
                    539: 
                    540:        /* Free stream with data FROM network to application */
2.59      frystyk   541: #if 0
2.23      frystyk   542:        if (net->target) {
                    543:            if (status == HT_INTERRUPTED)
                    544:                (*net->target->isa->abort)(net->target, NULL);
                    545:            else
                    546:                (*net->target->isa->_free)(net->target);
2.48      frystyk   547:            net->target = NULL;
2.23      frystyk   548:        }
2.59      frystyk   549: #endif
2.23      frystyk   550: 
                    551:        /* Close socket */
2.62      eric      552:        if (net->channel) {
2.64      eric      553:            HTEvent_unregister(net->sockfd, (SockOps) FD_ALL);
2.68    ! eric      554:            HTChannel_delete(net->channel, status);
2.59      frystyk   555:            if (HTHost_channel(net->host) == NULL) {
                    556:                if (CORE_TRACE)
                    557:                    HTTrace("HTNet_delete closing %d\n", net->sockfd);
2.24      frystyk   558:            } else {
2.59      frystyk   559:                if (CORE_TRACE)
                    560:                    HTTrace("HTNet_delete keeping %d\n", net->sockfd);
2.25      frystyk   561:                /* Here we should probably use a low priority */
2.64      eric      562:                HTEvent_register(net->sockfd, 0, (SockOps) FD_READ,
2.59      frystyk   563:                                 HTHost_catchClose, net->priority);
2.24      frystyk   564:            }
2.62      eric      565:            HTChannel_downSemaphore(net->channel);
2.63      eric      566:            net->channel = NULL;
2.23      frystyk   567:        }
                    568:        if (net->request)
                    569:            net->request->net = NULL;               /* Break link to request */
2.49      frystyk   570:        HT_FREE(net);
2.23      frystyk   571:        return status ? NO : YES;
                    572:     }
                    573:     return NO;
                    574: }
                    575: 
                    576: /*     HTNet_delete
                    577: **     ------------
                    578: **     Deletes the HTNet object from the list of active requests and calls
                    579: **     any registered call back functions IF not the status is HT_IGNORE.
                    580: **     This is used if we have internal requests that the app doesn't know
                    581: **     about. We also see if we have pending requests that can be started
                    582: **     up now when we have a socket free.
                    583: **     The callback functions are called in the reverse order of which they
                    584: **     were registered (last one first)
2.40      frystyk   585: **     Return YES if OK, else NO
2.23      frystyk   586: */
                    587: PUBLIC BOOL HTNet_delete (HTNet * net, int status)
                    588: {
2.58      hallam    589:     if (CORE_TRACE) 
2.50      eric      590:        HTTrace("HTNetDelete. Object and call callback functions\n");
2.23      frystyk   591:     if (HTNetActive && net) {
2.36      frystyk   592:        SOCKET cs = net->sockfd;                           /* Current sockfd */
2.23      frystyk   593: 
                    594:        /* Remove object and call callback functions */
                    595:        HTRequest *request = net->request;
2.42      frystyk   596:        if (HTList_removeObject(HTNetActive, (void *) net) != YES)
2.58      hallam    597:            if (CORE_TRACE)
2.50      eric      598:                HTTrace("HTNetDelete. %p not registered!\n", net);
2.23      frystyk   599:        delete_object(net, status);
2.61      eric      600:        HTNet_callAfter(request, status);
2.23      frystyk   601: 
2.25      frystyk   602:        /*
                    603:        ** See first if we have a persistent request queued up for this socket
                    604:        ** If not then see if there is a pending request
                    605:        */
                    606:        if (HTNetPersistent) {
                    607:            HTList *cur = HTNetPersistent;
                    608:            HTNet *next;
                    609:            while ((next = (HTNet *) HTList_nextObject(cur))) {
                    610:                if (next->sockfd == cs) {
2.58      hallam    611:                    if (CORE_TRACE)
2.50      eric      612:                        HTTrace("HTNet delete Launch request %p on WARM socket %d (net object %p)\n",
2.39      frystyk   613:                                 next->request, next->sockfd, next);
2.28      frystyk   614:                    HTList_addObject(HTNetActive, (void *) next);
                    615:                    HTList_removeObject(HTNetPersistent, (void *) next);
2.41      frystyk   616:                    (*(next->cbf))(next->sockfd, next->request, FD_WRITE);
2.25      frystyk   617:                    break;
                    618:                }
                    619:            }
                    620:        } else if (HTList_count(HTNetActive) < HTMaxActive &&
                    621:                   HTList_count(HTNetPending)) {
2.23      frystyk   622:            HTNet *next = (HTNet *) HTList_removeFirstObject(HTNetPending);
                    623:            if (next) {
                    624:                HTList_addObject(HTNetActive, (void *) next);
2.58      hallam    625:                if (CORE_TRACE)
2.50      eric      626:                    HTTrace("HTNet delete launch PENDING request %p\n",
2.23      frystyk   627:                            next->request);
                    628:                (*(next->cbf))(INVSOC, next->request, FD_NONE);
                    629:            }
                    630:        }
                    631:        return YES;
                    632:     }
                    633:     return NO;
                    634: }
                    635: 
                    636: /*     HTNet_deleteAll
                    637: **     ---------------
                    638: **     Deletes all HTNet object that might either be active or pending
2.25      frystyk   639: **     We DO NOT call the call back functions - A crude way of saying goodbye!
2.23      frystyk   640: */
                    641: PUBLIC BOOL HTNet_deleteAll (void)
                    642: {
2.58      hallam    643:     if (CORE_TRACE) 
2.50      eric      644:        HTTrace("HTNetDelete. Remove all Net objects, NO callback\n"); 
2.25      frystyk   645:     if (HTNetPersistent) {
                    646:        HTList *cur = HTNetPersistent;
                    647:        HTNet *pres;
                    648:        while ((pres = (HTNet *) HTList_nextObject(cur))) {
                    649:            pres->sockfd = INVSOC;          /* Don't close it more than once */
                    650:            delete_object(pres, HT_INTERRUPTED);
                    651:        }
                    652:        HTList_delete(HTNetPersistent);
                    653:        HTNetPersistent = NULL;
                    654:     }
2.23      frystyk   655:     if (HTNetPending) {
                    656:        HTList *cur = HTNetPending;
                    657:        HTNet *pres;
                    658:        while ((pres = (HTNet *) HTList_nextObject(cur)))
                    659:            delete_object(pres, HT_INTERRUPTED);
                    660:        HTList_delete(HTNetPending);
                    661:        HTNetPending = NULL;
                    662:     }
                    663:     if (HTNetActive) {
                    664:        HTList *cur = HTNetActive;
                    665:        HTNet *pres;
                    666:        while ((pres = (HTNet *) HTList_nextObject(cur)))
                    667:            delete_object(pres, HT_INTERRUPTED);
                    668:        HTList_delete(HTNetActive);
                    669:        HTNetActive = NULL;
                    670:     }
                    671:     return NO;
2.15      frystyk   672: }
                    673: 
2.25      frystyk   674: /*     HTNet_wait
                    675: **     ----------
                    676: **     Let a net object wait for a persistent socket. It will be launched
                    677: **     from the HTNet_delete() function
2.40      frystyk   678: **     Return YES if OK, else NO
2.25      frystyk   679: */
                    680: PUBLIC BOOL HTNet_wait (HTNet *net)
                    681: {
                    682:     if (net) {
2.58      hallam    683:        if (CORE_TRACE)
2.50      eric      684:            HTTrace("HTNet_wait.. request %p is waiting for presistent socket %d\n",
2.40      frystyk   685:                     net->request, net->sockfd);
                    686: 
                    687:        /* Take it out of the active queue and add it to persistent queue */
                    688:        if (HTList_removeObject(HTNetActive, (void *) net) != YES) {
2.58      hallam    689:            if (CORE_TRACE) HTTrace("HTNet_wait.. not registered!\n");
2.40      frystyk   690:            return NO;
                    691:        }
2.25      frystyk   692:        if (!HTNetPersistent) HTNetPersistent = HTList_new();
2.40      frystyk   693:        return HTList_addObject(HTNetPersistent, (void *) net); 
2.25      frystyk   694:     }
                    695:     return NO;
                    696: }
                    697: 
2.23      frystyk   698: /* ------------------------------------------------------------------------- */
                    699: /*                             Killing requests                             */
                    700: /* ------------------------------------------------------------------------- */
                    701: 
                    702: /*     HTNet_kill
                    703: **     ----------
                    704: **     Kill the request by calling the call back function with a request for 
                    705: **     closing the connection. Does not remove the object. This is done by
                    706: **     HTNet_delete() function which is called by the load routine.
                    707: **     Returns OK if success, NO on error
                    708: */
                    709: PUBLIC BOOL HTNet_kill (HTNet * me)
                    710: {
                    711:     if (HTNetActive && me) {
2.25      frystyk   712:        HTList *cur = HTNetActive;
2.23      frystyk   713:        HTNet *pres;
2.25      frystyk   714:        while ((pres = (HTNet *) HTList_nextObject(cur))) {
2.23      frystyk   715:            if (pres == me) {
2.25      frystyk   716:                (*(pres->cbf))(pres->sockfd, pres->request, FD_CLOSE);
2.23      frystyk   717:                return YES;
                    718:            }
                    719:        }
                    720:     }
2.58      hallam    721:     if (CORE_TRACE)
2.50      eric      722:        HTTrace("HTNet_kill.. object %p is not registered\n", me);
2.23      frystyk   723:     return NO;
                    724: }
                    725: 
                    726: /*     HTNet_killAll
                    727: **     -------------
                    728: **     Kills all registered (active+pending) requests by calling the call
                    729: **     back function with a request for closing the connection. We do not
                    730: **     remove the HTNet object as it is done by HTNet_delete().
                    731: **     Returns OK if success, NO on error
                    732: */
                    733: PUBLIC BOOL HTNet_killAll (void)
                    734: {
                    735:     HTNet *pres;
2.58      hallam    736:     if (CORE_TRACE)
2.50      eric      737:        HTTrace("HTNet_kill.. ALL registered requests!!!\n");
2.23      frystyk   738: 
2.25      frystyk   739:     /* We start off in persistent queue so we avoid racing */
                    740:     if (HTNetPersistent) {
                    741:        while ((pres = (HTNet *) HTList_lastObject(HTNetPersistent)) != NULL) {
                    742:            pres->sockfd = INVSOC;
                    743:            (*(pres->cbf))(pres->sockfd, pres->request, FD_CLOSE);
                    744:            HTList_removeObject(HTNetPersistent, pres);
                    745:        }
                    746:     }
2.23      frystyk   747:     if (HTNetPending) {
                    748:        while ((pres = (HTNet *) HTList_lastObject(HTNetPending)) != NULL) {
2.25      frystyk   749:            (*(pres->cbf))(pres->sockfd, pres->request, FD_CLOSE);
2.23      frystyk   750:            HTList_removeObject(HTNetPending, pres);
                    751:        }
                    752:     }
                    753:     if (HTNetActive) {
                    754:        while ((pres = (HTNet *) HTList_lastObject(HTNetActive)) != NULL)
2.25      frystyk   755:            (*(pres->cbf))(pres->sockfd, pres->request, FD_CLOSE);
2.23      frystyk   756:     }
                    757:     return YES;
                    758: }
2.38      frystyk   759: 
                    760: /* ------------------------------------------------------------------------- */
2.59      frystyk   761: /*                         Connection Specifics                             */
                    762: /* ------------------------------------------------------------------------- */
                    763: 
                    764: /*     HTNet_Persistent
                    765: **     ----------------
                    766: **     Check whether the net object handles persistent connections
                    767: **     If we have a DNS entry then check that as well.
                    768: */
                    769: PUBLIC BOOL HTNet_persistent (HTNet * net)
                    770: {
                    771:     return (net && HTHost_isPersistent(net->host));
                    772: }
                    773: 
                    774: /*     HTNet_persistent
                    775: **     ----------------
                    776: **     Set the net object to handle persistent connections
                    777: **     If we also have a DNS entry then update that as well
                    778: */
                    779: PUBLIC BOOL HTNet_setPersistent (HTNet * net, BOOL persistent)
                    780: {
                    781:     if (net) {
2.60      frystyk   782:        if (CORE_TRACE) HTTrace("Net......... Persistent connection set %s\n",
2.59      frystyk   783:                                persistent ? "ON" : "OFF");
                    784:        if (persistent)
                    785:            HTHost_setChannel(net->host, net->channel);
                    786:        else
                    787:            HTHost_clearChannel(net->host);
                    788:     }
                    789:     return NO;
                    790: }
                    791: 
                    792: /* ------------------------------------------------------------------------- */
2.38      frystyk   793: /*                           Data Access Methods                            */
                    794: /* ------------------------------------------------------------------------- */
2.66      frystyk   795: 
                    796: /*
                    797: **     Context pointer to be used in context call back function
                    798: */
                    799: PUBLIC BOOL HTNet_setContext (HTNet * net, void * context)
                    800: {
                    801:     if (net) {
                    802:        net->context = context;
                    803:        return YES;
                    804:     }
                    805:     return NO;
                    806: }
                    807: 
                    808: PUBLIC void * HTNet_context (HTNet * net)
                    809: {
                    810:     return net ? net->context : NULL;
                    811: }
2.38      frystyk   812: 
                    813: /*
2.60      frystyk   814: **  Get and set the socket number
                    815: */
                    816: PUBLIC BOOL HTNet_setSocket (HTNet * net, SOCKET sockfd)
                    817: {
                    818:     if (net) {
                    819:        net->sockfd = sockfd;
                    820:        return YES;
                    821:     }
                    822:     return NO;
                    823: }
                    824: 
                    825: PUBLIC SOCKET HTNet_socket (HTNet * net)
                    826: {
                    827:     return (net ? net->sockfd : INVSOC);
                    828: }
                    829: 
                    830: /*
2.59      frystyk   831: **  Get and set the HTTransport object
2.38      frystyk   832: */
2.59      frystyk   833: PUBLIC BOOL HTNet_setTransport (HTNet * net, HTTransport * tp)
2.38      frystyk   834: {
2.59      frystyk   835:     if (net && tp) {
                    836:        net->transport = tp;
2.38      frystyk   837:        return YES;
                    838:     }
                    839:     return NO;
                    840: }
                    841: 
2.59      frystyk   842: PUBLIC HTTransport * HTNet_transport (HTNet * net)
2.38      frystyk   843: {
2.59      frystyk   844:     return (net ? net->transport : NULL);
2.38      frystyk   845: }
                    846: 
2.55      frystyk   847: /*
2.59      frystyk   848: **  Get and set the HTChannel object
2.55      frystyk   849: */
2.59      frystyk   850: PUBLIC BOOL HTNet_setChannel (HTNet * net, HTChannel * channel)
2.55      frystyk   851: {
2.59      frystyk   852:     if (net && channel) {
                    853:        net->channel = channel;
2.55      frystyk   854:        return YES;
                    855:     }
                    856:     return NO;
                    857: }
                    858: 
2.59      frystyk   859: PUBLIC HTChannel * HTNet_channel (HTNet * net)
2.55      frystyk   860: {
2.59      frystyk   861:     return (net ? net->channel : NULL);
                    862: }
                    863: 
                    864: /*
                    865: **  Get and set the HTHost object
                    866: */
                    867: PUBLIC BOOL HTNet_setHost (HTNet * net, HTHost * host)
                    868: {
                    869:     if (net && host) {
                    870:        net->host = host;
                    871:        return YES;
                    872:     }
                    873:     return NO;
                    874: }
                    875: 
                    876: PUBLIC HTHost * HTNet_host (HTNet * net)
                    877: {
                    878:     return (net ? net->host : NULL);
                    879: }
                    880: 
                    881: /*
                    882: **  Get and set the HTdns object
                    883: */
                    884: PUBLIC BOOL HTNet_setDns (HTNet * net, HTdns * dns)
                    885: {
                    886:     if (net && dns) {
                    887:        net->dns = dns;
                    888:        return YES;
                    889:     }
                    890:     return NO;
                    891: }
                    892: 
                    893: PUBLIC HTdns * HTNet_dns (HTNet * net)
                    894: {
                    895:     return (net ? net->dns : NULL);
                    896: }
                    897: 
                    898: 
                    899: /*
                    900: **     Create the input stream and bind it to the channel
                    901: **     Please read the description in the HTIOStream module for the parameters
                    902: */
                    903: PUBLIC HTInputStream * HTNet_getInput (HTNet * net, HTStream * target,
                    904:                                       void * param, int mode)
                    905: {
                    906:     if (net && net->channel && net->transport) {
                    907:        HTTransport * tp = net->transport;
                    908:        HTChannel * ch = net->channel;
                    909:        net->input = (*tp->input_new)(net, ch, target, param, mode);
                    910:        HTChannel_setInput(ch, net->input, tp->mode);
                    911:        return net->input;
                    912:     }
2.60      frystyk   913:     if (CORE_TRACE) HTTrace("Net......... Can't create input stream\n");
2.59      frystyk   914:     return NULL;
                    915: }
                    916: 
                    917: /*
                    918: **     Create the output stream and bind it to the channel
                    919: **     Please read the description in the HTIOStream module on the parameters
                    920: */
                    921: PUBLIC HTOutputStream * HTNet_getOutput (HTNet * net, void * param, int mode)
                    922: {
                    923:     if (net && net->request && net->channel && net->transport) {
                    924:        HTTransport * tp = net->transport;
                    925:        HTChannel * ch = net->channel;
                    926:        HTOutputStream * output = (*tp->output_new)(net, ch, param, mode);
                    927:        HTChannel_setOutput(ch, output, tp->mode);
                    928:        return output;
                    929:     }
2.60      frystyk   930:     if (CORE_TRACE) HTTrace("Net......... Can't create output stream\n");
2.59      frystyk   931:     return NULL;
2.55      frystyk   932: }

Webmaster