bes
Updated for version 3.19.1
|
response handler that set context within the BES as a simple name/value pair More...
#include <BESSetContextResponseHandler.h>
Public Member Functions | |
BESSetContextResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object More... | |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command to set context within the BES More... | |
virtual string | get_name () const |
return the name of this response object More... | |
virtual BESResponseObject * | get_response_object () |
return the current response object More... | |
virtual BESResponseObject * | set_response_object (BESResponseObject *o) |
replaces the current response object with the specified one, returning the current response object More... | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object More... | |
Static Public Member Functions | |
static BESResponseHandler * | SetContextResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
response handler that set context within the BES as a simple name/value pair
This response handler set context withiin the BES using the context name and the context value as specified in the command:
set context <context_name> to <context_value>;
It has a silent return ... nothing is returned unless there is an exception condition.
Definition at line 53 of file BESSetContextResponseHandler.h.
|
virtual |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
Definition at line 110 of file BESSetContextResponseHandler.cc.
|
virtual |
executes the command to set context within the BES
Using a context name and a context value, set that context in the context manager.
The response object is silent, i.e. nothing is returned to the client unless there is an exception condition.
dhi | structure that holds request and response information |
BESSyntaxUserError | if no context name was given object |
Implements BESResponseHandler.
Definition at line 64 of file BESSetContextResponseHandler.cc.
|
inlinevirtualinherited |
return the name of this response object
This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...
Definition at line 156 of file BESResponseHandler.h.
|
virtualinherited |
return the current response object
Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.
Definition at line 53 of file BESResponseHandler.cc.
|
virtualinherited |
replaces the current response object with the specified one, returning the current response object
This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.
The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.
o | new response object used to replace the current one |
Definition at line 59 of file BESResponseHandler.cc.
|
virtual |
transmit the response object built by the execute command using the specified transmitter object
If a response object was built then transmit it as text using the specified transmitter object.
transmitter | object that knows how to transmit specific basic types |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
Definition at line 95 of file BESSetContextResponseHandler.cc.