From 809b470ce90e53c532dfebc44c2e7c169c33402f Mon Sep 17 00:00:00 2001 From: Erwin Nindl Date: Fri, 7 Dec 2007 17:46:13 +0000 Subject: removed doxygen folders from svn --- doc/html/classCommunicatingSocket.html | 281 --------------------------------- 1 file changed, 281 deletions(-) delete mode 100644 doc/html/classCommunicatingSocket.html (limited to 'doc/html/classCommunicatingSocket.html') diff --git a/doc/html/classCommunicatingSocket.html b/doc/html/classCommunicatingSocket.html deleted file mode 100644 index 4015647..0000000 --- a/doc/html/classCommunicatingSocket.html +++ /dev/null @@ -1,281 +0,0 @@ - - -anytun: CommunicatingSocket Class Reference - - - - -
-
-
-
-

CommunicatingSocket Class Reference

#include <PracticalSocket.h> -

-

Inheritance diagram for CommunicatingSocket: -

- -Socket -TCPSocket -UDPSocket -UDPPacketSource - -List of all members. - - - - - - - - - - - - - - - - - -

Public Member Functions

void connect (const string &foreignAddress, unsigned short foreignPort) throw (SocketException)
void send (const void *buffer, int bufferLen) throw (SocketException)
int recv (void *buffer, int bufferLen) throw (SocketException)
string getForeignAddress () throw (SocketException)
unsigned short getForeignPort () throw (SocketException)

Protected Member Functions

 CommunicatingSocket (int type, int protocol) throw (SocketException)
 CommunicatingSocket (int newConnSD)
-

Detailed Description

-Socket which is able to connect, send, and receive -

-

Constructor & Destructor Documentation

- -
-
- - - - - - - - - - - - - - - - - - -
CommunicatingSocket::CommunicatingSocket (int  type,
int  protocol 
) throw (SocketException) [protected]
-
-
- -

- -

-

- -

-
- - - - - - - - - -
CommunicatingSocket::CommunicatingSocket (int  newConnSD  )  [protected]
-
-
- -

- -

-

-

Member Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - -
void CommunicatingSocket::connect (const string &  foreignAddress,
unsigned short  foreignPort 
) throw (SocketException)
-
-
- -

-Establish a socket connection with the given foreign address and port

Parameters:
- - - -
foreignAddress foreign address (IP address or name)
foreignPort foreign port
-
-
Exceptions:
- - -
SocketException thrown if unable to establish connection
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
void CommunicatingSocket::send (const void *  buffer,
int  bufferLen 
) throw (SocketException)
-
-
- -

-Write the given buffer to this socket. Call connect() before calling send()

Parameters:
- - - -
buffer buffer to be written
bufferLen number of bytes from buffer to be written
-
-
Exceptions:
- - -
SocketException thrown if unable to send data
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
int CommunicatingSocket::recv (void *  buffer,
int  bufferLen 
) throw (SocketException)
-
-
- -

-Read into the given buffer up to bufferLen bytes data from this socket. Call connect() before calling recv()

Parameters:
- - - -
buffer buffer to receive the data
bufferLen maximum number of bytes to read into buffer
-
-
Returns:
number of bytes read, 0 for EOF, and -1 for error
-
Exceptions:
- - -
SocketException thrown if unable to receive data
-
- -
-

- -

-
- - - - - - - - -
string CommunicatingSocket::getForeignAddress (  )  throw (SocketException)
-
-
- -

-Get the foreign address. Call connect() before calling recv()

Returns:
foreign address
-
Exceptions:
- - -
SocketException thrown if unable to fetch foreign address
-
- -
-

- -

-
- - - - - - - - -
unsigned short CommunicatingSocket::getForeignPort (  )  throw (SocketException)
-
-
- -

-Get the foreign port. Call connect() before calling recv()

Returns:
foreign port
-
Exceptions:
- - -
SocketException thrown if unable to fetch foreign port
-
- -
-

-

The documentation for this class was generated from the following files: -
Generated on Mon Dec 3 11:49:25 2007 for anytun by  - -doxygen 1.5.1
- - -- cgit v1.2.3