CInterfaces Class Reference

#include <Interfaces.h>

Inheritance diagram for CInterfaces:

[legend]

Collaboration diagram for CInterfaces:

[legend]

List of all members.

Public Member Functions
BOOL	IsMulticast () const
BOOL	IsPPP () const
BOOL	IsLoopback () const
BOOL	IsBroadcast () const
BOOL	IsRunning () const
long	GetBroadcast () const
long	GetMask () const
BOOL	MoveNext ()
long	GetAddress () const
BOOL	GetInterfaces ()
	CInterfaces (int iMaxInterfaces=20)
virtual	~CInterfaces ()
int	GetLastError () const
void	SetLocalLog (CErrorLog *pLog, bool bWriteToMain=false)
void	WriteError (const std::string &rClass, const std::string &rMethod, const std::string &rError) const
void	WriteMessage (const std::string &rClass, const std::string &rMethod, const std::string &rMessage) const
Static Public Member Functions
static int	GetErrorCode ()
static int	GetSystemLastError ()
static BOOL	IsInitialized ()
static unsigned long	StringToLong (const std::string &rAddress)
static char FAR *	LongToString (unsigned long ulAddr)
static std::string	LongToStdString (unsigned long ulAddr)
static BOOL	InitializeSockets (BOOL bMultiThreaded=TRUE, unsigned long ulNumberOfThreads=10)
static BOOL	ShutdownSockets ()
static unsigned long	GetNumberOfThreads ()
static BOOL	IsMultiThreaded ()
static CGenericCriticalSection *	GetGlobalCriticalSection ()
static unsigned long	ResolveDNS (const std::string &rAddress)
static BOOL	ValidAddress (const std::string &rAddress)
static CErrorHandler *	GetSecondaryLog ()
static CErrorHandler *	GetThirdLog ()
static void	ClearStaticLogs ()
static std::string	GetCurrentDateTime ()
static std::string	ErrorCodeToString (DWORD dwErrorCode)
static void	RegisterError (DWORD dwErrorCode, const std::string &rDescription)
static void	SetLog (CErrorLog *pLog)
static void	WriteStaticError (const std::string &rClass, const std::string &rMethod, const std::string &rError)
static void	WriteStaticMessage (const std::string &rClass, const std::string &rMethod, const std::string &rMessage)
static std::string	FormatData (const std::string &rClass, const std::string &rMethod, const std::string &rMsgOrError, bool bError=true)
Protected Member Functions
virtual void	NotifyShutdown ()
void	RegisterShutdown (CSocketBase *pBase)
void	SetLastError (const std::string &rMethod) const
void	SetLastError (const std::string &, int iErrorCode) const
void	WriteMessage (const std::string &rMethod, const std::string &rMessage) const
const std::string &	GetClassName () const
virtual void	ReportError (const std::string &rMethod) const
virtual void	ReportError (const std::string &rMethod, const std::string &rMessage) const
virtual void	ReportError (const std::string &rMethod, const std::string &rMessage, DWORD dwAdditionalData) const
virtual void	ReportError (const std::string &rMethod, const std::string &rMessage, const std::string &rAdditionalData) const
virtual void	ReportError (const std::string &rMethod, int iErrorCode) const
virtual void	ReportError (const std::string &rMethod, const std::string &rMessage, int iErrorCode) const
virtual void	ReportErrorOS (const std::string &rMethod, const std::string &rMessage) const
void	SetName (const std::string &rName) const
Static Protected Member Functions
static void	ReportStaticError (const std::string &rClass, const std::string &rMethod)
static void	ReportStaticError (const std::string &rClass, const std::string &rMethod, const std::string &rMessage)
static void	ReportStaticError (const std::string &rClass, const std::string &rMethod, const std::string &rMessage, DWORD dwAdditionalData)
static void	ReportStaticErrorOS (const std::string &rClass, const std::string &rMethod, const std::string &rMessage)
Static Protected Attributes
static CGenericCriticalSection *	m_pCSection = NULL

---

Detailed Description

Definition at line 47 of file Interfaces.h.

---

