VsnetSocket Class Reference

#include <vsnet_socketbase.h>

Inheritance diagram for VsnetSocket:

Public Member Functions
	VsnetSocket (int sock, const AddressIP &remote_ip, const char *socktype, SocketSet &set)
virtual	~VsnetSocket ()
virtual bool	isTcp () const =0
virtual int	optPayloadSize () const =0
virtual int	queueLen (int pri)=0
bool	eq (const VsnetSocket &r) const
bool	lt (const VsnetSocket &r) const
bool	sameAddress (const VsnetSocket &r) const
virtual int	sendbuf (Packet *packet, const AddressIP *to, int pcktflags)=0
virtual int	recvbuf (Packet *p, AddressIP *from)=0
virtual void	dump (std::ostream &ostr) const =0
const AddressIP &	getRemoteAddress () const
virtual bool	setRemoteAddress (const AddressIP &)
const AddressIP &	getLocalAddress () const
bool	setLocalAddress (const AddressIP &lip)
Public Member Functions inherited from VsnetSocketBase
	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 Attributes
AddressIP	_remote_ip
AddressIP	_local_ip
Protected Attributes inherited from VsnetSocketBase
int	_fd
SocketSet *	_set

Friends
std::ostream &	operator<< (std::ostream &ostr, const VsnetSocket &s)

Additional Inherited Members
Protected Member Functions inherited from VsnetSocketBase
virtual void	child_disconnect (const char *s)

Detailed Description

Definition at line 107 of file vsnet_socketbase.h.

Constructor & Destructor Documentation

VsnetSocket::VsnetSocket	(	int	sock,
		const AddressIP &	remote_ip,
		const char *	socktype,
		SocketSet &	set
	)

Definition at line 16 of file vsnet_socketbase.cpp.

References VsnetSocket().

Referenced by VsnetSocket().

                                                                                                      :
    VsnetSocketBase( sock, socktype, sets )
    , _remote_ip( remote_ip )
{}

VsnetSocket::~VsnetSocket ( )

virtual

Definition at line 21 of file vsnet_socketbase.cpp.

{}

Member Function Documentation

virtual void VsnetSocket::dump ( std::ostream &  ostr) const

pure virtual

Implemented in VsnetTCPSocket, and VsnetUDPSocket.

Referenced by operator<<().

bool VsnetSocket::eq

(

const VsnetSocket &

r)

const

Definition at line 31 of file vsnet_socketbase.cpp.

References _remote_ip, VsnetSocketBase::get_fd(), and isTcp().

{
    return ( isTcp() == r.isTcp() ) && ( get_fd() == r.get_fd() ) && (_remote_ip == r._remote_ip);
}

const AddressIP& VsnetSocket::getLocalAddress ( ) const

inline

Definition at line 144 of file vsnet_socketbase.h.

References _local_ip.

    {
        return _local_ip;
    }

const AddressIP& VsnetSocket::getRemoteAddress ( ) const

inline

Definition at line 134 of file vsnet_socketbase.h.

References _remote_ip.

    {
        return _remote_ip;
    }

virtual bool VsnetSocket::isTcp ( ) const

pure virtual

Implemented in VsnetTCPSocket, and VsnetUDPSocket.

Referenced by eq(), lt(), and sameAddress().

bool VsnetSocket::lt

(

const VsnetSocket &

r)

const

Definition at line 36 of file vsnet_socketbase.cpp.

References _remote_ip, VsnetSocketBase::get_fd(), and isTcp().

{
    if ( !isTcp() && r.isTcp() ) return true;
    if ( isTcp() == r.isTcp() ) {
        if ( get_fd() < r.get_fd() ) return true;
        if ( get_fd() == r.get_fd() )
            if (_remote_ip < r._remote_ip) return true;
    }
    return false;
}

virtual int VsnetSocket::optPayloadSize ( ) const

pure virtual

Implemented in VsnetTCPSocket, and VsnetUDPSocket.

virtual int VsnetSocket::queueLen ( int  pri)

pure virtual

Implemented in VsnetTCPSocket, and VsnetUDPSocket.

virtual int VsnetSocket::recvbuf ( Packet *  p, AddressIP *  from  )

pure virtual

This function copies or moves data into the given PacketMem variable. It is preferred over the other recvbuf function because it may reduce the number of copy operations by at least one.

Implemented in VsnetTCPSocket, and VsnetUDPSocket.

bool VsnetSocket::sameAddress

(

const VsnetSocket &

r)

const

Definition at line 47 of file vsnet_socketbase.cpp.

References _remote_ip, and isTcp().

{
    const VsnetSocket *r2 = (const VsnetSocket*) &r;
    return ( isTcp() == r2->isTcp() ) && (_remote_ip == r2->_remote_ip);
}

virtual int VsnetSocket::sendbuf ( Packet *  packet, const AddressIP *  to, int  pcktflags  )

pure virtual

Implemented in VsnetTCPSocket, and VsnetUDPSocket.

bool VsnetSocket::setLocalAddress ( const AddressIP &  lip)

inline

Definition at line 148 of file vsnet_socketbase.h.

References _local_ip.

    {
        _local_ip = lip;
        return true;
    }

virtual bool VsnetSocket::setRemoteAddress ( const AddressIP &  )

inlinevirtual

Reimplemented in VsnetUDPSocket.

Definition at line 138 of file vsnet_socketbase.h.

    {
        return false;
    }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  ostr, const VsnetSocket &  s  )

friend

Member Data Documentation

AddressIP VsnetSocket::_local_ip

protected

Definition at line 157 of file vsnet_socketbase.h.

Referenced by getLocalAddress(), and setLocalAddress().

AddressIP VsnetSocket::_remote_ip

protected

Definition at line 156 of file vsnet_socketbase.h.

Referenced by VsnetUDPSocket::dump(), VsnetTCPSocket::dump(), eq(), getRemoteAddress(), lt(), VsnetTCPSocket::recvbuf(), sameAddress(), VsnetUDPSocket::sendbuf(), and VsnetUDPSocket::setRemoteAddress().

---

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

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