fastcgi++
A C++ FastCGI/Web API
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Fastcgipp::Protocol::BeginRequest Struct Reference

The body for FastCGI records with a RecordType of BEGIN_REQUEST. More...

#include <fastcgi++/protocol.hpp>

Public Member Functions

bool kill () const
 Get keep alive value from the record body. More...
 

Public Attributes

BigEndian< Rolerole
 Role. More...
 
uint8_t flags
 Flag value. More...
 
uint8_t reserved [5]
 Reserved for future use and body padding. More...
 

Static Public Attributes

static const int keepConnBit = 1
 Flag bit representing the keep alive value. More...
 

Detailed Description

The body for FastCGI records with a RecordType of BEGIN_REQUEST.

This structure defines the body used in FastCGI BEGIN_REQUEST records. It can be casted from raw 8 byte blocks of data and received as is. A BEGIN_REQUEST record is received when the other side wished to make a new request.

Date
May 11, 2016
Author
Eddie Carle <eddie.nosp@m.@isa.nosp@m.tec.c.nosp@m.a>

Definition at line 323 of file protocol.hpp.

Member Function Documentation

◆ kill()

bool Fastcgipp::Protocol::BeginRequest::kill ( ) const
inline

Get keep alive value from the record body.

If this value is false, the socket should be closed on our side when the request is complete. If true, the other side will close the socket when done and potentially reuse the socket and multiplex other requests on it.

Returns
Boolean value as to whether or not the connection is kept alive.

Definition at line 338 of file protocol.hpp.

References flags, and keepConnBit.

Referenced by Fastcgipp::Manager_base::push().

Member Data Documentation

◆ flags

uint8_t Fastcgipp::Protocol::BeginRequest::flags

Flag value.

Definition at line 347 of file protocol.hpp.

Referenced by kill().

◆ keepConnBit

const int Fastcgipp::Protocol::BeginRequest::keepConnBit = 1
static

Flag bit representing the keep alive value.

Definition at line 326 of file protocol.hpp.

Referenced by kill().

◆ reserved

uint8_t Fastcgipp::Protocol::BeginRequest::reserved[5]

Reserved for future use and body padding.

Definition at line 350 of file protocol.hpp.

◆ role

BigEndian<Role> Fastcgipp::Protocol::BeginRequest::role

Role.

Definition at line 344 of file protocol.hpp.

Referenced by Fastcgipp::Manager_base::push().


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