Constructor & Destructor Documentation

CInterfaces::CInterfaces

(

int

iMaxInterfaces = 20

)

Definition at line 57 of file Interfaces.cpp.

                                           : CSocketBase(),
                                               m_iStructures(0),
                                               m_iPosition(0)

{
    try
    {
        //Set our name
        SetName(CInterfaces_Class);

        //Allocate the information
        m_iMaxInterfaces=iMaxInterfaces;

        //Allocate our info
        if (!iMaxInterfaces)
            m_pInfo=NULL;
        else
            m_pInfo=new INTERFACE_INFO[m_iMaxInterfaces];
    }
    ERROR_HANDLER("CInterfaces")
}

CInterfaces::~CInterfaces

(

)

[virtual]

Definition at line 79 of file Interfaces.cpp.

{
    try
    {
        delete m_pInfo;
    }
    ERROR_HANDLER("~CInterfaces")
}

---

Member Function Documentation

void CErrorHandler::ClearStaticLogs

(

)

[static, inherited]

Definition at line 680 of file ErrorHandler.cpp.

{
    //Delete the logs
    delete m_pSecondLevelLog;
    m_pSecondLevelLog=NULL;

    delete m_pThirdLevelLog;
    m_pThirdLevelLog=NULL;
}

std::string CErrorHandler::ErrorCodeToString

(

DWORD

dwErrorCode

)

[static, inherited]

Definition at line 251 of file ErrorHandler.cpp.

{
    try
    {
        //Try to look it in the errors
        if (!CErrorsRepository::GetInstance().GetErrorsMap().empty())
        {
            //Search
            CErrorsRepository::ErrorMap::const_iterator aIterator;
            aIterator=CErrorsRepository::GetInstance().GetErrorsMap().find(dwErrorCode);

            //Do we have it
            if (aIterator!=CErrorsRepository::GetInstance().GetErrorsMap().end())
                return aIterator->second;
        }

        //Get the error string
        LPVOID lpMsgBuf;
        FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | 
                      FORMAT_MESSAGE_FROM_SYSTEM | 
                      FORMAT_MESSAGE_IGNORE_INSERTS,
                      NULL,
                      dwErrorCode,
                      MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
                      (LPTSTR) &lpMsgBuf,
                      0,
                      NULL);

        //Save it
        std::string sMessage;

        //Do we have the message?
        if (lpMsgBuf)
        {
            //Save it
            sMessage=(char*)lpMsgBuf;
            
            //Release the buffer
            LocalFree(lpMsgBuf);
        }
        else
            //Failed to find
            sMessage="No error description found!";

        //Done
        return sMessage;
    }
    catch (...)
    {
        return "Unknown";
    }
}

std::string CErrorHandler::FormatData	(	const std::string &	rClass,
		const std::string &	rMethod,
		const std::string &	rMsgOrError,
		bool	bError = true
	)			[static, inherited]

Definition at line 145 of file ErrorHandler.cpp.

{
    //Our message
    std::string sMsg;

    //Is it an error?
    if (bError)
        sMsg="*** Error *** ";
    else
        sMsg="###  Msg  ### ";

    //Add the data now
    sMsg+="in "+rClass;
    sMsg+="::"+rMethod;
    sMsg+=" - " + rMsgOrError;

    //Done
    return sMsg;
}

long CInterfaces::GetAddress

(

)

const

Definition at line 152 of file Interfaces.cpp.

{
    CHECK_POSITION("GetAddress",0)
    
    try
    {
        return (m_pInfo+m_iPosition)->iiAddress.AddressIn.sin_addr.S_un.S_addr;
    }
    ERROR_HANDLER_RETURN("GetAddress",0);
}

long CInterfaces::GetBroadcast

(

)

const

Definition at line 180 of file Interfaces.cpp.

{
    CHECK_POSITION("GetBroadcast",0)
    
    try
    {
        return m_pInfo[m_iPosition].iiBroadcastAddress.AddressIn.sin_addr.S_un.S_addr;
    }
    ERROR_HANDLER_RETURN("GetBroadcast",0);
}

