bes  Updated for version 3.20.5
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 using std::ostream ;
41 using std::ifstream ;
42 using std::string ;
43 
44 #include "BESObj.h"
45 
46 class PPTClient ;
47 
75 class CmdClient : public BESObj
76 {
77 private:
78  PPTClient * _client ;
79  ostream * _strm ;
80  bool _strmCreated ;
81  bool _isInteractive ;
82 
83  size_t readLine( string &str ) ;
84  void displayHelp() ;
85  bool executeCommand( const string &cmd,
86  int repeat ) ;
87 public:
88  CmdClient( )
89  : _client( 0 ),
90  _strm( 0 ),
91  _strmCreated( false ),
92  _isInteractive( false ) {}
93  ~CmdClient() ;
94 
95  void startClient( const string &host,
96  int portVal,
97  int timeout ) ;
98  void startClient( const string &unixSocket,
99  int timeout ) ;
100  void shutdownClient() ;
101  void setOutput( ostream *strm, bool created ) ;
102  bool executeClientCommand( const string &cmd ) ;
103  bool executeCommands( const string &cmd,
104  int repeat ) ;
105  bool executeCommands( ifstream &inputFile,
106  int repeat ) ;
107  bool interact() ;
108  bool isConnected() ;
109  void brokenPipe() ;
110 
111  virtual void dump( ostream &strm ) const ;
112 } ;
113 
114 #endif // CmdClient_h
115 
void shutdownClient()
Closes the connection to the OpeNDAP server and closes the output stream.
Definition: CmdClient.cc:150
bool executeClientCommand(const string &cmd)
Executes a client side command.
Definition: CmdClient.cc:195
void brokenPipe()
inform the server that there has been a borken pipe
Definition: CmdClient.cc:550
Base object for bes objects.
Definition: BESObj.h:51
bool isConnected()
return whether the client is connected to the BES
Definition: CmdClient.cc:542
virtual void dump(ostream &strm) const
dumps information about this object
Definition: CmdClient.cc:561
void startClient(const string &host, int portVal, int timeout)
Connect the BES client to the BES server.
Definition: CmdClient.cc:121
void setOutput(ostream *strm, bool created)
Set the output stream for responses from the BES server.
Definition: CmdClient.cc:171
bool executeCommands(const string &cmd, int repeat)
Send the command(s) specified to the BES server after wrapping in request document.
Definition: CmdClient.cc:347
bool interact()
An interactive BES client that takes BES requests on the command line.
Definition: CmdClient.cc:427