Annotation of libwww/Library/src/HTReader.c, revision 2.8.2.12

2.1       frystyk     1: /*                                                                  HTReader.c
                      2: **     READ STREAM FROM THE NETWORK USING TCP
                      3: **
                      4: **     (c) COPYRIGHT MIT 1995.
                      5: **     Please first read the full copyright statement in the file COPYRIGH.
2.8.2.12! eric        6: **     @(#) $Id: HTReader.c,v 2.8.2.11 1996/11/22 22:42:34 eric Exp $
2.1       frystyk     7: **
                      8: ** HISTORY:
                      9: **     6 June 95  HFN  Written
                     10: */
                     11: 
                     12: /* Library Include files */
                     13: #include "sysdep.h"
                     14: #include "WWWUtil.h"
2.5       frystyk    15: #include "WWWCore.h"
2.8.2.1   eric       16: #include "HTHost.h"
2.1       frystyk    17: #include "HTNetMan.h"
2.8.2.11  eric       18: #include "HTWatch.h"
2.1       frystyk    19: #include "HTReader.h"                                   /* Implemented here */
                     20: 
                     21: struct _HTStream {
                     22:     const HTStreamClass *      isa;
                     23:     /* ... */
                     24: };
                     25: 
                     26: struct _HTInputStream {
                     27:     const HTInputStreamClass * isa;
                     28:     HTChannel *                        ch;
2.8.2.1   eric       29:     HTHost *                   host;
2.1       frystyk    30:     char *                     write;                  /* Last byte written */
                     31:     char *                     read;                      /* Last byte read */
                     32:     char                       data [INPUT_BUFFER_SIZE];          /* buffer */
2.8.2.1   eric       33:     int                                b_read;
2.1       frystyk    34: };
                     35: 
                     36: /* ------------------------------------------------------------------------- */
                     37: 
                     38: PRIVATE int HTReader_flush (HTInputStream * me)
                     39: {
2.8.2.1   eric       40:     HTNet * net = HTHost_getReadNet(me->host);
2.8.2.2   eric       41:     return net && net->readStream ? (*net->readStream->isa->flush)(net->readStream) : HT_OK;
2.1       frystyk    42: }
                     43: 
                     44: PRIVATE int HTReader_free (HTInputStream * me)
                     45: {
2.8.2.1   eric       46:     HTNet * net = HTHost_getReadNet(me->host);
                     47:     if (net && net->readStream) {
2.8.2.2   eric       48:        int status = (*net->readStream->isa->_free)(net->readStream);
2.8.2.7   frystyk    49:        if (status == HT_OK) net->readStream = NULL;
2.1       frystyk    50:        return status;
                     51:     }
                     52:     return HT_OK;
                     53: }
                     54: 
                     55: PRIVATE int HTReader_abort (HTInputStream * me, HTList * e)
                     56: {
2.8.2.1   eric       57:     HTNet * net = HTHost_getReadNet(me->host);
                     58:     if (net && net->readStream) {
2.8.2.7   frystyk    59:        int status = (*net->readStream->isa->abort)(net->readStream, NULL);
                     60:        if (status != HT_IGNORE) net->readStream = NULL;
2.1       frystyk    61:     }
                     62:     return HT_ERROR;
                     63: }
                     64: 
                     65: /*     Push data from a socket down a stream
                     66: **     -------------------------------------
                     67: **
                     68: **   This routine is responsible for creating and PRESENTING any
                     69: **   graphic (or other) objects described by the file. As this function
                     70: **   max reads a chunk of data on size INPUT_BUFFER_SIZE, it can be used
                     71: **   with both blocking or non-blocking sockets. It will always return to
                     72: **   the event loop, however if we are using blocking I/O then we get a full
                     73: **   buffer read, otherwise we get what's available.
                     74: **
                     75: ** Returns      HT_LOADED      if finished reading
                     76: **             HT_OK           if OK, but more to read
                     77: **             HT_ERROR        if error,
                     78: **                     HT_WOULD_BLOCK  if read or write would block
                     79: **             HT_PAUSE        if stream is paused
                     80: */
2.8.2.8   eric       81: int DebugBufferSize = INPUT_BUFFER_SIZE;
2.8.2.12! eric       82: 
        !            83: /* #include fakeReader.c */
