HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions
rwsf::ServiceShutdownException Class Reference

Shuts down a service and sends an error message. More...

#include <rwsf/webservice/except.h>

Inheritance diagram for rwsf::ServiceShutdownException:

Public Member Functions

 ServiceShutdownException ()
 ServiceShutdownException (const char *msg)
virtual ~ServiceShutdownException () throw ()
virtual Exceptionclone (void) const
virtual void raise (void) const
- Public Member Functions inherited from rwsf::Exception
 Exception (const ExceptionInfo &eInfo)
 Exception (const char *msg)
 Exception (const std::string &msg)
 Exception (const rwsf::ExceptionInfo &eInfo, const LocalizedMessage &msg)
 Exception (const Exception &)
virtual ~Exception () throw ()
const char * getFileName () const
const char * getFunctionName () const
unsigned long getLineNumber () const
virtual bool operator!= (const Exception exc2)
Exceptionoperator= (const Exception &m)
virtual bool operator== (const Exception exc2)
virtual const char * what () const throw ()

Additional Inherited Members

Detailed Description

Class rwsf::ServiceShutdownException provides a means to shut down a service from within the service implementation.

In the case of HTTP and HTTPS transports, any request that results in this server exception, the server sends a 500 "Internal Server Error" response back.

For the RWSF Agent, the service is taken out of service and subsequent requests yield the "Not Found" 400 error, which is standard Agent behavior.

For a standalone HTTP or HTTPS server, the listener shuts down and subsequent requests fail. The thread that contains the listener object can then call the method isStopped() to see if has been shut down.

This is the only exception class in webservices. All other exception classes are in the RWSF Core Library.

Constructor & Destructor Documentation

rwsf::ServiceShutdownException::ServiceShutdownException ( )

Default constructor. Creates an exception with the message "Service Shutdown".

rwsf::ServiceShutdownException::ServiceShutdownException ( const char *  msg)

Creates an exception with the message msg.

virtual rwsf::ServiceShutdownException::~ServiceShutdownException ( )
throw (

Default destructor.

Member Function Documentation

virtual Exception* rwsf::ServiceShutdownException::clone ( void  ) const

Creates a new copy of self on the heap. Overridden in derived classes to construct an instance of the correct derived type. It is up to the user to ensure that the returned Exception object is deleted.

Reimplemented from rwsf::Exception.

virtual void rwsf::ServiceShutdownException::raise ( void  ) const

Throws self. Overridden in derived classes to throw the correct derived type.

Reimplemented from rwsf::Exception.

Copyright © 2020 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.