bsls::PreconditionsHandler Class Reference

#include <bsls_preconditions.h>

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

Public Types
typedef void(*	PreconditionHandlerType) ()

Static Public Member Functions
static PreconditionHandlerType	getBeginHandler ()
static PreconditionHandlerType	getEndHandler ()
static void	installHandlers (PreconditionHandlerType beginHandler, PreconditionHandlerType endHandler)
static void	invokeBeginHandler ()
static void	invokeEndHandler ()
static void	noOpHandler ()

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

Return the previously installed s_beginHandler.

getEndHandler()

static PreconditionHandlerType bsls::PreconditionsHandler::getEndHandler ( )

static

Return the previously installed s_endHandler.

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

Invoke the previously installed s_beginHandler function.

invokeEndHandler()

static void bsls::PreconditionsHandler::invokeEndHandler ( )

static

Invoke the previously installed s_endHandler function.

noOpHandler()

static void bsls::PreconditionsHandler::noOpHandler ( )

static

Do nothing.

---

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

• bsls_preconditions.h