bes Updated for version 3.20.13
|
#include <CmdClient.h>
Public Member Functions | |
void | brokenPipe () |
inform the server that there has been a borken pipe | |
virtual void | dump (std::ostream &strm) const |
dumps information about this object | |
bool | executeClientCommand (const std::string &cmd) |
Executes a client side command. | |
bool | executeCommands (const std::string &cmd, int repeat) |
Send the command(s) specified to the BES server after wrapping in request document. | |
bool | executeCommands (std::ifstream &inputFile, int repeat) |
Sends the xml request document from the specified file to the server. | |
bool | interact () |
An interactive BES client that takes BES requests on the command line. | |
bool | isConnected () |
return whether the client is connected to the BES | |
void | setOutput (std::ostream *strm, bool created) |
Set the output stream for responses from the BES server. | |
void | shutdownClient () |
Closes the connection to the OpeNDAP server and closes the output stream. | |
void | startClient (const std::string &host, int portVal, int timeout) |
Connect the BES client to the BES server. | |
void | startClient (const std::string &unixSocket, int timeout) |
Connect the BES client to the BES server using the unix socket. | |
CmdClient 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 CmdClient object.
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.
Definition at line 71 of file CmdClient.h.
|
inline |
Definition at line 84 of file CmdClient.h.
CmdClient::~CmdClient | ( | ) |
Definition at line 94 of file CmdClient.cc.
void CmdClient::brokenPipe | ( | ) |
inform the server that there has been a borken pipe
Definition at line 553 of file CmdClient.cc.
|
virtual |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Implements BESObj.
Definition at line 564 of file CmdClient.cc.
bool CmdClient::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>;
cmd | The BES client side command to execute |
Definition at line 198 of file CmdClient.cc.
Send the command(s) specified to the BES server after wrapping in request document.
This takes a string command or set of string commands from the command line, builds an xml document with the commands, and sends it to the server.
The response is written to the output stream if one is specified, otherwise the output is ignored.
cmd_list | The BES commands to send to the BES server |
repeat | Number of times to repeat the command |
BESError | Thrown if there is a problem sending any of the request to the server or a problem receiving any of the responses from the server. |
Definition at line 350 of file CmdClient.cc.
Sends the xml request document from the specified file to the server.
The file can contain only one xml request document and must be well formatted. If not, the server will respond with an exception
The response is written to the output stream if one is specified, otherwise the output is ignored.
istrm | The file holding the xml request document |
repeat | Number of times to repeat the series of commands from the file. |
BESError | Thrown 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. |
Definition at line 391 of file CmdClient.cc.
bool CmdClient::interact | ( | ) |
An interactive BES client that takes BES requests on the command line.
The commands specified interactively are the old style command syntax, not xml documents.
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.
BESError | Thrown if there is a problem sending any of the requests to the server or a problem receiving any of the responses from the server. |
Definition at line 430 of file CmdClient.cc.
bool CmdClient::isConnected | ( | ) |
return whether the client is connected to the BES
Definition at line 545 of file CmdClient.cc.
void CmdClient::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.
strm | an OutputStream specifying where to send responses from the BES server. If null then the output will not be output but will be thrown away. |
created | true of the passed stream was created and can be deleted either by being replaced ro in the destructor |
BESError | catches any problems with opening or writing to the output stream and creates a BESError |
Definition at line 174 of file CmdClient.cc.
void CmdClient::shutdownClient | ( | ) |
Closes the connection to the OpeNDAP server and closes the output stream.
BESError | Thrown if unable to close the connection or close the output stream. machine given the specified port. |
Definition at line 153 of file CmdClient.cc.
Connect the BES client to the BES server.
Connects to the BES server on the specified machine listening on the specified port.
host | The name of the host machine where the server is running. |
portVal | The port on which the server on the host hostStr is listening for requests. |
timeout | Number of times to try an un-blocked read |
BESError | Thrown if unable to connect to the specified host machine given the specified port. |
Definition at line 124 of file CmdClient.cc.
void CmdClient::startClient | ( | const std::string & | unixSocket, |
int | timeout | ||
) |
Connect the BES client to the BES server using the unix socket.
Connects to the BES server using the specified unix socket
unixStr | Full path to the unix socket |
timeout | Number of times to try an un-blocked read |
BESError | Thrown if unable to connect to the BES server |
Definition at line 139 of file CmdClient.cc.