2.1       frystyk    84: PRIVATE int HTReader_read (HTInputStream * me)
                     85: {
2.8.2.1   eric       86:     HTHost * host = me->host;
2.8.2.3   frystyk    87:     SOCKET soc = HTChannel_socket(me->ch);
2.8.2.1   eric       88:     HTNet * net = HTHost_getReadNet(host);
2.8.2.3   frystyk    89:     HTRequest * request = HTNet_request(net);
                     90:     int status;
2.1       frystyk    91: 
2.8.2.2   eric       92:     /*    me->b_read = me->read - me->data; */
2.1       frystyk    93:     /* Read from socket if we got rid of all the data previously read */
                     94:     do {
2.8.2.1   eric       95:        /* don't read if we have to push unwritten data from last call */
2.1       frystyk    96:        if (me->write >= me->read) {
2.8.2.8   eric       97:            if ((me->b_read = NETREAD(soc, me->data, DebugBufferSize)) < 0) {
2.1       frystyk    98: #ifdef EAGAIN
                     99:                if (socerrno==EAGAIN || socerrno==EWOULDBLOCK)      /* POSIX */
                    100: #else
                    101:                if (socerrno==EWOULDBLOCK)                            /* BSD */
                    102: #endif 
                    103:                {
                    104:                    if (PROT_TRACE)
                    105:                        HTTrace("Read Socket. WOULD BLOCK fd %d\n",soc);
2.8.2.1   eric      106:                    HTHost_register(host, net, HTEvent_READ);
2.1       frystyk   107:                    return HT_WOULD_BLOCK;
                    108: #ifdef __svr4__
                    109:     /* 
                    110:     ** In Solaris envirnoment, SIGPOLL is used to signal end of buffer for
                    111:     ** /dev/audio.  If your process is also doing a socket read, it will cause
                    112:     ** an EINTR error.  This error will cause the www library request to 
                    113:     ** terminate prematurly.
                    114:     */
                    115:                 } else if (socerrno == EINTR) {
                    116:                     continue;
                    117: #endif /* __svr4__ */
2.8.2.9   eric      118: #ifdef EPIPE
                    119:                } else if (socerrno == EPIPE) {
                    120:                    goto socketClosed;
                    121: #endif /* EPIPE */
2.1       frystyk   122:                } else {                             /* We have a real error */
                    123: 
                    124:                    /* HERE WE SHOULD RETURN target abort */
2.8.2.3   frystyk   125:                    if (request)
                    126:                        HTRequest_addSystemError(request, ERR_FATAL, socerrno,
                    127:                                                 NO, "NETREAD");
2.1       frystyk   128:                    return HT_ERROR;
                    129:                }
2.8       frystyk   130: #ifdef ECONNRESET
2.8.2.1   eric      131:            } else if (!me->b_read || socerrno==ECONNRESET) {
2.8       frystyk   132: #else
2.8.2.1   eric      133:            } else if (!me->b_read) {
2.8       frystyk   134: #endif
2.8.2.9   eric      135:            socketClosed:
2.8.2.3   frystyk   136:                HTTrace("Read Socket. FIN received on socket %d\n", soc);
                    137:                if (request) {
                    138:                    HTAlertCallback *cbf = HTAlert_find(HT_PROG_DONE);
                    139:                    if (PROT_TRACE)
                    140:                        if (cbf) (*cbf)(request, HT_PROG_DONE,
                    141:                                        HT_MSG_NULL, NULL, NULL, NULL);
                    142:                }
                    143:                HTHost_unregister(host, net, HTEvent_READ);
2.1       frystyk   144:                return HT_CLOSED;
                    145:            }
                    146: 
                    147:            /* Remember how much we have read from the input socket */
2.8.2.12! eric      148:            HTWatch_logData(me->data, me->b_read, "HTReader_read %d bytes:", me->b_read);
2.1       frystyk   149:            me->write = me->data;
2.8.2.1   eric      150:            me->read = me->data + me->b_read;
2.1       frystyk   151: 
                    152: #ifdef NOT_ASCII
                    153:            {
                    154:                char *p = me->data;
                    155:                while (p < me->read) {
                    156:                    *p = FROMASCII(*p);
                    157:                    p++;
                    158:                }
                    159:            }
                    160: #endif /* NOT_ASCII */
                    161: 
                    162:            if (PROT_TRACE) 
                    163:                HTTrace("Read Socket. %d bytes read from socket %d\n",
2.8.2.1   eric      164:                        me->b_read, soc);
2.8.2.3   frystyk   165:            if (request) {
2.1       frystyk   166:                HTAlertCallback * cbf = HTAlert_find(HT_PROG_READ);
2.8.2.4   frystyk   167: #if 0
                    168:                /* byte account is done later */
2.8.2.1   eric      169:                net->bytesRead += me->b_read;
2.8.2.4   frystyk   170: #endif
2.8.2.3   frystyk   171:                if (cbf) (*cbf)(request, HT_PROG_READ,
2.1       frystyk   172:                                HT_MSG_NULL, NULL, NULL, NULL);
                    173:            }
                    174:        }
                    175: 
                    176:        /* Now push the data down the stream */
2.8.2.1   eric      177:        if ((status = (*net->readStream->isa->put_block)
2.8.2.2   eric      178:             (net->readStream, me->write, me->b_read)) != HT_OK) {
2.1       frystyk   179:            if (status == HT_WOULD_BLOCK) {
                    180:                if (PROT_TRACE) HTTrace("Read Socket. Target WOULD BLOCK\n");
2.8.2.1   eric      181:                HTHost_unregister(host, net, HTEvent_READ);
2.1       frystyk   182:                return HT_WOULD_BLOCK;
                    183:            } else if (status == HT_PAUSE) {
                    184:                if (PROT_TRACE) HTTrace("Read Socket. Target PAUSED\n");
2.8.2.1   eric      185:                HTHost_unregister(host, net, HTEvent_READ);
2.1       frystyk   186:                return HT_PAUSE;
2.8.2.1   eric      187:            /* CONTINUE code or stream code means data was consumed */
                    188:            } else if (status == HT_CONTINUE || status > 0) {
                    189:                if (status == HT_CONTINUE) {
                    190:                    if (PROT_TRACE) HTTrace("Read Socket. CONTINUE\n");
                    191:                } else
                    192:                    if (PROT_TRACE)
                    193:                        HTTrace("Read Socket. Target returns %d\n", status);
                    194: /*             me->write = me->read; */
2.1       frystyk   195:                return status;
                    196:            } else {                                 /* We have a real error */
                    197:                if (PROT_TRACE) HTTrace("Read Socket. Target ERROR\n");
                    198:                return status;
                    199:            }
                    200:        }
2.8.2.1   eric      201:        me->write = me->read;
                    202:        HTHost_setRemainingRead(host, 0);
2.1       frystyk   203:     } while (net->preemptive);
2.8.2.1   eric      204:     HTHost_register(host, net, HTEvent_READ);
2.1       frystyk   205:     return HT_WOULD_BLOCK;
                    206: }
                    207: 
                    208: /*
                    209: **     The difference between the close and the free method is that we don't
                    210: **     close the connection in the free method - we only call the free method
                    211: **     of the target stream. That way, we can keep the input stream as long 
                    212: **     as the channel itself.
                    213: */
                    214: PRIVATE int HTReader_close (HTInputStream * me)
                    215: {
                    216:     int status = HT_OK;
2.8.2.1   eric      217:     HTNet * net = HTHost_getReadNet(me->host);
                    218:     if (net && net->readStream) {
2.8.2.2   eric      219:        if ((status = (*net->readStream->isa->_free)(net->readStream))==HT_WOULD_BLOCK)
2.1       frystyk   220:            return HT_WOULD_BLOCK;
2.8.2.6   eric      221:        net->readStream = NULL;
2.1       frystyk   222:     }
                    223:     if (PROT_TRACE) HTTrace("Socket read. FREEING....\n");
                    224:     HT_FREE(me);
                    225:     return status;
                    226: }
                    227: 
