C4NetIOTCP::Peer Class Reference

#include <C4NetIO.h>

Collaboration diagram for C4NetIOTCP::Peer:

Public Member Functions
	Peer (const C4NetIO::addr_t &naddr, SOCKET nsock, C4NetIOTCP *pnParent)
	~Peer ()
const C4NetIO::addr_t &	GetAddr () const
SOCKET	GetSocket () const
int	GetIRate () const
int	GetORate () const
bool	Send (const C4NetIOPacket &rPacket)
bool	Send ()
void *	GetRecvBuf (int iSize)
void	OnRecv (int iSize)
void	Close ()
bool	Open () const
bool	doBroadcast () const
bool	hasWaitingData () const
void	SetBroadcast (bool fSet)
void	ClearStatistics ()

Public Attributes
Peer *	Next

Protected Attributes
C4NetIOTCP *const	pParent
C4NetIO::addr_t	addr
SOCKET	sock
StdBuf	IBuf
StdBuf	OBuf
int	iIBufUsage
int	iIRate
int	iORate
bool	fOpen
bool	fDoBroadcast
CStdCSec	ICSec
CStdCSec	OCSec

Static Protected Attributes
static const unsigned int	iTCPHeaderSize = 28 + 24
static const unsigned int	iMinIBufSize = 8192

Detailed Description

Definition at line 400 of file C4NetIO.h.

Constructor & Destructor Documentation

Peer()

C4NetIOTCP::Peer::Peer	(	const C4NetIO::addr_t &	naddr,
		SOCKET	nsock,
		C4NetIOTCP *	pnParent
	)

Definition at line 1735 of file C4NetIO.cpp.

        : pParent(pnParent),
        addr(naddr), sock(nsock),
        iIBufUsage(0), iIRate(0), iORate(0),
        fOpen(true), fDoBroadcast(false), Next(nullptr)
{
}

~Peer()

C4NetIOTCP::Peer::~Peer

(

)

Definition at line 1743 of file C4NetIO.cpp.

{
    // close socket
    Close();
}

References C4NetIOTCP::Close().

Here is the call graph for this function:

Member Function Documentation

ClearStatistics()

void C4NetIOTCP::Peer::ClearStatistics

(

)

Definition at line 1879 of file C4NetIO.cpp.

{
    CStdLock ILock(&ICSec); CStdLock OLock(&OCSec);
    iIRate = iORate = 0;
}

Close()

void C4NetIOTCP::Peer::Close

(

)

Definition at line 1864 of file C4NetIO.cpp.

{
    CStdLock ILock(&ICSec); CStdLock OLock(&OCSec);
    if (!fOpen) return;
    // close socket
    closesocket(sock);
    // set flag
    fOpen = false;
    // clear buffers
    IBuf.Clear(); OBuf.Clear();
    iIBufUsage = 0;
    // reset statistics
    iIRate = iORate = 0;
}

References closesocket.

Referenced by C4NetIOTCP::Accept(), and C4NetIOTCP::Close().

Here is the caller graph for this function:

doBroadcast()

bool C4NetIOTCP::Peer::doBroadcast ( ) const

inline

Definition at line 445 of file C4NetIO.h.

{ return fDoBroadcast; }

References fDoBroadcast.

GetAddr()

const C4NetIO::addr_t& C4NetIOTCP::Peer::GetAddr ( ) const

inline

Definition at line 428 of file C4NetIO.h.

{ return addr; }

References addr.

Referenced by C4NetIOTCP::Close().

Here is the caller graph for this function:

GetIRate()

int C4NetIOTCP::Peer::GetIRate ( ) const

inline

Definition at line 430 of file C4NetIO.h.

{ return iIRate; }

References iIRate.

Referenced by C4NetIOTCP::GetConnStatistic().

Here is the caller graph for this function:

GetORate()

int C4NetIOTCP::Peer::GetORate ( ) const

inline

Definition at line 431 of file C4NetIO.h.

{ return iORate; }

References iORate.

Referenced by C4NetIOTCP::GetConnStatistic().

Here is the caller graph for this function:

GetRecvBuf()

