bsls::PreconditionsHandler Class Reference

#include <bsls_preconditions.h>

Public Types
typedef void(*	PreconditionHandlerType) ()

Static Public Member Functions
static PreconditionHandlerType	getBeginHandler ()
	Return the previously installed s_beginHandler.
static PreconditionHandlerType	getEndHandler ()
	Return the previously installed s_endHandler.
static void	installHandlers (PreconditionHandlerType beginHandler, PreconditionHandlerType endHandler)
static void	invokeBeginHandler ()
	Invoke the previously installed s_beginHandler function.
static void	invokeEndHandler ()
	Invoke the previously installed s_endHandler function.
static void	noOpHandler ()
	Do nothing.

Detailed Description

This utility class maintains pointers containing the addresses of functions invoked by the BSLS_PRECONDITIONS_BEGIN and BSLS_PRECONDITIONS_END macros, and provides methods to manipulate and utilize those functions.

See bsls_preconditions

Member Typedef Documentation

PreconditionHandlerType

typedef void(* bsls::PreconditionsHandler::PreconditionHandlerType) ()

PreconditionHandlerType is an alias for a pointer to a function returning void and taking no parameters.

Member Function Documentation

getBeginHandler()

static PreconditionHandlerType bsls::PreconditionsHandler::getBeginHandler ( )

static

getEndHandler()

static PreconditionHandlerType bsls::PreconditionsHandler::getEndHandler ( )

static

installHandlers()

static void bsls::PreconditionsHandler::installHandlers ( PreconditionHandlerType  beginHandler, PreconditionHandlerType  endHandler  )

static

Store the specified beginHandler and endHandler function pointers to the static member variables.

invokeBeginHandler()

static void bsls::PreconditionsHandler::invokeBeginHandler ( )

static

invokeEndHandler()

static void bsls::PreconditionsHandler::invokeEndHandler ( )

static

noOpHandler()

static void bsls::PreconditionsHandler::noOpHandler ( )

static

---

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

• bsls_preconditions.h