OPeNDAP Hyrax Back End Server (BES) Updated for version 3.8.3

Socket Class Reference

#include <Socket.h>

Inheritance diagram for Socket:
Collaboration diagram for Socket:

List of all members.

Public Member Functions

virtual bool allowConnection ()=0
virtual void close ()
virtual void connect ()=0
virtual void dump (ostream &strm) const
 dumps information about this object
virtual void dump (ostream &strm) const =0
 dump the contents of this object to the specified ostream
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 string &str, int start, int end)
 Socket (int socket, struct sockaddr *addr)
 Socket ()
virtual void sync ()
virtual ~Socket ()

Protected Attributes

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

Detailed Description

Definition at line 44 of file Socket.h.


Constructor & Destructor Documentation

Socket::Socket ( ) [inline]

Definition at line 54 of file Socket.h.

Socket::Socket ( int  socket,
struct sockaddr *  addr 
)

Definition at line 53 of file Socket.cc.

References _ip, and _port.

virtual Socket::~Socket ( ) [inline, virtual]

Definition at line 61 of file Socket.h.

References close().

Here is the call graph for this function:


Member Function Documentation

virtual bool Socket::allowConnection ( ) [pure virtual]

Implemented in TcpSocket, and UnixSocket.

Referenced by PPTServer::initConnection().

void Socket::close ( ) [virtual]
virtual void Socket::connect ( ) [pure virtual]

Implemented in TcpSocket, and UnixSocket.

Referenced by PPTClient::PPTClient().

void Socket::dump ( ostream &  strm) const [virtual]

dumps information about this object

Displays the pointer value of this instance

Parameters:
strmC++ i/o stream to dump the information to

Reimplemented in TcpSocket, and UnixSocket.

Definition at line 136 of file Socket.cc.

References _addr_set, _connected, _ip, _listening, _port, _socket, BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Referenced by SocketListener::dump(), and Connection::dump().

Here is the call graph for this function:

virtual void BESObj::dump ( ostream &  strm) const [pure virtual, inherited]

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 OPeNDAOObj 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

Implemented in CmdClient, BESAbstractModule, BESAggFactory, BESAggregationServer, BESApp, BESBaseApp, BESBasicHttpTransmitter, BESBasicInterface, BESBasicTransmitter, BESCache, BESCatalog, BESCatalogDirectory, BESCatalogList, BESCatalogResponseHandler, BESCatalogUtils, BESConfigResponseHandler, BESContainer, BESContainerStorage, BESContainerStorageCatalog, BESContainerStorageFile, BESContainerStorageList, BESContainerStorageVolatile, BESContextManager, BESDapError, BESDapErrorInfo, BESDapModule, BESDapRequestHandler, BESDapResponse, BESDASResponse, BESDASResponseHandler, BESDataDDSResponse, BESDataDDXResponseHandler, BESDataHandlerInterface, BESDataResponseHandler, BESDDSResponse, BESDDSResponseHandler, BESDDXResponseHandler, BESDefine, BESDefineResponseHandler, BESDefinitionStorage, BESDefinitionStorageList, BESDefinitionStorageVolatile, BESDelContainerResponseHandler, BESDelContainersResponseHandler, BESDelDefResponseHandler, BESDelDefsResponseHandler, BESError, BESExceptionManager, BESFileContainer, BESForbiddenError, BESGlobalInit, BESHelpResponseHandler, BESHTMLInfo, BESInfo, BESInfoList, BESInitializer, BESInterface, BESInternalError, BESInternalFatalError, BESKeys, BESLog, BESMemoryGlobalArea, BESModuleApp, BESNotFoundError, BESPlugin< M >, BESPluginFactory< C >, BESProcessEncodedString, BESProcIdResponseHandler, BESReporter, BESReporterList, BESRequestHandler, BESRequestHandlerList, BESResponseHandler, BESResponseHandlerList, BESResponseObject, BESReturnManager, BESServiceRegistry, BESServicesResponseHandler, BESSetContainerResponseHandler, BESSetContextResponseHandler, BESShowContainersResponseHandler, BESShowContextResponseHandler, BESShowDefsResponseHandler, BESShowErrorResponseHandler, BESSilentInfo, BESStatusResponseHandler, BESStopWatch, BESStreamResponseHandler, BESSyntaxUserError, BESTextInfo, BESTokenizer, BESTransmitter, BESUncompressManager, BESVersionInfo, BESVersionResponseHandler, BESXMLInfo, Connection, PPTClient, PPTConnection, PPTServer, SSLClient, SSLConnection, SSLServer, and StandAloneClient.

Referenced by operator<<().

string Socket::getIp ( ) [inline]

Definition at line 78 of file Socket.h.

References _ip.

unsigned int Socket::getPort ( ) [inline]

Definition at line 74 of file Socket.h.

References _port.

virtual unsigned int Socket::getRecvBufferSize ( ) [pure virtual]
virtual unsigned int Socket::getSendBufferSize ( ) [pure virtual]

Implemented in TcpSocket, and UnixSocket.

Referenced by PPTConnection::getSendChunkSize().

virtual int Socket::getSocketDescriptor ( ) [inline, virtual]
virtual bool Socket::isConnected ( ) [inline, virtual]

Definition at line 63 of file Socket.h.

References _connected.

Referenced by Connection::isConnected(), SocketListener::listen(), and PPTClient::PPTClient().

virtual bool Socket::isListening ( ) [inline, virtual]

Definition at line 65 of file Socket.h.

References _listening.

Referenced by SocketListener::listen().

virtual void Socket::listen ( ) [pure virtual]

Implemented in TcpSocket, and UnixSocket.

Referenced by SocketListener::listen().

virtual Socket* Socket::newSocket ( int  socket,
struct sockaddr *  addr 
) [pure virtual]

Implemented in TcpSocket, and UnixSocket.

Referenced by SocketListener::accept().

int Socket::receive ( char *  inBuff,
const int  inSize 
) [virtual]

Definition at line 108 of file Socket.cc.

References _socket.

void Socket::send ( const string &  str,
int  start,
int  end 
) [virtual]

Definition at line 93 of file Socket.cc.

References _socket.

Referenced by PPTConnection::send().

void Socket::sync ( ) [virtual]

Definition at line 124 of file Socket.cc.

References _socket.

Referenced by PPTConnection::send().


Member Data Documentation

bool Socket::_addr_set [protected]

Definition at line 52 of file Socket.h.

Referenced by dump().

string Socket::_ip [protected]

Definition at line 50 of file Socket.h.

Referenced by dump(), getIp(), and Socket().

unsigned int Socket::_port [protected]

Definition at line 51 of file Socket.h.

Referenced by dump(), getPort(), and Socket().


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