Annotation of libwww/Library/src/HTChannl.c, revision 2.12.2.5

2.1       frystyk     1: /*                                                                  HTChannl.c
                      2: **     CONTAINS STREAMS FOR READING AND WRITING TO AND FROM A TRANSPORT
                      3: **
                      4: **     (c) COPYRIGHT MIT 1995.
                      5: **     Please first read the full copyright statement in the file COPYRIGH.
2.12.2.5! eric        6: **     @(#) $Id: HTChannl.c,v 2.12.2.4 1996/11/06 00:38:33 frystyk Exp $
2.1       frystyk     7: **
                      8: **
                      9: ** HISTORY:
                     10: **     April 96  HFN   Written
                     11: */
                     12: 
                     13: /* Library Include files */
                     14: #include "sysdep.h"
                     15: #include "WWWUtil.h"
                     16: #include "HTAlert.h"
2.10      frystyk    17: #include "HTHost.h"
2.1       frystyk    18: #include "HTError.h"
                     19: #include "HTChannl.h"                                   /* Implemented here */
                     20: 
                     21: #define HASH_SIZE      67
                     22: #define HASH(s)                ((s) % HASH_SIZE)
                     23: 
                     24: struct _HTChannel {
                     25:     SOCKET             sockfd;                                    /* Socket */
                     26:     FILE *             fp;
                     27:     HTInputStream *    input;                               /* Input stream */
                     28:     HTOutputStream *   output;                             /* Output stream */
                     29:     BOOL               active;                 /* Active or passive channel */
                     30:     int                        semaphore;                         /* On channel use */
2.10      frystyk    31:     HTHost *           host;                          /* Zombie connections */
2.1       frystyk    32: };
                     33: 
                     34: struct _HTInputStream {
                     35:     const HTInputStreamClass * isa;    
                     36: };
                     37: 
                     38: struct _HTOutputStream {
                     39:     const HTOutputStreamClass *        isa;    
                     40: };
                     41: 
                     42: PRIVATE HTList ** channels = NULL;                      /* List of channels */
                     43: 
                     44: /* ------------------------------------------------------------------------- */
                     45: 
                     46: PRIVATE void free_channel (HTChannel * ch)
                     47: {
                     48:     if (ch) {
                     49: 
                     50:        /* Close the input and output stream */
2.11      frystyk    51:        if (ch->input) {
                     52:            (*ch->input->isa->close)(ch->input);
                     53:            ch->input = NULL;
                     54:        }
                     55:        if (ch->output) {
                     56:            (*ch->output->isa->close)(ch->output);
                     57:            ch->output = NULL;
                     58:        }
2.1       frystyk    59: 
                     60:        /* Close the socket */
                     61:        if (ch->sockfd != INVSOC) {
                     62:            NETCLOSE(ch->sockfd);
2.12.2.1  eric       63:            /*      HTEvent_unregister(ch->sockfd, all options); */
2.10      frystyk    64:            HTNet_decreaseSocket();
2.1       frystyk    65:            if (PROT_TRACE)
                     66:                HTTrace("Channel..... Deleted %p, socket %d\n", ch,ch->sockfd);
                     67:        }
2.12.2.2  eric       68:        ch->sockfd = INVSOC;
2.1       frystyk    69: 
                     70:        /* Close the file */
                     71:        if (ch->fp) {
                     72:            fclose(ch->fp);
                     73:            if (PROT_TRACE)
                     74:                HTTrace("Channel..... Deleted %p, file %p\n", ch, ch->fp);
                     75:        }
                     76:        HT_FREE(ch);
                     77:     }
                     78: }
                     79: 
                     80: /*
                     81: **     A channel is uniquely identified by a socket.
                     82: **     Note that we don't create the input and output stream - they are 
2.10      frystyk    83: **     created later.
2.1       frystyk    84: **
                     85: **     We only keep a hash on sockfd's as we don't have to look for channels
                     86: **     for ANSI file descriptors.
                     87: */
