bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
Socket Class Referenceabstract
Inheritance diagram for Socket:
Inheritance graph
Collaboration diagram for Socket:
Collaboration graph

Public Member Functions

virtual bool allowConnection ()=0
 
virtual void close ()
 
virtual void connect ()=0
 
virtual void dump (std::ostream &strm) const
 dump the contents of this object to the specified ostream
 
std::string getIp ()
 
unsigned int getPort ()
 
virtual unsigned int getRecvBufferSize ()=0
 
virtual unsigned int getSendBufferSize ()=0
 
virtual int getSocketDescriptor ()
 
virtual bool isConnected ()
 
virtual bool isListening ()
 
virtual void listen ()=0
 
virtual SocketnewSocket (int socket, struct sockaddr *addr)=0
 
virtual int receive (char *inBuff, const int inSize)
 
virtual void send (const std::string &str, int start, int end)
 
 Socket (int socket, struct sockaddr *addr)
 

Protected Attributes

bool _addr_set
 
bool _connected
 
std::string _ip
 
bool _listening
 
unsigned int _port
 
int _socket
 

Detailed Description

Definition at line 42 of file Socket.h.

Constructor & Destructor Documentation

◆ Socket()

Socket::Socket ( )
inline

Definition at line 51 of file Socket.h.

◆ ~Socket()

virtual Socket::~Socket ( )
inlinevirtual

Definition at line 58 of file Socket.h.

Member Function Documentation

◆ dump()

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

dump the contents of this object to the specified ostream

This method is implemented by all derived classes to dump their contents, in other words, any state they might have, private variables, etc...

The inline function below can be used to dump the contents of an OPeNDAPObj object. For example, the object Animal is derived from BESObj. A user could do the following:

Animal *a = new dog( "Sparky" ) ; cout << a << endl ;

And the dump method for dog could display the name passed into the constructor, the (this) pointer of the object, etc...

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

Implements BESObj.

Reimplemented in TcpSocket, and UnixSocket.

◆ getIp()

std::string Socket::getIp ( )
inline

Definition at line 85 of file Socket.h.

◆ getPort()

unsigned int Socket::getPort ( )
inline

Definition at line 81 of file Socket.h.

◆ getSocketDescriptor()

virtual int Socket::getSocketDescriptor ( )
inlinevirtual

Definition at line 77 of file Socket.h.

◆ isConnected()

virtual bool Socket::isConnected ( )
inlinevirtual

Definition at line 64 of file Socket.h.

◆ isListening()

virtual bool Socket::isListening ( )
inlinevirtual

Definition at line 69 of file Socket.h.

Member Data Documentation

◆ _addr_set

bool Socket::_addr_set
protected

Definition at line 49 of file Socket.h.

◆ _connected

bool Socket::_connected
protected

Definition at line 45 of file Socket.h.

◆ _ip

std::string Socket::_ip
protected

Definition at line 47 of file Socket.h.

◆ _listening

bool Socket::_listening
protected

Definition at line 46 of file Socket.h.

◆ _port

unsigned int Socket::_port
protected

Definition at line 48 of file Socket.h.

◆ _socket

int Socket::_socket
protected

Definition at line 44 of file Socket.h.


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