vsnet_debug.h File Reference

#include <boost/version.hpp>
#include <config.h>
#include <iostream>
#include <assert.h>
#include <stdio.h>

Go to the source code of this file.

Macros
#define	VSNET_DEBUG
#define	COUT   vsnetDbgOut( __FILE__, __LINE__ )
#define	FIND_WIN_NBIO
#define	PTHREAD_SELF_OR_NONE   0
#define	DECLARE_VALID
#define	MAKE_VALID
#define	MAKE_INVALID
#define	CHECK_VALID   validate( __FILE__, __LINE__ );
#define	CHECK_VALID_OBJ(a)   (a).validate( __FILE__, __LINE__ );
#define	ASSERT(a)
#define	PSEUDO__LINE__(x)   __LINE__

Functions
std::ostream &	vsnetDbgOut (const char *file, int line)

Macro Definition Documentation

#define ASSERT

(

a)

Value:

if ( !(a) ) {std::cerr<<__FILE__<<":"<<__LINE__ \
                          <<" assertion failed, forcing segfault for postmortem debugging"; int x = 1/0; }

Definition at line 75 of file vsnet_debug.h.

#define CHECK_VALID   validate( __FILE__, __LINE__ );

Definition at line 69 of file vsnet_debug.h.

Referenced by VsnetSocketBase::close_fd(), Packet::copyfrom(), VsnetSocketBase::disconnect(), Packet::display(), Packet::displayHex(), PacketMem::dump(), VsnetSocketBase::get_fd(), VsnetSocketBase::get_nonblock(), PacketMem::getConstBuf(), Packet::getData(), Packet::getSendBuffer(), PacketMem::getVarBuf(), PacketMem::len(), PacketMem::operator=(), PacketMem::operator==(), Packet::send(), PacketMem::set(), VsnetSocketBase::set_block(), VsnetSocketBase::set_nonblock(), VsnetSocketBase::valid(), Packet::~Packet(), PacketMem::~PacketMem(), and VsnetSocketBase::~VsnetSocketBase().

#define CHECK_VALID_OBJ

(

a)

(a).validate( __FILE__, __LINE__ );

Definition at line 72 of file vsnet_debug.h.

#define COUT   vsnetDbgOut( __FILE__, __LINE__ )

Definition at line 25 of file vsnet_debug.h.

Referenced by ServerSocketTCP::acceptNewConn(), AcctLogout(), ZoneMgr::addClient(), NetClient::AddClientObject(), VsnetDownload::Server::Manager::addCmdDownload(), VsnetDownload::Client::Manager::addItems(), NetClient::AddObjects(), ZoneMgr::addPosition(), ZoneMgr::addZone(), NetClient::authenticate(), ZoneMgr::broadcast(), VsnetDownload::Client::Item::changeState(), ServerSocket::child_disconnect(), VsnetTCPSocket::child_disconnect(), VsnetDownload::Server::Manager::cleanDownload(), NetUIBase::createClientSocket(), NetUIBase::createServerSocket(), NetUITCP::createServerSocket(), NetUIUDP::createServerSocket(), NetUITCP::createSocket(), NetUIUDP::createSocket(), NetClient::downloadZoneInfo(), ZoneMgr::getZoneBuffer(), NetClient::inGame(), NetClient::init(), NetClient::init_acct(), VsnetDownload::Server::LOCALCONST_DEF(), NetClient::loginAccept(), NetClient::loginAcctLoop(), NetClient::loginAuth(), NetClient::loginLoop(), NetUIBase::lookupHost(), VsnetDownload::Server::Manager::lower_check_queues(), VsnetTCPSocket::lower_clean_sendbuf(), VsnetUDPSocket::lower_selected(), VsnetHTTPSocket::lower_selected(), VsnetTCPSocket::lower_selected(), ServerSocketTCP::lower_selected(), VsnetHTTPSocket::lower_sendbuf(), VsnetTCPSocket::lower_sendbuf(), VsnetDownload::Client::Manager::Manager(), VsnetDownload::Server::Manager::Manager(), VsnetTCPSocket::need_test_writable(), Packet::Packet(), VsnetDownload::Client::Manager::processCmdDownload(), UniverseUtil::receivedCustom(), NetClient::Reconnect(), VsnetTCPSocket::recvbuf(), AccountServer::recvMsg(), AccountServer::removeDeadSockets(), NetServer::saveAccount(), VsnetUDPSocket::sendbuf(), NetServer::sendNewUnitQueue(), NetClient::sendPosition(), VsnetSocketBase::set_block(), VsnetSocketBase::set_nonblock(), AccountServer::start(), NetServer::start(), static_initNetwork(), NetClient::synchronizeTime(), VsnetDownload::Client::TestItem::TestItem(), VsnetTCPSocket::VsnetTCPSocket(), SocketSet::wait(), and VsnetTCPSocket::~VsnetTCPSocket().

