18d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 28d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * httpread - Manage reading file(s) from HTTP/TCP socket 38d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Author: Ted Merrill 48d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Copyright 2008 Atheros Communications 58d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 6c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt * This software may be distributed under the terms of the BSD license. 7c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt * See README for more details. 88d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 98d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifndef HTTPREAD_H 118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define HTTPREAD_H 128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* event types (passed to callback) */ 148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum httpread_event { 158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_EVENT_FILE_READY = 1, /* including reply ready */ 168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_EVENT_TIMEOUT = 2, 178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_EVENT_ERROR = 3 /* misc. error, esp malloc error */ 188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* header type detected 228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * available to callback via call to httpread_reply_code_get() 238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum httpread_hdr_type { 258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_UNKNOWN = 0, /* none of the following */ 268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_REPLY = 1, /* hdr begins w/ HTTP/ */ 278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_GET = 2, /* hdr begins with GET<sp> */ 288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_HEAD = 3, /* hdr begins with HEAD<sp> */ 298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_POST = 4, /* hdr begins with POST<sp> */ 308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_PUT = 5, /* hdr begins with ... */ 318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_DELETE = 6, /* hdr begins with ... */ 328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_TRACE = 7, /* hdr begins with ... */ 338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_CONNECT = 8, /* hdr begins with ... */ 348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_NOTIFY = 9, /* hdr begins with ... */ 358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_M_SEARCH = 10, /* hdr begins with ... */ 368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_M_POST = 11, /* hdr begins with ... */ 378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_SUBSCRIBE = 12, /* hdr begins with ... */ 388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_HDR_TYPE_UNSUBSCRIBE = 13, /* hdr begins with ... */ 398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt HTTPREAD_N_HDR_TYPES /* keep last */ 418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* control instance -- opaque struct declaration 458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct httpread; 478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_destroy -- if h is non-NULL, clean up 508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This must eventually be called by the application following 518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * call of the application's callback and may be called 528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * earlier if desired. 538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid httpread_destroy(struct httpread *h); 558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_create -- start a new reading session making use of eloop. 578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * The new instance will use the socket descriptor for reading (until 588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * it gets a file and not after) but will not close the socket, even 598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * when the instance is destroyed (the application must do that). 608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Return NULL on error. 618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Provided that httpread_create successfully returns a handle, 638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * the callback fnc is called to handle httpread_event events. 648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * The caller should do destroy on any errors or unknown events. 658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Pass max_bytes == 0 to not read body at all (required for e.g. 678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * reply to HEAD request). 688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct httpread * httpread_create( 708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int sd, /* descriptor of TCP socket to read from */ 718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void (*cb)(struct httpread *handle, void *cookie, 728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt enum httpread_event e), /* call on event */ 738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void *cookie, /* pass to callback */ 748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int max_bytes, /* maximum file size else abort it */ 758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int timeout_seconds /* 0; or total duration timeout period */ 768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt ); 778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_hdr_type_get -- When file is ready, returns header type. 798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum httpread_hdr_type httpread_hdr_type_get(struct httpread *h); 818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_uri_get -- When file is ready, uri_get returns (translated) URI 848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * or possibly NULL (which would be an error). 858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtchar *httpread_uri_get(struct httpread *h); 878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_reply_code_get -- When reply is ready, returns reply code */ 898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint httpread_reply_code_get(struct httpread *h); 908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_length_get -- When file is ready, returns file length. */ 938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint httpread_length_get(struct httpread *h); 948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_data_get -- When file is ready, returns file content 968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * with null byte appened. 978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Might return NULL in some error condition. 988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid * httpread_data_get(struct httpread *h); 1008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_hdr_get -- When file is ready, returns header content 1028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * with null byte appended. 1038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Might return NULL in some error condition. 1048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtchar * httpread_hdr_get(struct httpread *h); 1068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* httpread_hdr_line_get -- When file is ready, returns pointer 1088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * to line within header content matching the given tag 1098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * (after the tag itself and any spaces/tabs). 1108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * The tag should end with a colon for reliable matching. 1128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * If not found, returns NULL; 1148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtchar * httpread_hdr_line_get(struct httpread *h, const char *tag); 1168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif /* HTTPREAD_H */ 118