const std::string & CErrorHandler::GetClassName

(

)

const [protected, inherited]

Reimplemented in CSocketThreadManager.

Definition at line 617 of file ErrorHandler.cpp.

{
    return m_sClassName;
}

std::string CErrorHandler::GetCurrentDateTime

(

)

[static, inherited]

Definition at line 622 of file ErrorHandler.cpp.

{
    try
    {
        //Our string
        std::string sDate;

        //Our tmp buf
        char cTmp[128];

        //Get date
        _strdate(cTmp);
        sDate=cTmp;
        sDate+=' ';

        //Get time
        _strtime(cTmp);
        sDate+=cTmp;

        //Done
        return sDate;
    }
    ERROR_HANDLER_STATIC_RETURN(CErrorHandler_Class,"GetCurrentDateTime","")
}

int CSocketBase::GetErrorCode

(

)

[static, inherited]

Definition at line 368 of file SocketBase.cpp.

{
    return SOCKET_ERROR;
}

CGenericCriticalSection * CSocketBase::GetGlobalCriticalSection

(

)

[static, inherited]

Definition at line 363 of file SocketBase.cpp.

{
    return m_pCSection;
}

BOOL CInterfaces::GetInterfaces

(

)

Definition at line 88 of file Interfaces.cpp.

{
    if (!m_iMaxInterfaces)
    {
        //structure not allocated
        ReportError("GetInterfaces","You constructed the class with 0 parameter!");

        //Exit
        return FALSE;
    }

    try
    {
        //Allocate a socket
        SOCKET aSocket;
        aSocket=socket(AF_INET,SOCK_DGRAM,0);

        //Check it's valid
        if (aSocket==INVALID_SOCKET)
        {
            //Report it
            SetLastError("GetInterfaces");

            //Exit
            return FALSE;
        }

        //Get the interface list
        unsigned long ulBytes;
        if (WSAIoctl(aSocket,
                     SIO_GET_INTERFACE_LIST,
                     NULL,
                     NULL,
                     m_pInfo,
                     sizeof(INTERFACE_INFO)*m_iMaxInterfaces,
                     &ulBytes,
                     NULL,
                     NULL))
        {
            //Damn error
            SetLastError("GetInterfaces");

            //Close the socket
            closesocket(aSocket);

            //Exit
            return FALSE;
        }

        //Check how many structures we have
        m_iStructures=ulBytes/sizeof(INTERFACE_INFO);

        //Set our position to zero
        m_iPosition=0;

        //Close the socket
        closesocket(aSocket);

        //Done
        return TRUE;
    }
    ERROR_HANDLER_RETURN("GetInterfaces",FALSE)
}

int CSocketBase::GetLastError

(

)

const [inherited]

Definition at line 141 of file SocketBase.cpp.

{
    return m_iLastError;
}

long CInterfaces::GetMask

(

)

const

Definition at line 169 of file Interfaces.cpp.

{
    CHECK_POSITION("GetMask",0)
    
    try
    {
        return m_pInfo[m_iPosition].iiNetmask.AddressIn.sin_addr.S_un.S_addr;
    }
    ERROR_HANDLER_RETURN("GetMask",0);
}

unsigned long CSocketBase::GetNumberOfThreads

(

)

[static, inherited]

Definition at line 334 of file SocketBase.cpp.

{
    return m_ulNumberOfThreads;
}

CErrorHandler * CErrorHandler::GetSecondaryLog

(

)

[static, inherited]

Definition at line 658 of file ErrorHandler.cpp.

{
    //Do we have log
    if (!m_pSecondLevelLog)
        //Create it
        m_pSecondLevelLog=new CErrorHandler;

    //Return it
    return m_pSecondLevelLog;
}

int CSocketBase::GetSystemLastError

(

)

[static, inherited]

Definition at line 358 of file SocketBase.cpp.

{
    return WSAGetLastError();
}

CErrorHandler * CErrorHandler::GetThirdLog

(

)

[static, inherited]

Definition at line 669 of file ErrorHandler.cpp.

