Interfície cap a un script CGI. Més...

#include <CGI.h>

Diagrama d'Herència per a ProgramaCGI:

Tipus Públics
typedef boost::asio::ip::tcp::socket	socket_tcp
typedef std::pair< std::string, std::string >	tipus_capsalera
typedef std::vector < tipus_capsalera >	tipus_capsaleres
typedef std::shared_ptr < Transformacio >	transformacio_ptr

Mètodes públics
	ProgramaCGI (const PeticioHTTP &peticio, const boost::filesystem::path &arrel_servidor) throw (ErrorRutaInexistent)
	ProgramaCGI (const ProgramaCGI &c)
virtual tipus_capsaleres	capsaleres () const
	Llista de capçaleres específiques del cos a afegir a la resposta.
virtual void	envia (boost::asio::ip::tcp::socket &socket) const throw (std::runtime_error)
	Envia el cos del missatge.
virtual void	envia_eom (socket_tcp &socket) const throw (ErrorEscrivintEnSocket)
	Envia el final del missatge.
virtual std::string	html () const
	Contingut.
ProgramaCGI &	operator= (const ProgramaCGI &c)
const PeticioHTTP &	peticio () const
virtual bool	pot_generar_capsaleres () const
	Indica si el contingut pot generar capçaleres HTTP.

Mètodes Protegits
bool	chunked_ok () const
	Comprova si el client accepta chunked.
const std::string &	content_encoding () const
	`Content-Encoding` acceptat per el client
bool	deflate_ok () const
	Comprova si el client accepta deflate.
virtual size_t	envia (socket_tcp &socket, const std::string &buffer) const throw (ErrorEscrivintEnSocket)
	Envia una cadena sencera.
size_t	envia_literal (socket_tcp &socket, const std::string &buffer) const throw (ErrorEscrivintEnSocket)
	Envia una cadena sense aplicar la codificació
const std::string &	transfer_encoding () const
	`Transfer-Endocing` acceptat per el client
transformacio_ptr	transformacio () const
	Genera una transformació acceptable per el client.

Tipus Privats
enum	{ MIDA_BUFFER = 8<<10 }

Atributs Privats
boost::filesystem::path	arrel_servidor_
boost::filesystem::path	ruta_

Descripció Detallada

Interfície cap a un script CGI.

Definició a la línia 47 del fitxer CGI.h.

Documentació de les Definicions de Tipus Membre

typedef boost::asio::ip::tcp::socket socket_tcp

inherited

Definició a la línia 86 del fitxer CosResposta.h.

typedef std::pair<std::string, std::string> tipus_capsalera

inherited

Definició a la línia 83 del fitxer CosResposta.h.

typedef std::vector<tipus_capsalera> tipus_capsaleres

inherited

Definició a la línia 84 del fitxer CosResposta.h.

typedef std::shared_ptr<Transformacio> transformacio_ptr

inherited

Definició a la línia 85 del fitxer CosResposta.h.

Documentació de les Enumeracions Membre

anonymous enum

private

Valors de les Enumeracions:

MIDA_BUFFER

Definició a la línia 77 del fitxer CGI.h.

Documentació del Constructor i el Destructor

ProgramaCGI	(	const PeticioHTTP &	peticio,
		const boost::filesystem::path &	arrel_servidor
	)		throw (ErrorRutaInexistent)

explicit

Precondició: peticio.ruta().ruta() es correspon amb un fitxer llegible i executable

Definició a la línia 66 del fitxer CGI.cc.

Referències tfc::portabilitat::permis_execucio().

ProgramaCGI ( const ProgramaCGI & c )

inline

Definició a la línia 55 del fitxer CGI.h.

Documentació de les Funcions Membre

CosResposta::tipus_capsaleres capsaleres ( ) const

virtualinherited

Llista de capçaleres específiques del cos a afegir a la resposta.

Per defecte, retorna les capçaleres relatives a les transformacions aplicables.

Reimplementat a CosPaginaError, Recurs i AutoIndex.

Definició a la línia 78 del fitxer CosResposta.cc.

