CSocket Class Reference

#include <socket.h>

Inheritance diagram for CSocket:

Collaboration diagram for CSocket:

Public Member Functions
	CSocket ()
virtual	~CSocket ()
virtual SOCKET	GetSocket ()
virtual VOID	SetSocket (SOCKET socket)
virtual SOCKADDR_IN	GetSockAddrIn ()
virtual VOID	SetSockAddrIn (SOCKADDR_IN sockaddrin)
virtual VOID	SetEvents (LONG lEvents)
virtual LONG	GetEvents ()
virtual VOID	SetPort (UINT nPort)
virtual VOID	Open ()
virtual VOID	Close ()
virtual INT	Transmit (LPCSTR lpsBuffer, UINT nLength)
virtual INT	Receive (LPSTR lpsBuffer, UINT nLength)
virtual INT	SendText (LPCSTR lpsStr)

Protected Attributes
SOCKET	Socket
SOCKADDR_IN	SockAddrIn
WSAEVENT	Event
UINT	Port
BOOL	Active

Private Attributes
LONG	Events

Detailed Description

Definition at line 72 of file socket.h.

Constructor & Destructor Documentation

CSocket()

CSocket::CSocket

(

)

Definition at line 18 of file socket.cpp.

{
    Active = FALSE;
    Event  = WSA_INVALID_EVENT;
    Events = 0;
    Socket = INVALID_SOCKET;
 
    // INET address family
    SockAddrIn.sin_family = AF_INET;
 
    // Any address will do
    SockAddrIn.sin_addr.s_addr = INADDR_ANY;
 
    // Convert to network ordering
    SockAddrIn.sin_port = htons(0);
}

~CSocket()

CSocket::~CSocket ( )

virtual

Definition at line 36 of file socket.cpp.

{
}

Member Function Documentation

Close()

VOID CSocket::Close ( )

virtual

Reimplemented in CServerSocket.

Definition at line 95 of file socket.cpp.

{
}

Referenced by CHttpClient::OnRead(), and CHttpClient::SendFile().

GetEvents()

LONG CSocket::GetEvents ( )

virtual

Definition at line 84 of file socket.cpp.

{
    return Events;
}

GetSockAddrIn()

SOCKADDR_IN CSocket::GetSockAddrIn ( )

virtual

Definition at line 54 of file socket.cpp.

{
    return SockAddrIn;
}

GetSocket()

SOCKET CSocket::GetSocket ( )

virtual

Definition at line 41 of file socket.cpp.

{
    return Socket;
}

Open()

VOID CSocket::Open ( )

virtual

Reimplemented in CServerSocket.

Definition at line 90 of file socket.cpp.

{
}

Receive()

virtual INT CSocket::Receive ( LPSTR  lpsBuffer, UINT  nLength  )

inlinevirtual

Reimplemented in CServerClientSocket.

Definition at line 86 of file socket.h.

{ return 0; };

SendText()

virtual INT CSocket::SendText ( LPCSTR  lpsStr )

inlinevirtual

Reimplemented in CServerClientSocket.

Definition at line 87 of file socket.h.

{ return 0; };

SetEvents()

VOID CSocket::SetEvents ( LONG  lEvents )

virtual

Definition at line 66 of file socket.cpp.

{
    if (Event == WSA_INVALID_EVENT) {
        // Create socket event
        Event = WSACreateEvent();
        if (Event == WSA_INVALID_EVENT)
            throw ESocketOpen(TS("Unable to create event."));
    }
 
    if (lEvents != Events) {
        // Associate network events with socket
        if (WSAEventSelect(Socket, Event, lEvents) == SOCKET_ERROR)
            throw ESocketOpen(TS("Unable to select socket events."));
        Events = lEvents;
    }
}

Referenced by CServerSocket::MessageLoop(), and CServerSocket::Open().

SetPort()

virtual VOID CSocket::SetPort ( UINT  nPort )

inlinevirtual

Reimplemented in CServerSocket.

Definition at line 82 of file socket.h.

{};

SetSockAddrIn()

VOID CSocket::SetSockAddrIn ( SOCKADDR_IN  sockaddrin )

virtual

Definition at line 60 of file socket.cpp.

{
    SockAddrIn = sockaddrin;
}

Referenced by CServerSocket::MessageLoop().

SetSocket()

VOID CSocket::SetSocket ( SOCKET  socket )

virtual

Definition at line 47 of file socket.cpp.

{
    Socket = socket;
}

Referenced by CServerSocket::MessageLoop().

Transmit()

virtual INT CSocket::Transmit ( LPCSTR  lpsBuffer, UINT  nLength  )

inlinevirtual

Reimplemented in CServerClientSocket.

Definition at line 85 of file socket.h.

{ return 0; };

Member Data Documentation

Active

BOOL CSocket::Active

protected

Definition at line 93 of file socket.h.

Event

WSAEVENT CSocket::Event

protected

Definition at line 91 of file socket.h.

Events

LONG CSocket::Events

private

Definition at line 95 of file socket.h.

Referenced by CSocket(), GetEvents(), and SetEvents().

Port

UINT CSocket::Port

protected

Definition at line 92 of file socket.h.

Referenced by CServerSocket::Open(), and CServerSocket::SetPort().

SockAddrIn

SOCKADDR_IN CSocket::SockAddrIn

protected

Definition at line 90 of file socket.h.

Referenced by CSocket(), GetSockAddrIn(), CServerSocket::MessageLoop(), CServerSocket::Open(), and SetSockAddrIn().

Socket

SOCKET CSocket::Socket

protected

Definition at line 89 of file socket.h.

Referenced by CServerSocket::Close(), CSocket(), GetSocket(), CServerClientSocket::MessageLoop(), CServerSocket::MessageLoop(), CServerSocket::Open(), CServerClientSocket::Receive(), CHttpClient::SendFile(), SetEvents(), SetSocket(), and CServerClientSocket::Transmit().

---

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

• modules/rosapps/applications/net/roshttpd/include/socket.h
• modules/rosapps/applications/net/roshttpd/common/socket.cpp