Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Static Private Attributes

Fastcgipp::ManagerPar Class Reference

General task and protocol management class. More...

#include <manager.hpp>

Inheritance diagram for Fastcgipp::ManagerPar:
Fastcgipp::Manager< T >

List of all members.

Classes

class  Tasks
 Queue type for pending tasks. More...

Public Member Functions

 ManagerPar (int fd, const boost::function< void(Protocol::FullId, Message)> &sendMessage_)
 Construct from a file descriptor.
 ~ManagerPar ()
void stop ()
 Halter for the handler() function.
void setupSignals ()
 Configure the handlers for POSIX signals.

Protected Member Functions

void localHandler (Protocol::FullId id)
 Handles management messages.

Protected Attributes

Transceiver transceiver
 Handles low level communication with the other side.
Tasks tasks
 Queue for pending tasks.
std::queue< Messagemessages
 A queue of messages for the manager itself.
bool asleep
 Indicated whether or not the manager is currently in sleep mode.
boost::mutex sleepMutex
 Mutex to make accessing asleep thread safe.
pthread_t threadId
 The pthread id of the thread the handler() function is operating in.
bool stopBool
 Boolean value indicating that handler() should halt.
boost::mutex stopMutex
 Mutex to make stopBool thread safe.
bool terminateBool
 Boolean value indication that handler() should terminate.
boost::mutex terminateMutex
 Mutex to make terminateMutex thread safe.

Private Member Functions

void terminate ()
 Terminator for the handler() function.

Static Private Member Functions

static void signalHandler (int signum)
 General function to handler POSIX signals.

Static Private Attributes

static ManagerParinstance = 0
 Pointer to the Manager object.

Detailed Description

General task and protocol management class.

Handles all task and protocol management, creation/destruction of requests and passing of messages to requests. The template argument should be a class type derived from the Request class with at least the response() function defined. To operate this class all that needs to be done is creating an object and calling handler() on it.

Template Parameters:
TClass that will handle individual requests. Should be derived from the Request class.

Definition at line 56 of file manager.hpp.


Constructor & Destructor Documentation

Fastcgipp::ManagerPar::ManagerPar ( int  fd,
const boost::function< void(Protocol::FullId, Message)> &  sendMessage_ 
)

Construct from a file descriptor.

The only piece of data required to construct a Manager object is a file descriptor to listen on for incoming connections. By default mod_fastcgi sets up file descriptor 0 to do this so it is the value passed by default to the constructor. The only time it would be another value is if an external FastCGI server was defined.

Parameters:
[in]fdFile descriptor to listen on.
[in]sendMessage_Function Transceiver should use to communicate with Manager.

Definition at line 6 of file manager.cpp.

References instance, and setupSignals().

Fastcgipp::ManagerPar::~ManagerPar (  ) [inline]

Definition at line 72 of file manager.hpp.

References instance.


Member Function Documentation

void Fastcgipp::ManagerPar::localHandler ( Protocol::FullId  id ) [protected]

Handles management messages.

This function is called by handler() in the case that a management message is recieved. Although the request id of a management record is always 0, the Protocol::FullId associated with the message is passed to this function to keep track of it's associated file descriptor.

Parameters:
[in]idFullId associated with the messsage.

Definition at line 47 of file manager.cpp.

References Fastcgipp::Block::data, Fastcgipp::Message::data, Fastcgipp::Protocol::GET_VALUES, Fastcgipp::Protocol::maxConnsReply, Fastcgipp::Protocol::maxReqsReply, Fastcgipp::Protocol::mpxsConnsReply, Fastcgipp::Protocol::processParamHeader(), Fastcgipp::Protocol::UNKNOWN_TYPE, and Fastcgipp::Protocol::version.

void Fastcgipp::ManagerPar::setupSignals (  )

Configure the handlers for POSIX signals.

By calling this function appropriate handlers will be set up for SIGPIPE, SIGUSR1 and SIGTERM. It is called by default upon construction of a Manager object. Should the user want to override these handlers, it should be done post-construction.

See also:
signalHandler()

Definition at line 37 of file manager.cpp.

References signalHandler().

Referenced by ManagerPar().

void Fastcgipp::ManagerPar::signalHandler ( int  signum ) [static, private]

General function to handler POSIX signals.

Definition at line 20 of file manager.cpp.

Referenced by setupSignals().

void Fastcgipp::ManagerPar::stop (  )

Halter for the handler() function.

This function is intended to be called from a thread separate from the handler() in order to halt it. It should also be called by a signal handler in the case of of a SIGTERM. Once handler() has been halted it may be re-called to pick up exactly where it left off without any data loss.

See also:
setupSignals()
signalHandler()

Definition at line 14 of file manager.cpp.

void Fastcgipp::ManagerPar::terminate (  ) [inline, private]

Terminator for the handler() function.

This function is intended to be called from a signal handler in the case of of a SIGUSR1. It is similar to stop() except that handler() will wait until all requests are complete before halting.

See also:
setupSignals()
signalHandler()

Definition at line 8 of file manager.cpp.


Member Data Documentation

Indicated whether or not the manager is currently in sleep mode.

Definition at line 127 of file manager.hpp.

Pointer to the Manager object.

Definition at line 156 of file manager.hpp.

Referenced by ManagerPar(), and ~ManagerPar().

std::queue<Message> Fastcgipp::ManagerPar::messages [protected]

A queue of messages for the manager itself.

Definition at line 113 of file manager.hpp.

boost::mutex Fastcgipp::ManagerPar::sleepMutex [protected]

Mutex to make accessing asleep thread safe.

Definition at line 129 of file manager.hpp.

Boolean value indicating that handler() should halt.

See also:
stop()

Definition at line 141 of file manager.hpp.

boost::mutex Fastcgipp::ManagerPar::stopMutex [protected]

Mutex to make stopBool thread safe.

Definition at line 143 of file manager.hpp.

Queue for pending tasks.

This contains a queue of Protocol::FullId that need their handlers called.

Definition at line 110 of file manager.hpp.

Boolean value indication that handler() should terminate.

See also:
terminate()

Definition at line 148 of file manager.hpp.

boost::mutex Fastcgipp::ManagerPar::terminateMutex [protected]

Mutex to make terminateMutex thread safe.

Definition at line 150 of file manager.hpp.

pthread_t Fastcgipp::ManagerPar::threadId [protected]

The pthread id of the thread the handler() function is operating in.

Although this library is intended to be used with boost::thread and not pthread, the underlying pthread id of the handler() function is needed to call pthread_kill() when sleep is to be interrupted.

Definition at line 135 of file manager.hpp.

Handles low level communication with the other side.

Definition at line 98 of file manager.hpp.


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