net::CEventSocket Class Reference

Inheritance diagram for net::CEventSocket:

List of all members.

---

Detailed Description

Inherited class allowing for polled updates.

Author:

Elden Armbrust

CEventSocket is the base class for the CEvent* socket classes. CEventSocket can be used to poll for data on the connection, and when data arrives will call the OnRead() member function.

Note:

CEventSocket and it's inherited classes should never be used directly. They should be inherited and the OnRead() and/or OnWrite() member functions overridden.

Public Member Functions
bool	Poll ()
int	Write (std::string data)
int	Write (char *data)

---

Member Function Documentation

bool net::CEventSocket::Poll

(

)

Polls for waiting data to receive.

Author:

Elden Armbrust

Returns:

A boolean value indicating whether the call was a success or not.

Poll() receives the data queued to the socket, buffers it, then calls the OnRead() member function.

int net::CEventSocket::Write

(

std::string

data

)

Writes character data to the socket.

Author:

Elden Armbrust

Parameters:

data

The character (std::string) to be written to the socket.

Returns:

The number of bytes written to the socket.

Reimplemented from net::CSocket.

int net::CEventSocket::Write

(

char *

data

)

Writes character data to the socket.

Author:

Elden Armbrust

Parameters:

data

The character (char) array to be written to the socket.

Returns:

The number of bytes written to the socket.

Reimplemented from net::CSocket.

---

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

• libaeon.h
• CEventSocket.cpp

---