#define DECLARE_VALID

Value:

private:                                                                                         \
    bool _valid;                                                                                 \
    bool _invalid;                                                                               \
public:                                                                                          \
    void validate( const char *file, int line ) const {                                          \
        if (!_valid || _invalid) {                                                               \
            fprintf( stderr, "object invalid in %s:%d:%d\n", file, line, PTHREAD_SELF_OR_NONE ); \
        }                                                                                        \
        assert( _valid );                                                                        \
        assert( !_invalid );                                                                     \
    }

Definition at line 48 of file vsnet_debug.h.

#define FIND_WIN_NBIO

Definition at line 29 of file vsnet_debug.h.

#define MAKE_INVALID

Value:

_valid   = false;  \
    _invalid = true;

Definition at line 65 of file vsnet_debug.h.

Referenced by Packet::~Packet(), PacketMem::~PacketMem(), and VsnetSocketBase::~VsnetSocketBase().

#define MAKE_VALID

Value:

_valid   = true; \
    _invalid = false;

Definition at line 61 of file vsnet_debug.h.

Referenced by Packet::Packet(), PacketMem::PacketMem(), and VsnetSocketBase::VsnetSocketBase().

#define PSEUDO__LINE__

(

x)

__LINE__

Definition at line 90 of file vsnet_debug.h.

Referenced by VsnetDownload::Server::Manager::addCmdDownload(), NetClient::authenticate(), NetServer::broadcast(), NetServer::BroadcastCargoUpgrade(), ZoneMgr::broadcastDamage(), NetServer::BroadcastFire(), ZoneMgr::broadcastSnapshots(), NetServer::BroadcastTarget(), NetServer::BroadcastUnfire(), NetClient::init(), NetClient::loginAuth(), NetClient::logout(), NetClient::respawnRequest(), NetClient::selectShip(), NetClient::sendAlive(), NetServer::sendCargoSnapshot(), NetServer::sendCredits(), NetServer::sendDamages(), NetServer::sendDockAuthorize(), NetServer::sendForcePosition(), NetServer::sendKill(), NetworkCommunication::SendMessage(), NetServer::sendMessage(), NetServer::sendMission(), NetServer::sendNewUnitQueue(), NetServer::sendSaveData(), NetworkCommunication::SendSound(), NetServer::sendUnDock(), NetServer::start(), NetClient::startCommunication(), NetClient::stopCommunication(), NetClient::synchronizeTime(), and NetClient::textMessage().

#define PTHREAD_SELF_OR_NONE   0

The following macros are intended for default versions a class validity debugging. The idea is to increase the likelyhood that uninitialized and re-initialized memory areas are captured as well as possible.

Definition at line 40 of file vsnet_debug.h.

Referenced by vsnetDbgOut().

#define VSNET_DEBUG

Definition at line 12 of file vsnet_debug.h.

Function Documentation

std::ostream& vsnetDbgOut	(	const char *	file,
		int	line
	)

Definition at line 27 of file vsnet_debug.cpp.

References accountXML::file, and PTHREAD_SELF_OR_NONE.

{
    const char *printme = file;
    int len = strlen( file );
    if (len > 30) printme = &file[len-30];
#ifdef VSNET_DEBUG
    clog<<PTHREAD_SELF_OR_NONE<<" "
    <<time_trigger
    <<" "<<printme<<":"<<line<<" ";
#else /* !VSNET_DEBUG */
    clog<<printme<<":"<<line<<" ";
#endif /* VSNET_DEBUG */
    return clog;
}