An HTTP server is an integral part of the framework, both to display UI in a browser and to provide application services via commands, file uploads and downloads, etc. The functionality is coded as static functions in the Geometrics::GmWebServer class, using the the class as a namespace. More...

#include <GmWebServer.hpp>

Static Public Member Functions
static Int	WebCommand (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	ListAcquisitionDataFilesJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	ListAcquisitionDataFiles (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	ListSurveys (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	ListSurveysJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	ListAcquisitionsJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	ListAcquisitionsJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	CloseCurrentSurveyExJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	CloseCurrentAcqExJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	NewAcquisition (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	SelectSurveyJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	SelectAcqJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	NewAcqJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	NewAcquisitionJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	NewSurveyJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	DeleteSurvey (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	SetActiveAcquisition (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	NameActiveAcquisitionJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	SetActiveAcquisitionNameJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	AddAcquisitionInfoJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	GetActiveAcquisitionNameJson (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	WebDeleteSession (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	ShowLoggingConfig (SOCKET s, char *buf)

static int	StatusJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	JsonGet (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	GetTestFileUploadForm (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	statusDetails (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	getStatus (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	getStatusInternal (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args, Bool autoRefresh=FALSE)

static Int	sysInfo (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	CleanOldFiles (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	ShutdownSystem (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	ResetSystem (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	TestFileUpload (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	getStatusTxt (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	WifiCheck (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	DiagnosticsJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	BatteryJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	Batteries (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	StatusJsonEx2 (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	SysInfoJsonEx (SOCKET s, struct rhc_http_msg pMsg, UINT8 args)

static int	GpsJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	Mark (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	MarkTarget (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	Destination (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	RequestSynch (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	RequestDeleteSegment (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	SetSamplePeriod (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	AcquisitionsJsonEx2 (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	MagnetometersJsonEx (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	GenericJsonRequest (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	AcquisitionEx (SOCKET s, const char strSurveyId, const char strAcquisitionId, RHC_HTTP_MSG pMsg, UINT8 args)

static int	FilesJsonEx (SOCKET s, const char strSurveyId, const char strAcquisitionId, RHC_HTTP_MSG pMsg, UINT8 args)

static Bool	UriIsAcquisition (const char strUri, char strSurveyId, char *strAcquisitionId)

static Bool	GetSurveyIdFromUri (const char strUri, char dest)

static int	DownloadDataFile (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static int	DownloadAcquisition (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args, const char strSurveyId, const char strAcquisitionId)

static int	StreamFileContents (SOCKET s, const char strSurveyId, const char strAcquisitionId, const char *strFileName)

static int	StreamFileContents (SOCKET s, const char strSurveyId, const char strAcquisitionId, const int fileIndex, const bool filesInDirectories, const int directorySize)

static Int	SystemTest (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

static Int	RunSystemTests (SOCKET s, RHC_HTTP_MSG pMsg, UINT8 args)

Static Protected Member Functions
static int	ProcessAcquisitionDataFiles (char pSurveyId, char strAcquisitionId, Bool isPreprocessingStage, const int filesReported, const int kbytesInFiles, std::function< int(const char *buffer)> handler, std::function< int(const int filesReported, const int kbytesInFiles)> finalReport)

Detailed Description

An HTTP server is an integral part of the framework, both to display UI in a browser and to provide application services via commands, file uploads and downloads, etc. The functionality is coded as static functions in the Geometrics::GmWebServer class, using the the class as a namespace.

The web server delivers most of its functionality by making calls into the Geometrics::GmTezzeretApp singleton.

Be very careful to use the content-length header in HTTP responses, if necessary doing a complete run-through of a response just to calculate the content length. The function ProcessAcquisitionDataFiles shows one way of doing this. The use of content length is essential to ensuring orderly network connection behavior, which is vital on a small microcontroller.

Member Function Documentation

◆ GenericJsonRequest()

int GmWebServer::GenericJsonRequest	(	SOCKET	s,
		RHC_HTTP_MSG *	pMsg,
		UINT8 *	args
	)

static

Generic request for JSON document, with request encoded in the args.

The documentation for this class was generated from the following files:

/home/kddev/dev/TivaWorkspace/TezzeretApps/GmWebServer.hpp
/home/kddev/dev/TivaWorkspace/TezzeretApps/GmWebServer.cpp

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ GenericJsonRequest()