API New Year  1.0
API for the project ZIA, EPITECH 2017.
ApiNewYear::IHttpRequest Class Referenceabstract

Base class representing the minimum information needed for each HTTP Request. More...

#include <IHttpRequest.h>

Inheritance diagram for ApiNewYear::IHttpRequest:
Inheritance graph
Collaboration diagram for ApiNewYear::IHttpRequest:
Collaboration graph

Public Member Functions

virtual const std::string & getUri (void) const =0
 Getter for URI. More...
 
virtual void setUri (const std::string &uri)=0
 Setter for URI. More...
 
virtual const std::string & getMethod (void) const =0
 Getter for Method. More...
 
virtual void setMethod (const std::string &method)=0
 Setter for Method. More...
 
- Public Member Functions inherited from ApiNewYear::IHttpQuery
virtual void setData (const std::string &data)=0
 Setter for Data. More...
 
virtual const std::string & getData (void) const =0
 Getter for Data. More...
 
virtual const std::map< std::string, std::string > & getHeaders (void) const =0
 Getter for map of headers. More...
 
virtual void addHeader (const std::string &key, const std::string &value)=0
 Add header to map of headers. More...
 
virtual void removeHeader (const std::string &key)=0
 Remove header from map of headers. More...
 

Detailed Description

Base class representing the minimum information needed for each HTTP Request.

Establishes the base architecture for all HTTP Requests used by the server.

Member Function Documentation

virtual const std::string& ApiNewYear::IHttpRequest::getMethod ( void  ) const
pure virtual

Getter for Method.

IHttpRequest get string Method used for Http Requests.

Returns
a constant string refernce containing the http method.
virtual const std::string& ApiNewYear::IHttpRequest::getUri ( void  ) const
pure virtual

Getter for URI.

IHttpRequest get string containing URI for HTTP Requests.

Returns
a constant string reference of the URI.
virtual void ApiNewYear::IHttpRequest::setMethod ( const std::string &  method)
pure virtual

Setter for Method.

IHttpRequest set string Method used for Http Requests.

Parameters
methoda constant string refernce of the http method used.
virtual void ApiNewYear::IHttpRequest::setUri ( const std::string &  uri)
pure virtual

Setter for URI.

IHttpRequest set string URI for HTTP Requests.

Parameters
aconstant string reference of the URI.

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