ulxr::TcpIpConnection::ServerSocketData Class Reference

Helper class to handle the server socket. More...

#include <ulxr_tcpip_connection.h>

List of all members.

Public Member Functions
	ServerSocketData (int s_no)
	Construct the server socket.
virtual	~ServerSocketData ()
	Destroy the server socket.
int	getSocket () const
	Gets the socket handle.
void	close ()
	Closes the socket - no shutdown.
virtual void	shutdown (int mode)
	Shuts down the socket.
bool	isOpen ()
	Queries if the socket has been closed via close() or shutdown().
void	incRef ()
	Increment the usage count by 1.
int	decRef ()
	Decrement the usage count by 1.
Private Attributes
int	count
int	socket_no

---

Detailed Description

Helper class to handle the server socket.

Definition at line 253 of file ulxr_tcpip_connection.h.

---

Constructor & Destructor Documentation

ulxr::TcpIpConnection::ServerSocketData::ServerSocketData

(

int

s_no

)

Construct the server socket.

Parameters:

s_no

the socket handle

Definition at line 72 of file ulxr_tcpip_connection.cpp.

ulxr::TcpIpConnection::ServerSocketData::~ServerSocketData

(

)

[virtual]

Destroy the server socket.

Definition at line 79 of file ulxr_tcpip_connection.cpp.

References close().

---

Member Function Documentation

int ulxr::TcpIpConnection::ServerSocketData::getSocket

(

)

const

Gets the socket handle.

Returns:

the socket handle

Definition at line 85 of file ulxr_tcpip_connection.cpp.

void ulxr::TcpIpConnection::ServerSocketData::close

(

)

Closes the socket - no shutdown.

Definition at line 111 of file ulxr_tcpip_connection.cpp.

References ulxr::TcpIpConnection::close(), ulxr::TransportError, ULXR_PCHAR, and ULXR_TRACE.

Referenced by ~ServerSocketData().

void ulxr::TcpIpConnection::ServerSocketData::shutdown

(

int

mode

)

[virtual]

Shuts down the socket.

Parameters:

mode

shutdown mode Unix: SHUT_RD, SHUT_WR or SHUT_RDWR Win32: SD_RECEIVE, SD_SEND or SD_BOTH

Definition at line 130 of file ulxr_tcpip_connection.cpp.

References ulxr::TcpIpConnection::shutdown(), ulxr::TransportError, ULXR_PCHAR, and ULXR_TRACE.

Referenced by ulxr::TcpIpConnection::decrementServerRef().

bool ulxr::TcpIpConnection::ServerSocketData::isOpen

(

)

Queries if the socket has been closed via close() or shutdown().

Definition at line 105 of file ulxr_tcpip_connection.cpp.

Referenced by ulxr::TcpIpConnection::decrementServerRef().

void ulxr::TcpIpConnection::ServerSocketData::incRef

(

)

Increment the usage count by 1.

Definition at line 91 of file ulxr_tcpip_connection.cpp.

int ulxr::TcpIpConnection::ServerSocketData::decRef

(

)

Decrement the usage count by 1.

Returns:

the current usage count after decrementing.

Definition at line 97 of file ulxr_tcpip_connection.cpp.

Referenced by ulxr::TcpIpConnection::decrementServerRef().

---

Member Data Documentation

int ulxr::TcpIpConnection::ServerSocketData::count [private]

Definition at line 297 of file ulxr_tcpip_connection.h.

int ulxr::TcpIpConnection::ServerSocketData::socket_no [private]

Definition at line 298 of file ulxr_tcpip_connection.h.

---

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

• ulxr_tcpip_connection.h
• ulxr_tcpip_connection.cpp

---