{
    //Do we have log
    if (!m_pThirdLevelLog)
        //Create it
        m_pThirdLevelLog=new CErrorHandler;

    //Return it
    return m_pThirdLevelLog;
}

BOOL CSocketBase::InitializeSockets	(	BOOL	bMultiThreaded = TRUE,
		unsigned long	ulNumberOfThreads = 10
	)			[static, inherited]

Definition at line 146 of file SocketBase.cpp.

{
    //To avoid double initialize
    if (m_bInitialized)
    {
        //Report it
        ReportStaticError(CSocketBase_Class,"InitializeSockets","Already initialized!");

        //Exit
        return TRUE;
    }

    //Check that the number of threads are OK?
    if (ulNumberOfThreads>CLibConfig::GetInstance().GetMaxThreads())
    {
        //Report it
        ReportStaticError(CSocketBase_Class,"InitializeSockets","Too many threads!");

        //Exit
        return FALSE;
    }

    //Do we have threads at all
    if (bMultiThreaded &&
        !ulNumberOfThreads)
    {
        //Report it
        ReportStaticError(CSocketBase_Class,"InitializeSockets","Didn't receive any threads!");

        //Exit
        return FALSE;
    }

    try
    {
        //Initialize the sockets
        WORD wVersionRequested;
        wVersionRequested=MAKEWORD(2,2);
 
        //Try to initialize
        WSADATA wsaData;
        int iErr;
        iErr=WSAStartup(wVersionRequested, 
                        &wsaData);

        //Did we succeed?
        if (iErr!=0)
            /* Tell the user that we could not find a usable */
            /* WinSock DLL.                                  */
            return FALSE;
 
        /* Confirm that the WinSock DLL supports 2.2.*/
        /* Note that if the DLL supports versions greater    */
        /* than 2.2 in addition to 2.2, it will still return */
        /* 2.2 in wVersion since that is the version we      */
        /* requested.                                        */
 
        if (LOBYTE(wsaData.wVersion)!=2 || 
            HIBYTE(wsaData.wVersion)!=2)
        {
            /* Tell the user that we could not find a usable */
            /* WinSock DLL.                                  */
            WSACleanup();

            //Exit
            return FALSE;
        }

        //Save the threading information
        m_bMultiThreaded=bMultiThreaded;
        m_ulNumberOfThreads=ulNumberOfThreads;

        //Create the critical section
        m_pCSection=COSManager::CreateCriticalSection();
        m_pCSectionDNS=COSManager::CreateCriticalSection();

        //And we are initialized
        m_bInitialized=TRUE;

        return TRUE;
    }
    ERROR_HANDLER_STATIC_RETURN(CSocketBase_Class,"InitializeSockets",FALSE)
}

BOOL CInterfaces::IsBroadcast

(

)

const

Definition at line 196 of file Interfaces.cpp.

{
    return GetFlags() & IFF_BROADCAST;
}

BOOL CSocketBase::IsInitialized

(

)

[static, inherited]

Definition at line 339 of file SocketBase.cpp.

{
    return m_bInitialized;
}

BOOL CInterfaces::IsLoopback

(

)

const

Definition at line 201 of file Interfaces.cpp.

{
    return GetFlags() & IFF_LOOPBACK;
}

BOOL CInterfaces::IsMulticast

(

)

const

Definition at line 211 of file Interfaces.cpp.

{
    return GetFlags() & IFF_MULTICAST;
}

BOOL CSocketBase::IsMultiThreaded

(

)

[static, inherited]

Definition at line 329 of file SocketBase.cpp.

{
    return m_bMultiThreaded;
}

BOOL CInterfaces::IsPPP

(

)

const

Definition at line 206 of file Interfaces.cpp.

{
    return GetFlags() & IFF_POINTTOPOINT;
}

BOOL CInterfaces::IsRunning

(

)

const

Definition at line 191 of file Interfaces.cpp.

{
    return GetFlags() & IFF_UP;
}

std::string CSocketBase::LongToStdString

(

unsigned long

ulAddr

)

[static, inherited]

Definition at line 291 of file SocketBase.cpp.

