httpserver.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2018 Texas Instruments Incorporated - https://www.ti.com
 * 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.
 */

/*
 * ======== ti/net/http/httpserver.h ========
 */
#ifndef ti_net_http_HTTPServer__include
#define ti_net_http_HTTPServer__include


#include <stdint.h>
#include <stdbool.h>
#include <sys/socket.h>
#include <ti/net/slnetsock.h>

#include "urlhandler.h"

#ifdef __cplusplus
extern "C" {
#endif

#define HTTPServer_EACCEPTFAIL   (-2)

#define HTTPServer_ESOCKETFAIL   (-3)

#define HTTPServer_EBINDFAIL     (-4)

#define HTTPServer_ELISTENFAIL   (-5)

#define HTTPServer_EMEMFAIL      (-6)

#define HTTPServer_EMQFAIL       (-7)

#define HTTPServer_EMUTEXFAIL    (-8)

/* internal utility fxn, not for end users */
extern void _HTTPServer_sleepms(uint32_t time);
typedef struct HTTPServer_Params {
    int timeout;
    int maxLineLen;

    int maxURILen;

    int maxSessions;
} HTTPServer_Params;

typedef struct HTTPServer_Object * HTTPServer_Handle;

extern void HTTPServer_init(void);

extern void HTTPServer_Params_init(HTTPServer_Params *params);

extern void HTTPServer_enableSecurity(HTTPServer_Handle srv,
        SlNetSockSecAttrib_t * securityAttributes, bool beginSecurely);

extern HTTPServer_Handle HTTPServer_create(const URLHandler_Setup * urlh,
        int numURLh, HTTPServer_Params * params);

extern void HTTPServer_delete(HTTPServer_Handle * srv);

extern int HTTPServer_processClient(HTTPServer_Handle srv, int s);
extern void HTTPServer_sendSimpleResponse(int s, int status,
        const char * type, size_t len, const void * buf);

extern void HTTPServer_sendResponse(int s, int status,
        const char * headers[], int numHeaders, size_t len, const void * buf);

extern void HTTPServer_sendErrorResponse(int s, int status);

extern void HTTPServer_sendResponseChunked(int s, int status,
        const char * type);

extern void HTTPServer_sendChunk(int s, const void * buf, size_t len);

extern int HTTPServer_serveSelect(HTTPServer_Handle srv,
        const struct sockaddr *addr, int len, int backlog);

extern bool HTTPServer_stop(HTTPServer_Handle srv, uint32_t timeout);

/* internal services not quite ready to expose just yet */
extern int (*HTTPServer_errorResponseHook)(int s, int status);

extern void HTTPServer_requestSend(URLHandler_Session urls);

extern void HTTPServer_stopSession(URLHandler_Session urls);
extern bool HTTPServer_isSessionSecure(URLHandler_Session sess);

#ifdef __cplusplus
}
#endif

#endif