CAClientSocket Class Reference

#include <CAClientSocket.hpp>

Inheritance diagram for CAClientSocket:

Collaboration diagram for CAClientSocket:

Public Member Functions
virtual	~CAClientSocket ()
virtual SINT32	sendFully (const UINT8 *buff, UINT32 len)=0
	Sends all data over the network. More...
virtual SINT32	receive (UINT8 *buff, UINT32 len)=0
	Will receive some bytes from the socket. More...
virtual SOCKET	getSocket ()=0
	Returns the number of the Socket used. More...
SINT32	receiveFully (UINT8 *buff, UINT32 len)
	Receives all len bytes. More...

Detailed Description

Definition at line 32 of file CAClientSocket.hpp.

Constructor & Destructor Documentation

~CAClientSocket()

virtual CAClientSocket::~CAClientSocket ( )

inlinevirtual

Definition at line 35 of file CAClientSocket.hpp.

        {
        }

Member Function Documentation

getSocket()

virtual SOCKET CAClientSocket::getSocket ( )

pure virtual

Returns the number of the Socket used.

Which will be always the same number, even after close(), until the Socket is recreated using create()

Returns

number of the associated socket

Implemented in CASocket.

Referenced by receiveFully().

Here is the caller graph for this function:

receive()

virtual SINT32 CAClientSocket::receive ( UINT8 *  buff, UINT32  len  )

pure virtual

Will receive some bytes from the socket.

May block or not depending on the implementation.

Parameters

buff	the buffer which get the received data
len	size of buff

Returns

SOCKET_ERROR if an error occured

Return values

E_AGAIN,if	socket was in non-blocking mode and receive would block or a timeout was reached
0	if socket was gracefully closed

Returns

the number of bytes received (always >0)

Implemented in CATLSClientSocket, and CASocket.

Referenced by receiveFully().

Here is the caller graph for this function:

receiveFully()

SINT32 CAClientSocket::receiveFully	(	UINT8 *	buff,
		UINT32	len
	)

Receives all len bytes.

This blocks until all bytes are received or an error occured.

Returns

E_UNKNOWN, in case of an error

E_SUCCESS otherwise

Definition at line 33 of file CAClientSocket.cpp.

{
  SINT32 ret;
  UINT32 pos = 0;
#ifdef  __BUILD_AS_SHADOW_PLUGIN__
  CASingleSocketGroup* pSocketGroup = new CASingleSocketGroup(false);
  pSocketGroup->add(getSocket());
#endif
  do
  {
#ifdef  __BUILD_AS_SHADOW_PLUGIN__
    pSocketGroup->select();
#endif
    ret = receive(buff + pos, len);
    if (ret <= 0)
    {
      if (ret == E_AGAIN)
      {
#ifndef __BUILD_AS_SHADOW_PLUGIN__
        msSleep(100);
#endif
        continue;
      }
      else
      {
#ifdef  __BUILD_AS_SHADOW_PLUGIN__
        delete pSocketGroup;
#endif
        return E_UNKNOWN;
      }
    }
    pos += ret;
    len -= ret;
  } while (len > 0);
#ifdef  __BUILD_AS_SHADOW_PLUGIN__
  delete pSocketGroup;
#endif
  return E_SUCCESS;
}

References CASocketGroup::add(), E_AGAIN, E_SUCCESS, E_UNKNOWN, getSocket(), len, msSleep(), receive(), and CASocketGroup::select().

Referenced by CALocalProxy::init(), CALocalProxy::processKeyExchange(), CAMuxSocket::receive(), and CAMuxSocket::receiveFully().

Here is the call graph for this function:

Here is the caller graph for this function:

sendFully()

virtual SINT32 CAClientSocket::sendFully ( const UINT8 *  buff, UINT32  len  )

pure virtual

Sends all data over the network.

This may block until all data is send.

Parameters

buff	- the buffer of data to send
len	- content length

Return values

E_UNKNOWN,if	an error occured
E_SUCCESS,if	successful

Implemented in CATLSClientSocket, and CASocket.

---

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

• CAClientSocket.hpp
• CAClientSocket.cpp