void * C4NetIOTCP::Peer::GetRecvBuf

(

int

iSize

)

Definition at line 1805 of file C4NetIO.cpp.

{
    CStdLock ILock(&ICSec);
    // Enlarge input buffer?
    size_t iIBufSize = std::max<size_t>(iMinIBufSize, IBuf.getSize());
    while ((size_t)(iIBufUsage + iSize) > iIBufSize)
        iIBufSize *= 2;
    if (iIBufSize != IBuf.getSize())
        IBuf.SetSize(iIBufSize);
    // Return the appropriate part of the input buffer
    return IBuf.getMPtr(iIBufUsage);
}

References iSize.

GetSocket()

SOCKET C4NetIOTCP::Peer::GetSocket ( ) const

inline

Definition at line 429 of file C4NetIO.h.

{ return sock; }

References sock.

hasWaitingData()

bool C4NetIOTCP::Peer::hasWaitingData ( ) const

inline

Definition at line 447 of file C4NetIO.h.

{ return !OBuf.isNull(); }

References StdBuf::isNull(), and OBuf.

Here is the call graph for this function:

OnRecv()

void C4NetIOTCP::Peer::OnRecv

(

int

iSize

)

Definition at line 1818 of file C4NetIO.cpp.

{
    CStdLock ILock(&ICSec);
    // increase input rate and input buffer usage
    iIRate += iTCPHeaderSize + iSize;
    iIBufUsage += iSize;
    // a prior call to GetRecvBuf should have ensured this
    assert(static_cast<size_t>(iIBufUsage) <= IBuf.getSize());
    // read packets
    size_t iPos = 0, iPacketPos;
    while ((iPacketPos = iPos) < (size_t)iIBufUsage)
    {
        // Try to unpack a packet
        StdBuf IBufPart = IBuf.getPart(iPos, iIBufUsage - iPos);
        int32_t iBytes = pParent->UnpackPacket(IBufPart, addr);
        // Could not unpack?
        if (!iBytes)
            break;
        // Advance
        iPos += iBytes;
    }
    // data left?
    if (iPacketPos < (size_t) iIBufUsage)
    {
        // no packet read?
        if (!iPacketPos) return;
        // move data
        IBuf.Move(iPacketPos, IBuf.getSize() - iPacketPos);
        iIBufUsage -= iPacketPos;
        // shrink buffer
        size_t iIBufSize = IBuf.getSize();
        while ((size_t) iIBufUsage <= iIBufSize / 2)
            iIBufSize /= 2;
        if (iIBufSize != IBuf.getSize())
            IBuf.Shrink(iPacketPos);
    }
    else
    {
        // the buffer is empty
        iIBufUsage = 0;
        // shrink buffer to minimum
        if (IBuf.getSize() > iMinIBufSize)
            IBuf.SetSize(iMinIBufSize);
    }
}

References StdBuf::getPart(), iSize, and StdBuf::Move().

Here is the call graph for this function:

Open()

bool C4NetIOTCP::Peer::Open ( ) const

inline

Definition at line 443 of file C4NetIO.h.

{ return fOpen; }

References fOpen.

Referenced by C4NetIOTCP::GetConnStatistic(), and C4NetIOTCP::OnShareFree().

Here is the caller graph for this function:

Send() [1/2]

bool C4NetIOTCP::Peer::Send

(

)

Definition at line 1766 of file C4NetIO.cpp.

{
    CStdLock OLock(&OCSec);
    if (OBuf.isNull()) return true;
 
    // send as much as possibile
    int iBytesSent;
    if ((iBytesSent = ::send(sock, getBufPtr<char>(OBuf), OBuf.getSize(), 0)) == SOCKET_ERROR)
        if (!HaveWouldBlockError())
        {
            pParent->SetError("send failed", true);
            return false;
        }
 
    // nothin sent?
    if (iBytesSent == SOCKET_ERROR || !iBytesSent) return true;
 
    // increase output rate
    iORate += iBytesSent + iTCPHeaderSize;
 
    // data remaining?
    if (unsigned(iBytesSent) < OBuf.getSize())
    {
        // Shrink buffer
        OBuf.Move(iBytesSent, OBuf.getSize() - iBytesSent);
        OBuf.Shrink(iBytesSent);
#ifndef STDSCHEDULER_USE_EVENTS
        // Unblock parent so the FD-list can be refreshed
        pParent->UnBlock();
#endif
    }
    else
        // just delete buffer
        OBuf.Clear();
 
    // ok
    return true;
}

