MythTV  master
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MythHTTPService Class Reference

#include <mythhttpservice.h>

Inheritance diagram for MythHTTPService:
Inheritance graph
[legend]
Collaboration diagram for MythHTTPService:
Collaboration graph
[legend]

Public Member Functions

 MythHTTPService (MythHTTPMetaService *MetaService)
 
 ~MythHTTPService () override=default
 
virtual HTTPResponse HTTPRequest (const HTTPRequest2 &Request)
 Respond to a valid HTTPRequest. More...
 
QString & Name ()
 

Static Public Member Functions

template<class T >
static HTTPServicePtr Create ()
 

Protected Member Functions

bool HAS_PARAMv2 (const QString &p)
 

Protected Attributes

QString m_name
 
MythHTTPMetaServicem_staticMetaService { nullptr }
 
HTTPRequest2 m_request {nullptr}
 

Detailed Description

This is the base class for a service whose public signals and slots are exported as a publicly accessible web interface.

Definition at line 19 of file mythhttpservice.h.

Constructor & Destructor Documentation

◆ MythHTTPService()

MythHTTPService::MythHTTPService ( MythHTTPMetaService MetaService)
explicit

Definition at line 16 of file mythhttpservice.cpp.

◆ ~MythHTTPService()

MythHTTPService::~MythHTTPService ( )
overridedefault

Member Function Documentation

◆ Create()

template<class T >
static HTTPServicePtr MythHTTPService::Create ( )
inlinestatic

Definition at line 24 of file mythhttpservice.h.

◆ HTTPRequest()

HTTPResponse MythHTTPService::HTTPRequest ( const HTTPRequest2 Request)
virtual

Respond to a valid HTTPRequest.

Todo:
Error message always send an HTML version of the error message. This should probably be context specific.

Definition at line 27 of file mythhttpservice.cpp.

◆ Name()

QString & MythHTTPService::Name ( )

◆ HAS_PARAMv2()

bool MythHTTPService::HAS_PARAMv2 ( const QString &  p)
inlineprotected

Member Data Documentation

◆ m_name

QString MythHTTPService::m_name
protected

Definition at line 33 of file mythhttpservice.h.

Referenced by Name().

◆ m_staticMetaService

MythHTTPMetaService* MythHTTPService::m_staticMetaService { nullptr }
protected

Definition at line 34 of file mythhttpservice.h.

Referenced by HTTPRequest().

◆ m_request

HTTPRequest2 MythHTTPService::m_request {nullptr}
protected

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