{
    try
    {
        //First create the address
        in_addr addr;

        //Assign it
        addr.S_un.S_addr=ulAddr;

        //Enter the critical section
        CCriticalAutoRelease aRelease(m_pCSection);

        //Return the value
        return inet_ntoa(addr);
    }
    ERROR_HANDLER_STATIC_RETURN(CSocketBase_Class,"LongToStdString","0.0.0.0")
}

char FAR * CSocketBase::LongToString

(

unsigned long

ulAddr

)

[static, inherited]

Definition at line 310 of file SocketBase.cpp.

{
    try
    {
        //First create the address
        in_addr addr;

        //Assign it
        addr.S_un.S_addr=ulAddr;

        //Enter the critical section
        CCriticalAutoRelease aRelease(m_pCSection);

        //Return the value
        return inet_ntoa(addr);
    }
    ERROR_HANDLER_STATIC_RETURN(CSocketBase_Class,"LongToString",NULL)
}

BOOL CInterfaces::MoveNext

(

)

Definition at line 163 of file Interfaces.cpp.

{
    ++m_iPosition;
    return m_iPosition<m_iStructures;
}

void CSocketBase::NotifyShutdown

(

)

[protected, virtual, inherited]

Definition at line 273 of file SocketBase.cpp.

{
}

void CErrorHandler::RegisterError	(	DWORD	dwErrorCode,
		const std::string &	rDescription
	)			[static, inherited]

Definition at line 647 of file ErrorHandler.cpp.

{
    try
    {
        //Add the error
        CErrorsRepository::GetInstance().GetErrorsMap().insert(CErrorsRepository::ErrorMap::value_type(dwErrorCode,rDescription));
    }
    ERROR_HANDLER_STATIC(CErrorHandler_Class,"RegisterError")
}

void CSocketBase::RegisterShutdown

(

CSocketBase *

pBase

)

[protected, inherited]

Definition at line 277 of file SocketBase.cpp.

{
    try
    {
        //Check if we already have a class
        if (m_pShutdownClass)
            delete m_pShutdownClass;

        //Take it
        m_pShutdownClass=pBase;
    }
    ERROR_HANDLER("RegisterShutdown")
}

void CErrorHandler::ReportError	(	const std::string &	rMethod,
		const std::string &	rMessage,
		int	iErrorCode
	)			const [protected, virtual, inherited]

Definition at line 304 of file ErrorHandler.cpp.

{
    if (!GetLog())
        return;

    try
    {
        //Convert the error code
        char aTmp[11];
        sprintf(aTmp,"%d",iErrorCode);

        //Get the string for it
        std::string sError;
        sError=rMessage;
        sError+=", and Socket error: ";
        sError+=aTmp;
        sError+=", ";
        sError+=ErrorCodeToString(iErrorCode);

        //Report to the log
        WriteError(m_sClassName,
                   rMethod,
                   sError);
    }
    ERROR_UNKNOWN("ReportError")
}

void CErrorHandler::ReportError	(	const std::string &	rMethod,
		int	iErrorCode
	)			const [protected, virtual, inherited]

Definition at line 333 of file ErrorHandler.cpp.

{
    if (!GetLog())
        return;

    try
    {
        //Convert the error code
        char aTmp[11];
        sprintf(aTmp,"%d",iErrorCode);

        //Get the string for it
        std::string sError;
        sError="Socket error: ";
        sError+=aTmp;
        sError+=", ";
        sError+=ErrorCodeToString(iErrorCode);

        //Report to the log
        WriteError(m_sClassName,
                   rMethod,
                   sError);
    }
    ERROR_UNKNOWN("ReportError")
}

void CErrorHandler::ReportError	(	const std::string &	rMethod,
		const std::string &	rMessage,
		const std::string &	rAdditionalData
	)			const [protected, virtual, inherited]

Definition at line 461 of file ErrorHandler.cpp.

{
    if (!GetLog())
        return;

    try
    {
        //Create the new message
        std::string sNewMessage(rMessage);
        sNewMessage+=", Additional data: ";
        sNewMessage+=rAdditionalData;

        //Report to the log
        WriteError(m_sClassName,
                   rMethod,
                   sNewMessage);
    }
    ERROR_UNKNOWN("ReportError")
}

