response.h File Reference

HTTP response handler. More...

#include "dist/mongoose/mongoose.h"
#include "src/lib/json/json_rpc.h"

Include dependency graph for response.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	webserver_send_raw_response (struct mg_mgr *mgr, struct t_work_response *response)
void	webserver_send_redirect (struct mg_mgr *mgr, struct t_work_response *response)
void	webserver_send_api_response (struct mg_mgr *mgr, struct t_work_response *response)
void	webserver_send_error (struct mg_connection *nc, int code, const char *msg)
void	webserver_serve_file (struct mg_connection *nc, struct mg_http_message *hm, const char *headers, const char *file)
void	webserver_send_header_ok (struct mg_connection *nc, size_t len, const char *headers)
void	webserver_send_header_redirect (struct mg_connection *nc, const char *location, const char *headers)
void	webserver_send_header_found (struct mg_connection *nc, const char *location, const char *headers)
void	webserver_send_cors_reply (struct mg_connection *nc)
void	webserver_send_data (struct mg_connection *nc, const char *data, size_t len, const char *headers)
void	webserver_send_raw (struct mg_connection *nc, const char *data, size_t len)
void	webserver_send_jsonrpc_response (struct mg_connection *nc, enum mympd_cmd_ids cmd_id, unsigned request_id, enum jsonrpc_facilities facility, enum jsonrpc_severities severity, const char *message)

Detailed Description

HTTP response handler.

Function Documentation

webserver_send_api_response()

void webserver_send_api_response	(	struct mg_mgr *	mgr,
		struct t_work_response *	response
	)

Sends an api response

Parameters

mgr	mongoose mgr
response	jsonrpc response

webserver_send_cors_reply()

void webserver_send_cors_reply

(

struct mg_connection *

nc

)

Replies to preflighted requests in CORS

Parameters

nc	mongoose connection

webserver_send_data()

void webserver_send_data	(	struct mg_connection *	nc,
		const char *	data,
		size_t	len,
		const char *	headers
	)

Sends binary data

Parameters

nc	mongoose connection
data	data to send
len	length of the data to send
headers	extra headers to add

webserver_send_error()

void webserver_send_error	(	struct mg_connection *	nc,
		int	code,
		const char *	msg
	)

Sends a http error response

Parameters

nc	mongoose connection
code	http error code
msg	the error message

webserver_send_header_found()

void webserver_send_header_found	(	struct mg_connection *	nc,
		const char *	location,
		const char *	headers
	)

Sends a 302 found header

Parameters

nc	mongoose connection
location	destination for the redirect
headers	extra headers to add

webserver_send_header_ok()

void webserver_send_header_ok	(	struct mg_connection *	nc,
		size_t	len,
		const char *	headers
	)

Sends a http OK reply with content-length header

Parameters

nc	mongoose connection
len	length for the content-length header
headers	extra headers to add

webserver_send_header_redirect()

void webserver_send_header_redirect	(	struct mg_connection *	nc,
		const char *	location,
		const char *	headers
	)

Sends a 301 moved permanently header

Parameters

nc	mongoose connection
location	destination for the redirect
headers	extra headers to add

webserver_send_jsonrpc_response()

void webserver_send_jsonrpc_response	(	struct mg_connection *	nc,
		enum mympd_cmd_ids	cmd_id,
		unsigned	request_id,
		enum jsonrpc_facilities	facility,
		enum jsonrpc_severities	severity,
		const char *	message
	)

Creates and sends a jsonrpc response

Parameters

nc	mongoose connection
cmd_id	myMPD API method
request_id	jsonrpc request id
facility	jsonrpc facility
severity	jsonrpc severity
message	message to send

webserver_send_raw()

void webserver_send_raw	(	struct mg_connection *	nc,
		const char *	data,
		size_t	len
	)

Sends a raw reply

Parameters

nc	mongoose connection
data	data to send
len	length of the data to send

webserver_send_raw_response()

void webserver_send_raw_response	(	struct mg_mgr *	mgr,
		struct t_work_response *	response
	)

Sends a raw http response message

Parameters

mgr	mongoose mgr
response	jsonrpc response

webserver_send_redirect()

void webserver_send_redirect	(	struct mg_mgr *	mgr,
		struct t_work_response *	response
	)

Sends a redirect http response message

Parameters

mgr	mongoose mgr
response	jsonrpc response

webserver_serve_file()

void webserver_serve_file	(	struct mg_connection *	nc,
		struct mg_http_message *	hm,
		const char *	headers,
		const char *	file
	)

Serves a file defined by file from path

Parameters

nc	mongoose connection
hm	mongoose http message
headers	extra headers to add
file	absolute filepath to serve