httpif.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * */
/*
 * ======== httpif.h ========
 *
 */

#ifndef _HTTPIF_H_
#define _HTTPIF_H_

#ifdef __cplusplus
extern "C" {
#endif

/* HTTP SERVER SERVICE */

/* HTTP Parameter Structure */
typedef struct _ntparam_http {
    int     MaxCon;             
    int     Port;               
} NTPARAM_HTTP;

extern void *httpOpen( NTARGS *pNTA, NTPARAM_HTTP *pNTP );

extern void  httpClose(void *hHTTP);

/*
 * This is typically an internal fxn, so is not documented.  However,
 * IPv6 users do need access to this symbol for reasons described in
 * the API users guide.
 */

/* httpClientProcess */
/* This entry point is used to invoke HTTP directly from */
/* the server daemon. */
extern int   httpClientProcess( SOCKET Sock, uint32_t unused );

/* Public String Definitions */
/*
char *CONTENT_TYPE_APPLET  = "application/octet-stream ";
char *CONTENT_TYPE_AU      = "audio/au ";
char *CONTENT_TYPE_DOC     = "application/msword ";
char *CONTENT_TYPE_GIF     = "image/gif ";
char *CONTENT_TYPE_HTML    = "text/html ";
char *CONTENT_TYPE_JPG     = "image/jpeg ";
char *CONTENT_TYPE_MPEG    = "video/mpeg ";
char *CONTENT_TYPE_PDF     = "application/pdf ";
char *CONTENT_TYPE_WAV     = "audio/wav ";
char *CONTENT_TYPE_ZIP     = "application/zip ";
char *CONTENT_TYPE         = "Content-type: ";
char *CONTENT_LENGTH       = "Content-length: ";
char *CRLF                 = "\r\n";
char *DEFAULT_NAME         = "index.html";
char *HTTP_VER             = "HTTP/1.0 ";
char *SPACE                = " ";
*/
extern char *CONTENT_TYPE_APPLET;
extern char *CONTENT_TYPE_AU;
extern char *CONTENT_TYPE_CSS; /* Add June 1st, 2010, KQ */
extern char *CONTENT_TYPE_DOC;
extern char *CONTENT_TYPE_GIF;
extern char *CONTENT_TYPE_HTML;
extern char *CONTENT_TYPE_JPG;
extern char *CONTENT_TYPE_MPEG;
extern char *CONTENT_TYPE_PDF;
extern char *CONTENT_TYPE_WAV;
extern char *CONTENT_TYPE_ZIP;
extern char *CONTENT_TYPE;
extern char *CONTENT_LENGTH;
extern char *CRLF;
extern char *DEFAULT_NAME;
extern char *HTTP_VER;
extern char *SPACE;

/* Status codes for httpSendFullResponse() and httpSendStatusLine() */
enum HTTP_STATUS_CODE
{
    HTTP_OK=200,
    HTTP_NO_CONTENT=204,
    HTTP_BAD_REQUEST=400,
    HTTP_AUTH_REQUIRED=401,
    HTTP_NOT_FOUND=404,
    HTTP_NOT_ALLOWED=405,
    HTTP_NOT_IMPLEMENTED=501,
    HTTP_STATUS_CODE_END
};

#define HTTPPORT           80
#define MAX_RESPONSE_SIZE  200

extern int  httpVersion(void);

/* httpSendClientStr */
/* Sends the indicated NULL terminated response string to */
/* the indicated client socket - i.e.: calls strlen() and send() */
extern void httpSendClientStr( SOCKET Sock, char *Response );

/* httpSendStatusLine */
/* Sends a formatted response message to Sock with the given */
/* status code and content type. The value of ContentType can */
/* be NULL if no ContentType is required. */
extern void httpSendStatusLine( SOCKET Sock, int StatusCode, char *ContentType );

/* httpSendFullResponse */
/* Sends a full formatted response message to Sock, including the */
/* file indicated by the filename in RequestedFile. The status code */
/* for this call is usually HTTP_OK. */
extern void httpSendFullResponse( SOCKET Sock, int StatusCode,
                                   char *RequestedFile );

/* httpSendEntityLength */
/* Write out the entiry length tag, and terminates the header */
/* with an additional CRLF. */
/* Since the header is terminated, this must be the last tag */
/* written. Entity data should follow immediately. */
extern void httpSendEntityLength( SOCKET Sock, int32_t EntityLength );


/* httpSendErrorResponse */
/* Sends a formatted error response message to Sock based on the */
/* status code. */
extern void httpSendErrorResponse( SOCKET Sock, int StatusCode );


/* httpErrorResponseHook */
/* Pointer to hook error response functions. Once an application */
/* writes a pointer to httpErrorResponseHook, the function will */
/* be called to generate all HTML code contained in any error */
/* response message. This function is optional and should not be */
/* used unless required. */
/* The installed callback should generate only the "Content Length" */
/* tag, followed immediately by the HTML data. The content length */
/* tag can be written using the httpSendEntityLength() function. */
/* (This function also terminates the HTTP header.) */
/* The installed callback returns: */
/*   1 - Error was handled and HTML was generated by the callback */
/*   0 - No HTML was generated (HTTP server should use its default) */
extern int (*httpErrorResponseHook)(SOCKET Sock, int StatusCode);

/* Common error responses */
#define http400(Sock)  httpSendErrorResponse((Sock), HTTP_BAD_REQUEST)
#define http404(Sock)  httpSendErrorResponse((Sock), HTTP_NOT_FOUND)
#define http405(Sock)  httpSendErrorResponse((Sock), HTTP_NOT_ALLOWED)
#define http501(Sock)  httpSendErrorResponse((Sock), HTTP_NOT_IMPLEMENTED)

#ifdef __cplusplus
}
#endif /* extern "C" */

#endif