void CErrorHandler::ReportError	(	const std::string &	rMethod,
		const std::string &	rMessage,
		DWORD	dwAdditionalData
	)			const [protected, virtual, inherited]

Definition at line 483 of file ErrorHandler.cpp.

{
    if (!GetLog())
        return;

    try
    {
        //Convert the number
        char aTmp[11];
        ltoa(dwAdditionalData,aTmp,10);

        //Create the new message
        std::string sNewMessage(rMessage);
        sNewMessage+=", Additional data: ";
        sNewMessage+=aTmp;

        //Report to the log
        WriteError(m_sClassName,
                   rMethod,
                   sNewMessage);
    }
    ERROR_UNKNOWN("ReportError")
}

void CErrorHandler::ReportError	(	const std::string &	rMethod,
		const std::string &	rMessage
	)			const [protected, virtual, inherited]

Definition at line 376 of file ErrorHandler.cpp.

{
    if (!GetLog())
        return;

    try
    {
        //Report to the log
        WriteError(m_sClassName,
                   rMethod,
                   rMessage);
    }
    ERROR_UNKNOWN("ReportError")
}

void CErrorHandler::ReportError

(

const std::string &

rMethod

)

const [protected, virtual, inherited]

Definition at line 515 of file ErrorHandler.cpp.

{
    if (!GetLog())
        return;

    try
    {
        //Get the last error
        DWORD dwLastError;
        dwLastError=GetLastError();

        //Report the error
        WriteError(m_sClassName,
                   rMethod,
                   ErrorCodeToString(dwLastError));
    }
    ERROR_UNKNOWN("ReportError")
}

void CErrorHandler::ReportErrorOS	(	const std::string &	rMethod,
		const std::string &	rMessage
	)			const [protected, virtual, inherited]

Definition at line 427 of file ErrorHandler.cpp.

{
    if (!GetLog())
        return;

    try
    {
        //Get the last error
        DWORD dwLastError;
        dwLastError=GetLastError();

        //Format the message
        std::string sMessage;
        sMessage=rMessage;
        sMessage+=", with error code: ";

        //Convert the error code
        char aTmp[11];
        itoa(dwLastError,aTmp,10);

        //Add it again
        sMessage+=aTmp;
        sMessage+=" ";
        sMessage+=ErrorCodeToString(dwLastError);

        //Report to the log
        WriteError(m_sClassName,
                   rMethod,
                   sMessage);
    }
    ERROR_UNKNOWN("ReportErrorOS")
}

void CErrorHandler::ReportStaticError	(	const std::string &	rClass,
		const std::string &	rMethod,
		const std::string &	rMessage,
		DWORD	dwAdditionalData
	)			[static, protected, inherited]

Definition at line 590 of file ErrorHandler.cpp.

{
    if (!m_pLog)
        return;

    try
    {
        //Convert the number
        char aTmp[11];
        ltoa(dwAdditionalData,aTmp,10);

        //Create the new message
        std::string sNewMessage(rMessage);
        sNewMessage+=", Additional data: ";
        sNewMessage+=aTmp;

        //Report to the log
        WriteStaticError(rClass,
                         rMethod,
                         sNewMessage);
    }
    ERROR_UNKNOWN("ReportStaticError")
}

void CErrorHandler::ReportStaticError	(	const std::string &	rClass,
		const std::string &	rMethod,
		const std::string &	rMessage
	)			[static, protected, inherited]

Definition at line 573 of file ErrorHandler.cpp.

{
    if (!m_pLog)
        return;

    try
    {
        //Report to the log
        WriteStaticError(rClass,
                         rMethod,
                         rMessage);
    }
    ERROR_UNKNOWN("ReportStaticError")
}

void CErrorHandler::ReportStaticError	(	const std::string &	rClass,
		const std::string &	rMethod
	)			[static, protected, inherited]

Definition at line 553 of file ErrorHandler.cpp.

