bes  Updated for version 3.20.6
StandAloneClient Class Reference

#include <StandAloneClient.h>

Collaboration diagram for StandAloneClient:
Collaboration graph

Public Member Functions

virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
void executeClientCommand (const std::string &cmd)
 Executes a client side command. More...
 
void executeCommands (const std::string &cmd_list, int repeat)
 Send the command(s) specified to the BES server after wrapping in request document. More...
 
void executeCommands (std::ifstream &inputFile, int repeat)
 Sends the xml request document from the specified file to the server. More...
 
void interact ()
 An interactive BES client that takes BES requests on the command line. More...
 
void setOutput (std::ostream *strm, bool created)
 Set the output stream for responses from the BES server. More...
 

Detailed Description

StandAloneClient is an object that handles the connection to, sending requests to, and receiving response from a specified OpenDAP server running either on this machine or another machine.

Requests to the OpenDAP server can be taken in different ways by the StandAloneClient object.

  • One request, ending with a semicolon.
  • Multiple requests, each ending with a semicolon.
  • Requests listed in a file, each request can span multiple lines in the file and there can be more than one request per line. Each request ends with a semicolon.
  • Interactive mode where the user inputs requests on the command line, each ending with a semicolon, with multiple requests allowed per line.

Response from the requests can sent to any File or OutputStream as specified by using the setOutput methods. If no output is specified using the setOutput methods thent he output is ignored.

Thread safety of this object has not yet been determined.

Author
Patrick West <A * HREF="mailto:pwest@hao.ucar.edu">pwest.nosp@m.@hao.nosp@m..ucar.nosp@m..edu

Definition at line 69 of file StandAloneClient.h.

Member Function Documentation

◆ dump()

void StandAloneClient::dump ( std::ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance

Parameters
strmC++ i/o stream to dump the information to

Implements BESObj.

Definition at line 480 of file StandAloneClient.cc.

◆ executeClientCommand()

void StandAloneClient::executeClientCommand ( const std::string &  cmd)

Executes a client side command.

Client side commands include client suppress; client output to screen; client output to <filename>; client load <filename>;

Parameters
cmdThe BES client side command to execute
See also
BESError

Definition at line 152 of file StandAloneClient.cc.

◆ executeCommands() [1/2]

void StandAloneClient::executeCommands ( const std::string &  cmd_list,
int  repeat 
)

Send the command(s) specified to the BES server after wrapping in request document.

This takes a command or set of commands from the command line, wraps it in the proper request document, and sends it to the server.

The response is written to the output stream if one is specified, otherwise the output is ignored.

Parameters
cmd_listThe BES commands to send to the BES server
repeatNumber of times to repeat the command
Exceptions
BESErrorThrown if there is a problem sending any of the request to the server or a problem receiving any of the responses from the server.
See also
BESError

Definition at line 301 of file StandAloneClient.cc.

◆ executeCommands() [2/2]

void StandAloneClient::executeCommands ( std::ifstream &  inputFile,
int  repeat 
)

Sends the xml request document from the specified file to the server.

The requests do not have to be one per line but can span multiple lines and there can be more than one command per line.

The response is written to the output stream if one is specified, otherwise the output is ignored.

Parameters
istrmThe file holding the xml request document
repeatNumber of times to repeat the series of commands from the file.
Exceptions
BESErrorThrown if there is a problem opening the file to read, reading the request document from the file, sending the request document to the server or a problem receiving any of the responses from the server.
See also
File
BESError

Definition at line 340 of file StandAloneClient.cc.

◆ interact()

void StandAloneClient::interact ( )

An interactive BES client that takes BES requests on the command line.

There can be more than one command per line, but commands cannot span multiple lines. The user will be prompted to enter a new BES request.

OpenDAPClient:

The response is written to the output stream if one is specified, otherwise the output is ignored.

Exceptions
BESErrorThrown if there is a problem sending any of the requests to the server or a problem receiving any of the responses from the server.
See also
BESError

Definition at line 371 of file StandAloneClient.cc.

◆ setOutput()

void StandAloneClient::setOutput ( std::ostream *  strm,
bool  created 
)

Set the output stream for responses from the BES server.

Specify where the response output from your BES request will be sent. Set to null if you wish to ignore the response from the BES server.

Parameters
strman OutputStream specifying where to send responses from the BES server. If null then the output will not be output but will be thrown away.
createdtrue of the passed stream was created and can be deleted either by being replaced ro in the destructor
Exceptions
BESErrorcatches any problems with opening or writing to the output stream and creates a BESError
See also
OutputStream
BESError

Definition at line 128 of file StandAloneClient.cc.


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