OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
Socket.h
Go to the documentation of this file.
1 // Socket.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 Socket_h
34 #define Socket_h 1
35 
36 #include <netinet/in.h>
37 
38 #include <string>
39 
40 #include "BESObj.h"
41 
42 class Socket: public BESObj {
43 protected:
44  int _socket;
45  bool _connected;
46  bool _listening;
47  std::string _ip;
48  unsigned int _port;
49  bool _addr_set;
50 public:
51  Socket() :
52  _socket(0), _connected(false), _listening(false), _addr_set(false)
53  {
54  }
55  Socket(int socket, struct sockaddr *addr);
56  virtual ~Socket()
57  {
58  close();
59  }
60  virtual void connect() = 0;
61  virtual bool isConnected()
62  {
63  return _connected;
64  }
65  virtual void listen() = 0;
66  virtual bool isListening()
67  {
68  return _listening;
69  }
70  virtual void close();
71  virtual void send(const std::string &str, int start, int end);
72  virtual int receive(char *inBuff, const int inSize);
73 #if 0
74  // sync() was calling fsync() which is not defined for a socket.
75  // jhrg 5/5/11
76  virtual void sync();
77 #endif
78  virtual int getSocketDescriptor()
79  {
80  return _socket;
81  }
82  unsigned int getPort()
83  {
84  return _port;
85  }
86  std::string getIp()
87  {
88  return _ip;
89  }
90 
91  virtual unsigned int getRecvBufferSize() = 0;
92  virtual unsigned int getSendBufferSize() = 0;
93 
94  virtual Socket * newSocket(int socket, struct sockaddr *addr) = 0;
95 
96  virtual bool allowConnection() = 0;
97 
98  virtual void dump(ostream &strm) const;
99 };
100 
101 #endif // Socket_h
Definition: Socket.h:42
std::string _ip
Definition: Socket.h:47
virtual bool isListening()
Definition: Socket.h:66
virtual bool isConnected()
Definition: Socket.h:61
virtual unsigned int getRecvBufferSize()=0
int _socket
Definition: Socket.h:44
unsigned int getPort()
Definition: Socket.h:82
virtual bool allowConnection()=0
bool _addr_set
Definition: Socket.h:49
virtual ~Socket()
Definition: Socket.h:56
virtual void send(const std::string &str, int start, int end)
Definition: Socket.cc:86
virtual void dump(ostream &strm) const
dumps information about this object
Definition: Socket.cc:134
bool _listening
Definition: Socket.h:46
Base object for bes objects.
Definition: BESObj.h:52
unsigned int _port
Definition: Socket.h:48
virtual void listen()=0
virtual void close()
Definition: Socket.cc:76
virtual int receive(char *inBuff, const int inSize)
Definition: Socket.cc:98
virtual int getSocketDescriptor()
Definition: Socket.h:78
virtual void connect()=0
Socket()
Definition: Socket.h:51
std::string getIp()
Definition: Socket.h:86
bool _connected
Definition: Socket.h:45
virtual Socket * newSocket(int socket, struct sockaddr *addr)=0
virtual unsigned int getSendBufferSize()=0