{
    if (!m_pLog)
        return;

    try
    {
        //Get the last error
        DWORD dwLastError;
        dwLastError=GetLastError();

        //Report the error
        WriteStaticError(rClass,
                          rMethod,
                          ErrorCodeToString(dwLastError));
    }
    ERROR_UNKNOWN("ReportStaticError")
}

void CErrorHandler::ReportStaticErrorOS	(	const std::string &	rClass,
		const std::string &	rMethod,
		const std::string &	rMessage
	)			[static, protected, inherited]

Definition at line 392 of file ErrorHandler.cpp.

{
    if (!m_pLog)
        return;

    try
    {
        //Get the last error
        DWORD dwLastError;
        dwLastError=GetLastError();

        //Format the message
        std::string sMessage;
        sMessage=rMessage;
        sMessage+=", with error code: ";

        //Convert the error code
        char aTmp[11];
        itoa(dwLastError,aTmp,10);

        //Add it again
        sMessage+=aTmp;
        sMessage+=" ";
        sMessage+=ErrorCodeToString(dwLastError);
        
        //Report to the log
        WriteStaticError(rClass,
                         rMethod,
                         sMessage);
    }
    ERROR_UNKNOWN("ReportStaticError")
}

unsigned long CSocketBase::ResolveDNS

(

const std::string &

rAddress

)

[static, inherited]

Definition at line 431 of file SocketBase.cpp.

{
    try
    {
        //Resolve the DNS
        sockaddr_in aAddr;
        aAddr=InternalResolveDNS(rAddress.c_str());

        //Check if valid
        if (aAddr.sin_addr.S_un.S_addr==0)
            //Error
            return 0;
        else
            return aAddr.sin_addr.S_un.S_addr;
    }
    ERROR_HANDLER_STATIC_RETURN(CSocketBase_Class,"ResolveDNS",0)
}

void CSocketBase::SetLastError	(	const std::string &	rMethod,
		int	iErrorCode
	)			const [protected, inherited]

Definition at line 124 of file SocketBase.cpp.

{
    try
    {
        //First set the error
        m_iLastError=iErrorCode;

        //Check if there is an error
        if (m_iLastError)
            ReportError(rMethod,
                        "Through SetLastError",
                        m_iLastError);
    }
    ERROR_HANDLER("SetLastError")
}

void CSocketBase::SetLastError

(

const std::string &

rMethod

)

const [protected, inherited]

Definition at line 104 of file SocketBase.cpp.

{
    try
    {
#ifdef WIN32
        //First set the error
        m_iLastError=WSAGetLastError();
#else
        m_iLastError=errno();
#endif

        //Check if there is an error
        if (m_iLastError)
            ReportError(rMethod,
                        "Through SetLastError",
                        m_iLastError);
    }
    ERROR_HANDLER("SetLastError")
}

void CErrorHandler::SetLocalLog	(	CErrorLog *	pLog,
		bool	bWriteToMain = false
	)			[inherited]

Definition at line 543 of file ErrorHandler.cpp.

{
    //Save the log
    m_pLocalLog=pLog;

    //Save the write to main flag
    m_bWriteToMain=bWriteToMain;
}

void CErrorHandler::SetLog

(

CErrorLog *

pLog

)

[static, inherited]

Definition at line 509 of file ErrorHandler.cpp.

{
    //Save the new log
    m_pLog=pLog;
}

void CErrorHandler::SetName

(

const std::string &

rName

)

const [protected, inherited]

Definition at line 139 of file ErrorHandler.cpp.

{
    //Save the class name
    m_sClassName=rName;
}

BOOL CSocketBase::ShutdownSockets

(

)

[static, inherited]

Definition at line 231 of file SocketBase.cpp.

