VsnetSocketBase Class Reference

#include <vsnet_socketbase.h>

Inheritance diagram for VsnetSocketBase:

Public Member Functions
	VsnetSocketBase (int fd, const char *socktype, SocketSet &set)
virtual	~VsnetSocketBase ()
bool	valid () const
int	get_fd () const
int	close_fd ()
const char *	get_socktype () const
bool	set_block ()
bool	set_nonblock ()
bool	get_nonblock () const
virtual bool	isActive ()=0
void	disconnect (const char *s)
virtual bool	lower_selected (int datalen=-1)=0
virtual bool	need_test_writable ()
virtual bool	write_on_negative ()
virtual int	get_write_fd () const
virtual int	lower_sendbuf ()
virtual void	lower_clean_sendbuf ()
virtual bool	isReadyToSend (fd_set *)
void	setSet (SocketSet *set)

Protected Member Functions
virtual void	child_disconnect (const char *s)

Protected Attributes
int	_fd
SocketSet *	_set

Detailed Description

Definition at line 38 of file vsnet_socketbase.h.

Constructor & Destructor Documentation

VsnetSocketBase::VsnetSocketBase	(	int	fd,
		const char *	socktype,
		SocketSet &	set
	)

Definition at line 57 of file vsnet_socketbase.cpp.

References MAKE_VALID, SocketSet::set(), set_block(), and VsnetSocketBase().

Referenced by VsnetSocketBase().

                                                                                :
    _fd( fd )
    , _set( &sets )
    , _noblock( -1 )
{
    MAKE_VALID

    char buf[100];

    sprintf( buf, "%d", fd );
    unsigned int len = strlen( socktype )+strlen( buf )+4;
    _socktype = new char[len];

    sprintf( _socktype, "%s (%s)", buf, socktype );

    assert( strlen( _socktype ) == len-1 );
    if (fd >= 0)
        set_block();
    sets.set( this );
}

VsnetSocketBase::~VsnetSocketBase ( )

virtual

Definition at line 81 of file vsnet_socketbase.cpp.

References _set, CHECK_VALID, MAKE_INVALID, and SocketSet::unset().

{
    CHECK_VALID
    if (_set) _set->unset( this );
    delete[] _socktype;
    MAKE_INVALID
}

Member Function Documentation

virtual void VsnetSocketBase::child_disconnect ( const char *  s)

inlineprotectedvirtual

Reimplemented in VsnetTCPSocket, and ServerSocket.

Definition at line 86 of file vsnet_socketbase.h.

Referenced by disconnect().

{}

int VsnetSocketBase::close_fd

(

)

Definition at line 113 of file vsnet_socketbase.cpp.

References _fd, CHECK_VALID, and VsnetOSS::close_socket().

Referenced by VsnetTCPSocket::child_disconnect(), VsnetHTTPSocket::lower_selected(), VsnetTCPSocket::lower_selected(), VsnetHTTPSocket::lower_sendbuf(), VsnetTCPSocket::recvbuf(), VsnetHTTPSocket::reopenConnection(), VsnetHTTPSocket::resendData(), and VsnetTCPSocket::~VsnetTCPSocket().

{
    CHECK_VALID
    int ret = 0;
    if (_fd >= 0) {
        ret = VsnetOSS::close_socket( _fd );
        _fd = -1;
    }
    return ret;
}

void VsnetSocketBase::disconnect

(

const char *

s)

Definition at line 156 of file vsnet_socketbase.cpp.

References _fd, _set, CHECK_VALID, child_disconnect(), and SocketSet::unset().

{
    CHECK_VALID
    if (_fd > 0)
        if (_set) _set->unset( this );
    child_disconnect( s );
}

int VsnetSocketBase::get_fd

(

)

const

Definition at line 107 of file vsnet_socketbase.cpp.

References _fd, and CHECK_VALID.

Referenced by ServerSocketTCP::acceptNewConn(), ServerSocketUDP::acceptNewConn(), ServerSocket::child_disconnect(), VsnetTCPSocket::child_disconnect(), VsnetUDPSocket::dump(), VsnetTCPSocket::dump(), VsnetSocket::eq(), VsnetUDPSocket::lower_selected(), VsnetHTTPSocket::lower_selected(), VsnetTCPSocket::lower_selected(), ServerSocketTCP::lower_selected(), VsnetSocket::lt(), operator<<(), operator==(), VsnetUDPSocket::recvbuf(), VsnetUDPSocket::sendbuf(), and VsnetTCPSocket::~VsnetTCPSocket().

{
    CHECK_VALID
    return _fd;
}

bool VsnetSocketBase::get_nonblock

(

)

const

Definition at line 150 of file vsnet_socketbase.cpp.

References CHECK_VALID.

Referenced by VsnetTCPSocket::lower_selected().

{
    CHECK_VALID
    return _noblock == 1;
}

const char * VsnetSocketBase::get_socktype

(

)

const

Definition at line 96 of file vsnet_socketbase.cpp.

{
    return _socktype;
}

virtual int VsnetSocketBase::get_write_fd ( ) const

inlinevirtual

Reimplemented in VsnetTCPSocket.

