net::CSocketSet Class Reference

List of all members.

---

Detailed Description

A class to encapsulate multiple CSocket objects.

Author:

Elden Armbrust

CSocketSet is a CSocket container class for handling sockets in an ordered fashion.

Public Member Functions
bool	Add (CSocket *socket_ref)
	Adds an existing socket to the socket set.
bool	Remove (int index, int count)
	Removes selected sockets from the set.
bool	Remove (int index)
	Removes a selected socket from the set.

---

Member Function Documentation

bool net::CSocketSet::Add

(

CSocket *

socket_ref

)

Adds an existing socket to the socket set.

Author:

Elden Armbrust

Parameters:

socket_ref

A pointer to a CSocket object

Returns:

A boolean value indicating success

Add() allows you to add an existing socket to a socket set so that it may be handled as a member of the class.

bool net::CSocketSet::Remove	(	int	index,
		int	count
	)

Removes selected sockets from the set.

Author:

Elden Armbrust

Parameters:

	index	The index id of the socket to remove from the set
	count	The number of CSockets to remove from the set

Returns:

A boolean value indicating success

Remove() allows you to remove a socket from the socket set so that socket set functions will not effect the socket. It should be noted that Remove() functions of the CSocketSet class do NOT do any garbage collection, deletion, or connection closing on the sockets to be removed. Those tasks should be done prior to removal for the most simple transition.

bool net::CSocketSet::Remove

(

int

index

)

Removes a selected socket from the set.

Author:

Elden Armbrust

Parameters:

index

The index id of the socket to remove from the set

Returns:

A boolean value indicating success

Remove() allows you to remove a socket from the socket set so that socket set functions will not effect the socket. It should be noted that Remove() functions of the CSocketSet class do NOT do any garbage collection, deletion, or connection closing on the sockets to be removed. Those tasks should be done prior to removal for the most simple transition.

---

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

• libaeon.h
• CSocketSet.cpp

---