2.12.2.1  eric       88: PUBLIC HTChannel * HTChannel_new (SOCKET sockfd, BOOL active)
2.1       frystyk    89: {
2.12.2.1  eric       90:     HTList * list = NULL;
                     91:     HTChannel * ch = NULL;
                     92:     int hash = sockfd < 0 ? 0 : HASH(sockfd);
                     93:     if (PROT_TRACE) HTTrace("Channel..... Hash value is %d\n", hash);
                     94:     if (!channels) {
                     95:        if (!(channels = (HTList **) HT_CALLOC(HASH_SIZE,sizeof(HTList*))))
                     96:            HT_OUTOFMEM("HTChannel_new");
2.1       frystyk    97:     }
2.12.2.1  eric       98:     if (!channels[hash]) channels[hash] = HTList_new();
                     99:     list = channels[hash];
                    100:     if ((ch = (HTChannel *) HT_CALLOC(1, sizeof(HTChannel))) == NULL)
                    101:        HT_OUTOFMEM("HTChannel_new");       
                    102:     ch->sockfd = sockfd;
                    103:     ch->active = active;
                    104:     ch->semaphore = 1;
                    105:     HTList_addObject(list, (void *) ch);
                    106: 
                    107:     if (PROT_TRACE) HTTrace("Channel..... Added %p to list %p\n", ch,list);
                    108:     return ch;
2.1       frystyk   109: }
                    110: 
                    111: /*
                    112: **     Look for a channel object if we for some reason should have lost it
                    113: **     Returns NULL if nothing found
                    114: */
                    115: PUBLIC HTChannel * HTChannel_find (SOCKET sockfd)
                    116: {
                    117:     if (channels && sockfd != INVSOC) {
                    118:        int hash = HASH(sockfd);
                    119:        HTList * list = channels[hash];
                    120:        if (list) {
                    121:            HTChannel * ch = NULL;
                    122:            while ((ch = (HTChannel *) HTList_nextObject(list)))
                    123:                if (ch->sockfd == sockfd) return ch;
                    124:        }
                    125:     }
                    126:     return NULL;
                    127: }
                    128: 
                    129: /*
                    130: **     When deleting a channel we first look at if there are no more requests
                    131: **     using the channel (the semaphore is <= 0). Then, if the socket supports
                    132: **     persistent connections then we register the channel in the Host cache
                    133: **     and wait until the other end closes it or we get a time out on our side
                    134: */
2.6       eric      135: PUBLIC BOOL HTChannel_delete (HTChannel * channel, int status)
2.1       frystyk   136: {
                    137:     if (channel) {
2.2       frystyk   138:        if (PROT_TRACE) HTTrace("Channel..... Delete %p with semaphore %d\n",
2.1       frystyk   139:                                channel, channel->semaphore);
                    140:        /*
                    141:        **  We call the free methods on both the input stream and the output
                    142:        **  stream so that we can free up the stream pipes. However, note that
                    143:        **  this doesn't mean that we close the input stream and output stream
                    144:        **  them selves - only the generic streams
                    145:        */
2.12      frystyk   146:        if (status != HT_IGNORE) {
2.12.2.3  eric      147:            if (channel->input) {
2.12      frystyk   148:                if (status == HT_INTERRUPTED)
                    149:                    (*channel->input->isa->abort)(channel->input, NULL);
                    150:                else
                    151:                    (*channel->input->isa->_free)(channel->input);
2.12.2.3  eric      152:            }
                    153:            if (channel->output) {
2.12      frystyk   154:                if (status == HT_INTERRUPTED)
                    155:                    (*channel->output->isa->abort)(channel->output, NULL);
                    156:                else
                    157:                    (*channel->output->isa->_free)(channel->output);
2.12.2.3  eric      158:            }
2.12      frystyk   159:        }
2.1       frystyk   160: 
                    161:        /*
                    162:        **  Check whether this channel is used by other objects or we can
                    163:        **  delete it and free memory.
                    164:        */
2.12.2.2  eric      165:        if (channel->semaphore <= 0 && channels && channel->sockfd != INVSOC) {
2.1       frystyk   166:            int hash = HASH(channel->sockfd);
                    167:            HTList * list = channels[hash];
                    168:            if (list) {
                    169:                HTList_removeObject(list, (void *) channel);
                    170:                free_channel(channel);
                    171:                return YES;
                    172:            }
2.8       frystyk   173:        } else
                    174:            HTChannel_downSemaphore(channel);
2.1       frystyk   175:     }
                    176:     return NO;
                    177: }
                    178: 
                    179: /*     HTChannel_deleteAll
                    180: **     -------------------
                    181: **     Destroys all channels. This is called by HTLibTerminate(0
                    182: */
2.9       frystyk   183: PUBLIC BOOL HTChannel_deleteAll (void)
2.1       frystyk   184: {
                    185:     if (channels) {
                    186:        HTList * cur;
                    187:        int cnt;
                    188:        for (cnt=0; cnt<HASH_SIZE; cnt++) {
                    189:            if ((cur = channels[cnt])) { 
                    190:                HTChannel * pres;
                    191:                while ((pres = (HTChannel *) HTList_nextObject(cur)) != NULL)
                    192:                    free_channel(pres);
                    193:            }
                    194:            HTList_delete(channels[cnt]);
                    195:        }
                    196:        HT_FREE(channels);
                    197:     }
                    198:     return YES;
                    199: }
                    200: 
                    201: /*
2.10      frystyk   202: **     Return the socket associated with this channel
2.1       frystyk   203: */
2.10      frystyk   204: PUBLIC SOCKET HTChannel_socket (HTChannel * channel)
2.1       frystyk   205: {
2.10      frystyk   206:     return channel ? channel->sockfd : INVSOC;
2.1       frystyk   207: }
                    208: 