bool chunked_ok ( ) const

inlineprotectedinherited

Comprova si el client accepta chunked.

Definició a la línia 185 del fitxer CosResposta.h.

Referències CosResposta::chunked_ok_.

const std::string& content_encoding ( ) const

inlineprotectedinherited

Content-Encoding acceptat per el client

Definició a la línia 193 del fitxer CosResposta.h.

Referències CosResposta::ce_.

bool deflate_ok ( ) const

inlineprotectedinherited

Comprova si el client accepta deflate.

Definició a la línia 182 del fitxer CosResposta.h.

Referències CosResposta::deflate_ok_.

void envia ( boost::asio::ip::tcp::socket & socket ) const throw (std::runtime_error)

virtual

Envia el cos del missatge.

Per fer:: XXX: Utilitzar algun tipus de "sink" potser seria preferible

Remarca: Cal cridar envia_eom() després

Reimplementat de RecursDinamic.

Definició a la línia 84 del fitxer CGI.cc.

Referències tfc::commit(), tfc::log(), tfc::NivellError, tfc::NomTipusPeticioHTTP::nom() i tfc::NomTipusPeticioHTTP::tipus().

size_t envia	(	socket_tcp &	socket,
		const std::string &	buffer
	)		const throw (ErrorEscrivintEnSocket)

protectedvirtualinherited

Envia una cadena sencera.

Paràmetres

socket	Socket on escriure
buffer	Cadena a escriure

Precondició: Socket connectat FIXME: <- Cal? Comprovar?

Excepcions

ErrorEscrivintEnSocket si falla l'enviament de dades

Remarca: S'utilitza la codificació definida

Definició a la línia 39 del fitxer CosResposta.cc.

void envia_eom ( socket_tcp & socket ) const throw (ErrorEscrivintEnSocket)

virtualinherited

Envia el final del missatge.

Remarca: Quan s'emprea una codificació cal finalitzar els missatges.

Definició a la línia 70 del fitxer CosResposta.cc.

size_t envia_literal	(	socket_tcp &	socket,
		const std::string &	buffer
	)		const throw (ErrorEscrivintEnSocket)

protectedinherited

Envia una cadena sense aplicar la codificació

Definició a la línia 54 del fitxer CosResposta.cc.

virtual std::string html ( ) const

inlinevirtual

Contingut.

Remarca: Per evitar col·locar tot en memòria cal sobrecarregar envia()

Implementa RecursDinamic.

Definició a la línia 68 del fitxer CGI.h.

Referències FITXER_I_LINIA_.

ProgramaCGI& operator= ( const ProgramaCGI & c )

inline

Definició a la línia 61 del fitxer CGI.h.

Referències ProgramaCGI::arrel_servidor_ i ProgramaCGI::ruta_.

const PeticioHTTP& peticio ( ) const

inlineinherited

Definició a la línia 160 del fitxer CosResposta.h.

Referències CosResposta::peticio_.

virtual bool pot_generar_capsaleres ( ) const

inlinevirtual

Indica si el contingut pot generar capçaleres HTTP.

Per a alguns tipus de recursos dinàmics, com ara scripts, és dessitjable poder modificar les capçaleres.

Remarca: Un CosResposta que generi capçaleres haurà d'enviar opcionalment les capçaleres generades, seguides d'un "CRLF" abans del contingut pròpiament dit per a marcar el final de les capçaleres.; Les capçaleres retornades amb capsaleres() les afegirà el Servidor. L'ús de pot_generar_capsaleres() no hi està relacionat.

Reimplementat de CosResposta.

Definició a la línia 72 del fitxer CGI.h.

const std::string& transfer_encoding ( ) const

inlineprotectedinherited

Transfer-Endocing acceptat per el client

Definició a la línia 196 del fitxer CosResposta.h.

Referències CosResposta::te_.

transformacio_ptr transformacio ( ) const

inlineprotectedinherited

Genera una transformació acceptable per el client.

Definició a la línia 190 del fitxer CosResposta.h.

Referències CosResposta::trans_.