Rogue Wave web site:  Home Page  |  Main Documentation Page

rwsf::ServletUnavailableException Class Reference
[Exceptions]

Throws an rwsf::ServletUnavailableException. More...

#include <rwsf/servlet/except.h>

Inheritance diagram for rwsf::ServletUnavailableException:

List of all members.

Public Member Functions
	ServletUnavailableException (const char *msg)
	ServletUnavailableException (const char *msg, int seconds)
	~ServletUnavailableException () throw ()
int	getUnavailableSeconds () const
bool	isPermanent () const

---

Detailed Description

A servlet throws rwsf::ServletUnavailableException to indicate to the Agent that the servlet cannot process requests.

---

Constructor & Destructor Documentation

rwsf::ServletUnavailableException::ServletUnavailableException

(

const char *

msg

)

Constructs a new exception with the given msg. This exception notifies the Agent that the servlet is not available to receive requests. An exception created with this constructor returns true from isPermanent().

rwsf::ServletUnavailableException::ServletUnavailableException	(	const char *	msg,
		int	seconds
	)

Constructs a new exception with the given msg and the number of seconds that the servlet will be unavailable. An rwsf::ServletUnavailableException that contains a number of seconds indicates that the failure is temporary. The Agent may either remove the servlet or suspend requests to the servlet for at least the number of seconds specified.

rwsf::ServletUnavailableException::~ServletUnavailableException

(

)

throw ()

Destructor.

---

Member Function Documentation

int rwsf::ServletUnavailableException::getUnavailableSeconds

(

)

const

Returns the number of seconds this servlet is unavailable. Returns -1 if the servlet is permanently unavailable.

bool rwsf::ServletUnavailableException::isPermanent

(

)

const

Returns true if this servlet is permanently unavailable, otherwise returns false.