2.8.2.1   eric      228: PUBLIC int HTReader_consumed (HTInputStream * me, size_t bytes)
                    229: {
2.8.2.5   frystyk   230:     if (PROT_TRACE) HTTrace("Socket read. consumed %d bytes\n", bytes);
2.8.2.1   eric      231:     me->write += bytes;
                    232:     me->b_read -= bytes;
                    233:     HTHost_setRemainingRead(me->host, me->b_read);
                    234:     return HT_OK;
                    235: }
                    236: 
2.1       frystyk   237: PRIVATE const HTInputStreamClass HTReader =
                    238: {
                    239:     "SocketReader",
                    240:     HTReader_flush,
                    241:     HTReader_free,
                    242:     HTReader_abort,
                    243:     HTReader_read,
2.8.2.1   eric      244:     HTReader_close,
                    245:     HTReader_consumed
2.1       frystyk   246: }; 
                    247: 
                    248: /*
                    249: **     Create a new input read stream. Before we actually create it we check
                    250: **     to see whether we already have an input stream for this channel and if
                    251: **     so we just return that. This means that we can reuse input streams 
                    252: **     in persistent connections, for example.
                    253: */
2.8.2.1   eric      254: PUBLIC HTInputStream * HTReader_new (HTHost * host, HTChannel * ch,
                    255:                                     void * param, int mode)
2.1       frystyk   256: {
2.8.2.1   eric      257:     if (host && ch) {
2.1       frystyk   258:        HTInputStream * me = HTChannel_input(ch);
                    259:        if (me == NULL) {
                    260:            if ((me=(HTInputStream *) HT_CALLOC(1, sizeof(HTInputStream))) == NULL)
                    261:            HT_OUTOFMEM("HTReader_new");
                    262:            me->isa = &HTReader;
                    263:            me->ch = ch;
2.8.2.3   frystyk   264:            me->host = host;
2.1       frystyk   265:        }
                    266:        return me;
                    267:     }
                    268:     return NULL;
                    269: }
2.8.2.12! eric      270: 

Webmaster