fastcgi++
Public Member Functions | Private Attributes
Fastcgipp::Protocol::EndRequest Class Reference

Data structure used as the body for FastCGI records with a RecordType of END_REQUEST. More...

#include <protocol.hpp>

List of all members.

Public Member Functions

void setAppStatus (int status)
 Set the requests return value.
void setProtocolStatus (ProtocolStatus status)
 Set the reason for termination.

Private Attributes

uint8_t appStatusB3
 Return value most significant byte.
uint8_t appStatusB2
 Return value second most significant byte.
uint8_t appStatusB1
 Return value third most significant byte.
uint8_t appStatusB0
 Return value least significant byte.
uint8_t protocolStatus
 Requests Status.
uint8_t reserved [3]
 Reseved for future use and body padding.

Detailed Description

Data structure used as the body for FastCGI records with a RecordType of END_REQUEST.

This structure defines the body used in FastCGI END_REQUEST records. It can be casted to raw 8 byte blocks of data and transmitted as is. An END_REQUEST record is sent when this side wishes to terminate a request. This can be simply because it is complete or because of a problem.

Definition at line 316 of file protocol.hpp.


Member Function Documentation

void Fastcgipp::Protocol::EndRequest::setAppStatus ( int  status)
inline

Set the requests return value.

This is an integer value representing what would otherwise be the return value in a normal CGI application.

Parameters:
[in]statusThe return value

Definition at line 326 of file protocol.hpp.

References appStatusB3, and Fastcgipp::Protocol::readBigEndian().

void Fastcgipp::Protocol::EndRequest::setProtocolStatus ( ProtocolStatus  status)
inline

Set the reason for termination.

This value is one of ProtocolStatus and represents the reason for termination.

Parameters:
[in]statusThe requests status

Definition at line 334 of file protocol.hpp.

References protocolStatus.


Member Data Documentation

uint8_t Fastcgipp::Protocol::EndRequest::appStatusB0
private

Return value least significant byte.

Definition at line 343 of file protocol.hpp.

uint8_t Fastcgipp::Protocol::EndRequest::appStatusB1
private

Return value third most significant byte.

Definition at line 341 of file protocol.hpp.

uint8_t Fastcgipp::Protocol::EndRequest::appStatusB2
private

Return value second most significant byte.

Definition at line 339 of file protocol.hpp.

uint8_t Fastcgipp::Protocol::EndRequest::appStatusB3
private

Return value most significant byte.

Definition at line 337 of file protocol.hpp.

Referenced by setAppStatus().

uint8_t Fastcgipp::Protocol::EndRequest::protocolStatus
private

Requests Status.

Definition at line 345 of file protocol.hpp.

Referenced by setProtocolStatus().

uint8_t Fastcgipp::Protocol::EndRequest::reserved[3]
private

Reseved for future use and body padding.

Definition at line 347 of file protocol.hpp.


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