{
    //Only if initialized
    if (!m_bInitialized)
        return TRUE;

    try
    {
        //Delete the CS
        delete m_pCSection;
        m_pCSection=NULL;

        //Delete the DNS CS
        delete m_pCSectionDNS;
        m_pCSectionDNS=NULL;

        //Clear the DNS map
        m_aDNSMap.clear();

        //Notify shutdown class
        if (m_pShutdownClass)
        {
            //Notify we are shuting down
            m_pShutdownClass->NotifyShutdown();

            //Delete it
            delete m_pShutdownClass;
            m_pShutdownClass=NULL;
        }

        //Not initialized anymore
        m_bInitialized=FALSE;

        if (WSACleanup()==GetErrorCode())
            return FALSE;

        //Done
        return TRUE;
    }
    ERROR_HANDLER_STATIC_RETURN(CSocketBase_Class,"ShutdownSockets",FALSE)
}

unsigned long CSocketBase::StringToLong

(

const std::string &

rAddress

)

[static, inherited]

Definition at line 344 of file SocketBase.cpp.

{
    //Try to convert it
    unsigned long ulAddress;
    ulAddress=inet_addr(rAddress.c_str());

    //Is it valid
    if (ulAddress!=INADDR_NONE)
        return ulAddress;
    else
        //Try to resolve it
        return ResolveDNS(rAddress);
}

BOOL CSocketBase::ValidAddress

(

const std::string &

rAddress

)

[static, inherited]

Definition at line 373 of file SocketBase.cpp.

{
    try
    {
        return inet_addr(rAddress.c_str())!=INADDR_NONE;
    }
    ERROR_HANDLER_STATIC_RETURN(CSocketBase_Class,"ValidAddress",FALSE)
}

void CErrorHandler::WriteError	(	const std::string &	rClass,
		const std::string &	rMethod,
		const std::string &	rError
	)			const [inherited]

Definition at line 168 of file ErrorHandler.cpp.

{
    //Do we have a log?
    if (!GetLog())
        return;

    //Format the msg
    std::string sError;
    sError=FormatData(rClass,
                      rMethod,
                      rError);

    //Write it
    GetLog()->WriteError(sError);

    //Write to main
    if (m_bWriteToMain &&
        m_pLog)
        //Write it
        m_pLog->WriteError(sError);
}

void CErrorHandler::WriteMessage	(	const std::string &	rMethod,
		const std::string &	rMessage
	)			const [protected, inherited]

Definition at line 360 of file ErrorHandler.cpp.

{
    if (!GetLog())
        return;

    try
    {
        //Report to the log
        WriteMessage(m_sClassName,
                     rMethod,
                     rMessage);
    }
    ERROR_UNKNOWN("WriteMessage")
}

void CErrorHandler::WriteMessage	(	const std::string &	rClass,
		const std::string &	rMethod,
		const std::string &	rMessage
	)			const [inherited]

Definition at line 226 of file ErrorHandler.cpp.

{
    //Do we have a log?
    if (!GetLog())
        return;

    //Format the msg
    std::string sMsg;
    sMsg=FormatData(rClass,
                    rMethod,
                    rMessage,
                    false);

    //Write it
    GetLog()->WriteMessage(sMsg);

    //Write to main
    if (m_bWriteToMain &&
        m_pLog)
        //Write it
        m_pLog->WriteMessage(sMsg);
}

void CErrorHandler::WriteStaticError	(	const std::string &	rClass,
		const std::string &	rMethod,
		const std::string &	rError
	)			[static, inherited]

Definition at line 192 of file ErrorHandler.cpp.

{
    //Do we have a log?
    if (!m_pLog)
        return;

    //Format the msg
    std::string sError;
    sError=FormatData(rClass,
                      rMethod,
                      rError);

    //Write it
    m_pLog->WriteError(sError);
}

void CErrorHandler::WriteStaticMessage	(	const std::string &	rClass,
		const std::string &	rMethod,
		const std::string &	rMessage
	)			[static, inherited]

Definition at line 210 of file ErrorHandler.cpp.

{
    //Do we have a log?
    if (!m_pLog)
        return;

    //Format the msg
    std::string sMsg;
    sMsg=FormatData(rClass,
                    rMethod,
                    rMessage,
                    false);
}

---

Member Data Documentation

CGenericCriticalSection * CSocketBase::m_pCSection = NULL [static, protected, inherited]

Definition at line 122 of file SocketBase.h.

---

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

• Interfaces.h
• Interfaces.cpp