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

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

Webmaster