bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
Public Member Functions | Protected Attributes | List of all members
TcpSocket Class Reference
Inheritance diagram for TcpSocket:
Inheritance graph
Collaboration diagram for TcpSocket:
Collaboration graph

Public Member Functions

virtual bool allowConnection ()
 
virtual void close ()
 
virtual void connect ()
 
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 ()
 
virtual unsigned int getSendBufferSize ()
 
virtual int getSocketDescriptor ()
 
virtual bool isConnected ()
 
virtual bool isListening ()
 
virtual void listen ()
 
virtual Socket * newSocket (int socket, struct sockaddr *addr)
 
virtual int receive (char *inBuff, const int inSize)
 
virtual void send (const std::string &str, int start, int end)
 
 TcpSocket (const std::string &host, int portVal)
 
 TcpSocket (int portVal)
 
 TcpSocket (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 40 of file TcpSocket.h.

Constructor & Destructor Documentation

◆ TcpSocket() [1/3]

TcpSocket::TcpSocket ( const std::string & host,
int portVal )
inline

Build a TcPSocket object.

Parameters
hostA DNS name or an IPV4 number
portValThe port to listen on

Definition at line 57 of file TcpSocket.h.

◆ TcpSocket() [2/3]

TcpSocket::TcpSocket ( int portVal)
inline

Definition at line 62 of file TcpSocket.h.

◆ TcpSocket() [3/3]

TcpSocket::TcpSocket ( int socket,
struct sockaddr * addr )
inline

Definition at line 67 of file TcpSocket.h.

◆ ~TcpSocket()

virtual TcpSocket::~TcpSocket ( )
inlinevirtual

Definition at line 72 of file TcpSocket.h.

Member Function Documentation

◆ allowConnection()

virtual bool TcpSocket::allowConnection ( )
virtual

Implements Socket.

◆ connect()

virtual void TcpSocket::connect ( )
virtual

Implements Socket.

◆ dump()

virtual void TcpSocket::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

Reimplemented from Socket.

◆ getIp()

std::string Socket::getIp ( )
inlineinherited

Definition at line 85 of file Socket.h.

◆ getPort()

unsigned int Socket::getPort ( )
inlineinherited

Definition at line 81 of file Socket.h.

◆ getRecvBufferSize()

virtual unsigned int TcpSocket::getRecvBufferSize ( )
virtual

Implements Socket.

◆ getSendBufferSize()

virtual unsigned int TcpSocket::getSendBufferSize ( )
virtual

Implements Socket.

◆ getSocketDescriptor()

virtual int Socket::getSocketDescriptor ( )
inlinevirtualinherited

Definition at line 77 of file Socket.h.

◆ isConnected()

virtual bool Socket::isConnected ( )
inlinevirtualinherited

Definition at line 64 of file Socket.h.

◆ isListening()

virtual bool Socket::isListening ( )
inlinevirtualinherited

Definition at line 69 of file Socket.h.

◆ listen()

virtual void TcpSocket::listen ( )
virtual

Implements Socket.

◆ newSocket()

virtual Socket * TcpSocket::newSocket ( int socket,
struct sockaddr * addr )
inlinevirtual

Implements Socket.

Definition at line 81 of file TcpSocket.h.

Member Data Documentation

◆ _addr_set

bool Socket::_addr_set
protectedinherited

Definition at line 49 of file Socket.h.

◆ _connected

bool Socket::_connected
protectedinherited

Definition at line 45 of file Socket.h.

◆ _ip

std::string Socket::_ip
protectedinherited

Definition at line 47 of file Socket.h.

◆ _listening

bool Socket::_listening
protectedinherited

Definition at line 46 of file Socket.h.

◆ _port

unsigned int Socket::_port
protectedinherited

Definition at line 48 of file Socket.h.

◆ _socket

int Socket::_socket
protectedinherited

Definition at line 44 of file Socket.h.

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