References HaveWouldBlockError(), and SOCKET_ERROR.

Here is the call graph for this function:

Send() [2/2]

bool C4NetIOTCP::Peer::Send

(

const C4NetIOPacket &

rPacket

)

Definition at line 1751 of file C4NetIO.cpp.

{
    CStdLock OLock(&OCSec);
 
    // already data pending to be sent? try to sent them first (empty buffer)
    if (!OBuf.isNull()) Send();
    bool fSend = OBuf.isNull();
 
    // pack packet
    pParent->PackPacket(rPacket, OBuf);
 
    // (try to) send
    return fSend ? Send() : true;
}

References C4NetIOTCP::Send().

Referenced by C4NetIOTCP::Send().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBroadcast()

void C4NetIOTCP::Peer::SetBroadcast ( bool  fSet )

inline

Definition at line 449 of file C4NetIO.h.

{ fDoBroadcast = fSet; }

References fDoBroadcast.

Referenced by C4NetIOTCP::SetBroadcast().

Here is the caller graph for this function:

Member Data Documentation

addr

C4NetIO::addr_t C4NetIOTCP::Peer::addr

protected

Definition at line 412 of file C4NetIO.h.

Referenced by GetAddr().

fDoBroadcast

bool C4NetIOTCP::Peer::fDoBroadcast

protected

Definition at line 423 of file C4NetIO.h.

Referenced by doBroadcast(), and SetBroadcast().

fOpen

bool C4NetIOTCP::Peer::fOpen

protected

Definition at line 421 of file C4NetIO.h.

Referenced by Open().

IBuf

StdBuf C4NetIOTCP::Peer::IBuf

protected

Definition at line 416 of file C4NetIO.h.

ICSec

CStdCSec C4NetIOTCP::Peer::ICSec

protected

Definition at line 425 of file C4NetIO.h.

iIBufUsage

int C4NetIOTCP::Peer::iIBufUsage

protected

Definition at line 417 of file C4NetIO.h.

iIRate

int C4NetIOTCP::Peer::iIRate

protected

Definition at line 419 of file C4NetIO.h.

Referenced by GetIRate().

iMinIBufSize

const unsigned int C4NetIOTCP::Peer::iMinIBufSize = 8192

staticprotected

Definition at line 408 of file C4NetIO.h.

iORate

int C4NetIOTCP::Peer::iORate

protected

Definition at line 419 of file C4NetIO.h.

Referenced by GetORate().

iTCPHeaderSize

const unsigned int C4NetIOTCP::Peer::iTCPHeaderSize = 28 + 24

staticprotected

Definition at line 407 of file C4NetIO.h.

Next

Peer* C4NetIOTCP::Peer::Next

Definition at line 454 of file C4NetIO.h.

Referenced by C4NetIOTCP::Accept(), C4NetIOTCP::Broadcast(), C4NetIOTCP::ClearStatistic(), C4NetIOTCP::Close(), C4NetIOTCP::Execute(), C4NetIOTCP::GetFDs(), C4NetIOTCP::GetPeer(), and C4NetIOTCP::OnShareFree().

OBuf

StdBuf C4NetIOTCP::Peer::OBuf

protected

Definition at line 416 of file C4NetIO.h.

Referenced by hasWaitingData().

OCSec

CStdCSec C4NetIOTCP::Peer::OCSec

protected

Definition at line 425 of file C4NetIO.h.

pParent

C4NetIOTCP* const C4NetIOTCP::Peer::pParent

protected

Definition at line 410 of file C4NetIO.h.

sock

SOCKET C4NetIOTCP::Peer::sock

protected

Definition at line 414 of file C4NetIO.h.

Referenced by GetSocket().

---

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

• C4NetIO.h
• C4NetIO.cpp