bes Updated for version 3.20.13
CmdClient.h
1// CmdClient.h
2
3// This file is part of bes, A C++ back-end server implementation framework
4// for the OPeNDAP Data Access Protocol.
5
6// Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8//
9// This library is free software; you can redistribute it and/or
10// modify it under the terms of the GNU Lesser General Public
11// License as published by the Free Software Foundation; either
12// version 2.1 of the License, or (at your option) any later version.
13//
14// This library is distributed in the hope that it will be useful,
15// but WITHOUT ANY WARRANTY; without even the implied warranty of
16// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17// Lesser General Public License for more details.
18//
19// You should have received a copy of the GNU Lesser General Public
20// License along with this library; if not, write to the Free Software
21// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22//
23// You can contact University Corporation for Atmospheric Research at
24// 3080 Center Green Drive, Boulder, CO 80301
25
26// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27// Please read the full copyright statement in the file COPYRIGHT_UCAR.
28//
29// Authors:
30// pwest Patrick West <pwest@ucar.edu>
31// jgarcia Jose Garcia <jgarcia@ucar.edu>
32
33#ifndef CmdClient_h
34#define CmdClient_h 1
35
36#include <iostream>
37#include <string>
38#include <fstream>
39
40#include "BESObj.h"
41
42class PPTClient ;
43
71class CmdClient : public BESObj
72{
73private:
74 PPTClient * _client ;
75 std::ostream * _strm ;
76 bool _strmCreated ;
77 bool _isInteractive ;
78
79 size_t readLine( std::string &str ) ;
80 void displayHelp() ;
81 bool executeCommand( const std::string &cmd,
82 int repeat ) ;
83public:
84 CmdClient( )
85 : _client( 0 ),
86 _strm( 0 ),
87 _strmCreated( false ),
88 _isInteractive( false ) {}
89 ~CmdClient() ;
90
91 void startClient( const std::string &host,
92 int portVal,
93 int timeout ) ;
94 void startClient( const std::string &unixSocket,
95 int timeout ) ;
96 void shutdownClient() ;
97 void setOutput( std::ostream *strm, bool created ) ;
98 bool executeClientCommand( const std::string &cmd ) ;
99 bool executeCommands( const std::string &cmd,
100 int repeat ) ;
101 bool executeCommands( std::ifstream &inputFile,
102 int repeat ) ;
103 bool interact() ;
104 bool isConnected() ;
105 void brokenPipe() ;
106
107 virtual void dump( std::ostream &strm ) const ;
108} ;
109
110#endif // CmdClient_h
111
top level BES object to house generic methods
Definition: BESObj.h:54
void brokenPipe()
inform the server that there has been a borken pipe
Definition: CmdClient.cc:553
bool executeCommands(const std::string &cmd, int repeat)
Send the command(s) specified to the BES server after wrapping in request document.
Definition: CmdClient.cc:350
void startClient(const std::string &host, int portVal, int timeout)
Connect the BES client to the BES server.
Definition: CmdClient.cc:124
bool executeClientCommand(const std::string &cmd)
Executes a client side command.
Definition: CmdClient.cc:198
bool interact()
An interactive BES client that takes BES requests on the command line.
Definition: CmdClient.cc:430
bool isConnected()
return whether the client is connected to the BES
Definition: CmdClient.cc:545
void shutdownClient()
Closes the connection to the OpeNDAP server and closes the output stream.
Definition: CmdClient.cc:153
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: CmdClient.cc:564
void setOutput(std::ostream *strm, bool created)
Set the output stream for responses from the BES server.
Definition: CmdClient.cc:174