Data Structures | Typedefs | Functions
http_server.h File Reference

HTTP server. More...

Data Structures

struct  vtm_http_srv_cbs
 
struct  vtm_http_srv_opts
 

Typedefs

typedef struct vtm_http_srv vtm_http_srv
 

Functions

VTM_API vtm_http_srv * vtm_http_srv_new (void)
 
VTM_API void vtm_http_srv_free (vtm_http_srv *srv)
 
VTM_API int vtm_http_srv_run (vtm_http_srv *srv, struct vtm_http_srv_opts *opts)
 
VTM_API int vtm_http_srv_stop (vtm_http_srv *srv)
 

Function Documentation

VTM_API vtm_http_srv* vtm_http_srv_new ( void  )

Creates a new server.

Returns
the created server which can be used in the other functions
NULL if an error occured
VTM_API void vtm_http_srv_free ( vtm_http_srv *  srv)

Releases the server and all allocated resources.

Aftert this call the server pointer is no longer valid.

Parameters
srvthe server that should be released
VTM_API int vtm_http_srv_run ( vtm_http_srv *  srv,
struct vtm_http_srv_opts opts 
)

Runs the server.

This method blocks until the server is stopped or if an error occurs.

Parameters
srvthe previously created server
optsthe options for running the server
Returns
VTM_OK if the server has been started successfully and has already been shut down again
VTM_ERROR or other more specific error code when the server could not be started
VTM_API int vtm_http_srv_stop ( vtm_http_srv *  srv)

Stops the server.

This method blocks until the server is gracefully shutdown.

Parameters
srvthe server which should be stopped
Returns
VTM_OK if the shutdown was successful
VTM_ERROR if an error occured