2.12.2.1  eric      209: PUBLIC void HTChannel_setSocket (HTChannel * channel, SOCKET socket)
                    210: {
                    211:     if (channel)
                    212:       channel->sockfd = socket;
                    213: }
                    214: 
2.10      frystyk   215: /*
                    216: **     Return the file descriptor associated with this channel
                    217: */
                    218: PUBLIC FILE * HTChannel_file (HTChannel * channel)
2.1       frystyk   219: {
2.10      frystyk   220:     return channel ? channel->fp : NULL;
2.1       frystyk   221: }
                    222: 
                    223: /*
2.10      frystyk   224: **     We keep the associated Host object in case we have a
                    225: **     sleeping connection. 
2.1       frystyk   226: */
2.10      frystyk   227: PUBLIC BOOL HTChannel_setHost (HTChannel * ch, HTHost * host)
2.1       frystyk   228: {
2.12.2.1  eric      229:     if (ch) {
2.10      frystyk   230:        ch->host = host;
                    231:        return YES;
                    232:     }
                    233:     return NO;
2.4       frystyk   234: }
                    235: 
2.10      frystyk   236: PUBLIC HTHost * HTChannel_host (HTChannel * ch)
2.4       frystyk   237: {
2.10      frystyk   238:     return (ch ? ch->host : NULL);
2.1       frystyk   239: }
                    240: 
                    241: /*
                    242: **     Increase the semaphore for this channel
                    243: */
                    244: PUBLIC void HTChannel_upSemaphore (HTChannel * channel)
                    245: {
                    246:     if (channel) {
                    247:        channel->semaphore++;
                    248:        if (PROT_TRACE)
                    249:            HTTrace("Channel..... Semaphore increased to %d for channel %p\n",
                    250:                    channel->semaphore, channel);
                    251:     }
                    252: }
                    253: 
                    254: /*
                    255: **     Decrease the semaphore for this channel
                    256: */
                    257: PUBLIC void HTChannel_downSemaphore (HTChannel * channel)
                    258: {
                    259:     if (channel) {
                    260:        channel->semaphore--;
                    261:        if (channel->semaphore <= 0) channel->semaphore = 0;
                    262:        if (PROT_TRACE)
                    263:            HTTrace("Channel..... Semaphore decreased to %d for channel %p\n",
2.7       frystyk   264:                    channel->semaphore, channel);
                    265:     }
                    266: }
                    267: 
                    268: /*
                    269: **     Explicitly set the semaphore for this channel
                    270: */
                    271: PUBLIC void HTChannel_setSemaphore (HTChannel * channel, int semaphore)
                    272: {
                    273:     if (channel) {
                    274:        channel->semaphore = semaphore;
                    275:        if (channel->semaphore <= 0) channel->semaphore = 0;
                    276:        if (PROT_TRACE)
                    277:            HTTrace("Channel..... Semaphore set to %d for channel %p\n",
2.1       frystyk   278:                    channel->semaphore, channel);
                    279:     }
                    280: }
                    281: 
                    282: /*
                    283: **     Create the input stream and bind it to the channel
                    284: **     Please read the description in the HTIOStream module on the parameters
                    285: */
2.10      frystyk   286: PUBLIC BOOL HTChannel_setInput (HTChannel * ch, HTInputStream * input)
2.1       frystyk   287: {
                    288:     if (ch) {
                    289:        ch->input = input;
                    290:        return YES;
                    291:     }
                    292:     return NO;
                    293: }
                    294: 
                    295: PUBLIC HTInputStream * HTChannel_input (HTChannel * ch)
                    296: {
                    297:     return ch ? ch->input : NULL;
                    298: }
                    299: 
                    300: /*
                    301: **     Create the output stream and bind it to the channel
                    302: **     Please read the description in the HTIOStream module on the parameters
                    303: */
2.10      frystyk   304: PUBLIC BOOL HTChannel_setOutput (HTChannel * ch, HTOutputStream * output)
2.1       frystyk   305: {
                    306:     if (ch) {
                    307:        ch->output = output;
                    308:        return YES;
                    309:     }
                    310:     return NO;
                    311: }
                    312: 
                    313: PUBLIC HTOutputStream * HTChannel_output (HTChannel * ch)
                    314: {
                    315:     return ch ? ch->output : NULL;
                    316: }
                    317: 

Webmaster