Definition at line 70 of file vsnet_socketbase.h.

References _fd.

Referenced by VsnetHTTPSocket::isReadyToSend(), and isReadyToSend().

    {
        return _fd;
    }

virtual bool VsnetSocketBase::isActive ( )

pure virtual

Implemented in ServerSocketUDP, ServerSocketTCP, VsnetHTTPSocket, VsnetTCPSocket, and VsnetUDPSocket.

bool VsnetSocketBase::isReadyToSend ( fd_set *  write_set_select)

virtual

Reimplemented in VsnetHTTPSocket.

Definition at line 77 of file vsnet_socketbase.cpp.

References get_write_fd().

{
    return get_write_fd() >= 0 && FD_ISSET( get_write_fd(), write_set_select );
}

virtual void VsnetSocketBase::lower_clean_sendbuf ( )

inlinevirtual

Called when we noticed that the primary file descriptor is closed but data remains in the send queue.

Reimplemented in VsnetTCPSocket, and VsnetHTTPSocket.

Definition at line 81 of file vsnet_socketbase.h.

{}

virtual bool VsnetSocketBase::lower_selected ( int  datalen = -1)

pure virtual

Implemented in ServerSocketUDP, ServerSocketTCP, VsnetTCPSocket, VsnetHTTPSocket, and VsnetUDPSocket.

virtual int VsnetSocketBase::lower_sendbuf ( )

inlinevirtual

Reimplemented in VsnetTCPSocket, and VsnetHTTPSocket.

Definition at line 74 of file vsnet_socketbase.h.

    {
        return 0;
    }

virtual bool VsnetSocketBase::need_test_writable ( )

inlinevirtual

Reimplemented in VsnetTCPSocket, and VsnetHTTPSocket.

Definition at line 62 of file vsnet_socketbase.h.

    {
        return false;
    }

bool VsnetSocketBase::set_block

(

)

Definition at line 137 of file vsnet_socketbase.cpp.

References _fd, CHECK_VALID, COUT, VsnetOSS::set_blocking(), and valid().

Referenced by VsnetSocketBase().

{
    CHECK_VALID
    if ( !valid() ) {
        COUT<<"Failed to set blocking socket "<<_socktype<<std::endl;
        return false;
    }
    bool ret = VsnetOSS::set_blocking( _fd, true );
    if (ret)
        _noblock = 0;
    return ret;
}

bool VsnetSocketBase::set_nonblock

(

)

Definition at line 124 of file vsnet_socketbase.cpp.

References _fd, CHECK_VALID, COUT, VsnetOSS::set_blocking(), and valid().

{
    CHECK_VALID
    if ( !valid() ) {
        COUT<<"Failed to set blocking socket "<<_socktype<<std::endl;
        return false;
    }
    bool ret = VsnetOSS::set_blocking( _fd, false );
    if (ret)
        _noblock = 1;
    return ret;
}

void VsnetSocketBase::setSet

(

SocketSet *

set)

Definition at line 89 of file vsnet_socketbase.cpp.

References _set, SocketSet::set(), and SocketSet::unset().

{
    if (this->_set) this->_set->unset( this );
    this->_set = set;
    if (this->_set) this->_set->set( this );
}

bool VsnetSocketBase::valid

(

)

const

Definition at line 101 of file vsnet_socketbase.cpp.

References _fd, and CHECK_VALID.

Referenced by set_block(), set_nonblock(), and VsnetTCPSocket::~VsnetTCPSocket().

{
    CHECK_VALID
    return _fd >= 0;
}

virtual bool VsnetSocketBase::write_on_negative ( )

inlinevirtual

Reimplemented in VsnetHTTPSocket.

Definition at line 66 of file vsnet_socketbase.h.

    {
        return false;
    }

Member Data Documentation

int VsnetSocketBase::_fd

protected

Definition at line 90 of file vsnet_socketbase.h.

Referenced by close_fd(), disconnect(), get_fd(), get_write_fd(), VsnetHTTPSocket::lower_clean_sendbuf(), VsnetHTTPSocket::lower_selected(), VsnetHTTPSocket::lower_sendbuf(), VsnetHTTPSocket::need_test_writable(), VsnetHTTPSocket::reopenConnection(), VsnetHTTPSocket::resendData(), set_block(), set_nonblock(), and valid().

SocketSet* VsnetSocketBase::_set

protected

Definition at line 96 of file vsnet_socketbase.h.

Referenced by ServerSocketTCP::acceptNewConn(), ServerSocketUDP::acceptNewConn(), disconnect(), VsnetTCPSocket::inner_complete_a_packet(), VsnetTCPSocket::isActive(), VsnetUDPSocket::lower_selected(), VsnetTCPSocket::lower_selected(), ServerSocketTCP::lower_selected(), VsnetTCPSocket::private_nothread_conditional_write(), VsnetUDPSocket::recvbuf(), VsnetTCPSocket::recvbuf(), VsnetTCPSocket::sendbuf(), setSet(), and ~VsnetSocketBase().

---

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

• src/networking/lowlevel/vsnet_socketbase.h
• src/networking/lowlevel/vsnet_socketbase.cpp