IIPResponse Class Reference

Class to handle non-image IIP responses including errors. More...

#include <IIPResponse.h>

Public Member Functions
	IIPResponse ()
	Constructor.
void	setProtocol (const std::string &p)
	Set the IIP protocol version.
void	setMimeType (const std::string &m)
	Set the Mime Type.
void	setLastModified (const std::string &m)
	Set the Last Modified header.
void	setContentDisposition (const std::string &name, const std::string &type="inline")
	Set Content Disposition header.
void	addResponse (const std::string &r)
	Add a response string.
void	addResponse (const char *c)
	Add a response string.
void	addResponse (const char *c, int a)
	Add a response string.
void	addResponse (std::string c, const std::string &a)
	Add a response string.
void	addResponse (const char *c, int a, int b)
	Add a response string.
void	setError (const std::string &code, const std::string &arg)
	Set an error.
void	setCORS (const std::string &c)
	Set CORS setting.
std::string	getCORS ()
	Get CORS setting.
void	setCacheControl (const std::string &c)
	Set Cache-Control value.
void	setCachability (bool cachable)
	Set whether the response should be cached.
bool	cachable ()
	Is response cachable?
std::string	getCacheControl ()
	Get Cache-Control value.
void	setStatus (const std::string &s)
	Set HTTP status code.
std::string	formatResponse ()
	Get a formatted string to send back.
bool	isSet ()
	Indicate whether this object has had any arguments passed to it.
bool	errorIsSet ()
	Indicate whether we have an error message.
void	setImageSent ()
	Set the sent flag indicating that some sort of response has been sent.
bool	imageSent ()
	Indicate whether a response has been sent.
std::string	getAdvert ()
	Display our advertising banner ;-)
std::string	createHTTPHeader (const std::string &mimeType, const std::string &timeStamp, unsigned int contentLength=0)
	Convenience function to generate HTTP header fields.
std::string	getHeaderResponse (bool addCORS=false)
	Convenience function to generate a header-only response.

Detailed Description

Class to handle non-image IIP responses including errors.

Member Function Documentation

addResponse() [1/5]

void IIPResponse::addResponse

(

const char *

c

)

Add a response string.

Parameters

c	response string

addResponse() [2/5]

void IIPResponse::addResponse	(	const char *	c,
		int	a
	)

Add a response string.

Parameters

c	response string
a	integer value

addResponse() [3/5]

void IIPResponse::addResponse	(	const char *	c,
		int	a,
		int	b
	)

Add a response string.

Parameters

c	response string
a	integer value
b	another integer value

addResponse() [4/5]

void IIPResponse::addResponse

(

const std::string &

r

)

Add a response string.

Parameters

r	response string

Referenced by OBJ::run().

addResponse() [5/5]

void IIPResponse::addResponse	(	std::string	c,
		const std::string &	a
	)

Add a response string.

Parameters

c	response string
a	string reply

cachable()

bool IIPResponse::cachable ( )

inline

Is response cachable?

Returns

Whether response should be cached

Referenced by setCachability().

createHTTPHeader()

string IIPResponse::createHTTPHeader	(	const std::string &	mimeType,
		const std::string &	timeStamp,
		unsigned int	contentLength = 0
	)

Convenience function to generate HTTP header fields.

Parameters

mimeType	MIME type of output
timeStamp	formatted timestamp
contentLength	optional Content-Length value

Returns

formatted HTTP header

Referenced by Zoomify::run(), SPECTRA::run(), PFL::run(), DeepZoom::run(), IIIF::run(), CVT::send(), and JTL::send().

getAdvert()

string IIPResponse::getAdvert

(

)

Display our advertising banner ;-)

Returns

HTML string

getHeaderResponse()

string IIPResponse::getHeaderResponse

(

bool

addCORS = false

)

Convenience function to generate a header-only response.

Parameters

addCORS

whether a CORS header should be added

Returns

formatted HTTP header string

setCachability()

void IIPResponse::setCachability ( bool  cachable )

inline

Set whether the response should be cached.

Parameters

cachable

Whether this reponse should be cached or not

References cachable().

Referenced by IIIF::run().

setCacheControl()

void IIPResponse::setCacheControl ( const std::string &  c )

inline

Set Cache-Control value.

Parameters

c	Cache-Control setting

Referenced by IIIF::run().

setContentDisposition()

void IIPResponse::setContentDisposition ( const std::string &  name, const std::string &  type = "inline"  )

inline

Set Content Disposition header.

Parameters

name	file name for Content-disposition header
type	content type (inline by default)

Referenced by CVT::send().

setCORS()

void IIPResponse::setCORS ( const std::string &  c )

inline

Set CORS setting.

Parameters

c

setting

setError()

void IIPResponse::setError	(	const std::string &	code,
		const std::string &	arg
	)

Set an error.

Parameters

code	error code
arg	the argument supplied by the client

Referenced by Task::checkImage(), OBJ::run(), and FIF::run().

setLastModified()

void IIPResponse::setLastModified ( const std::string &  m )

inline

Set the Last Modified header.

Parameters

m	Last modified date as a HTTP RFC 1123 formatted timestamp

Referenced by FIF::run().

setMimeType()

void IIPResponse::setMimeType ( const std::string &  m )

inline

Set the Mime Type.

Parameters

m

Mime Type

Referenced by OBJ::run().

setProtocol()

void IIPResponse::setProtocol ( const std::string &  p )

inline

Set the IIP protocol version.

Parameters

p	IIP protocol version

setStatus()

void IIPResponse::setStatus ( const std::string &  s )

inline

Set HTTP status code.

Parameters

s	HTTP status code string

---

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

• IIPResponse.h
• IIPResponse.cc