C4NetIOSimpleUDP Class Reference

#include <C4NetIO.h>

Inheritance diagram for C4NetIOSimpleUDP:

Collaboration diagram for C4NetIOSimpleUDP:

Public Types
typedef EndpointAddress	addr_t

Public Member Functions
	C4NetIOSimpleUDP ()
	~C4NetIOSimpleUDP () override
bool	Init (uint16_t iPort=addr_t::IPPORT_NONE) override
virtual bool	InitBroadcast (addr_t *pBroadcastAddr)
bool	Close () override
virtual bool	CloseBroadcast ()
bool	Execute (int iMaxTime=TO_INF, pollfd *=nullptr) override
bool	Send (const C4NetIOPacket &rPacket) override
bool	Broadcast (const C4NetIOPacket &rPacket) override
virtual void	UnBlock ()
void	GetFDs (std::vector< struct pollfd > &FDs) override
bool	Connect (const addr_t &addr) override
bool	Close (const addr_t &addr) override
bool	SetBroadcast (const addr_t &addr, bool fSet=true) override
bool	GetStatistic (int *pBroadcastRate) override
bool	GetConnStatistic (const addr_t &addr, int *pIRate, int *pORate, int *pLoss) override
void	ClearStatistic () override
void	SetCallback (CBClass *pnCallback) override
bool	IsNotify () override
virtual bool	Send (const class C4NetIOPacket &rPacket)=0
virtual bool	Broadcast (const class C4NetIOPacket &rPacket)=0
virtual const char *	GetError () const
void	ResetError ()
bool	ExecuteUntil (int iTimeout=-1)
virtual C4TimeMilliseconds	GetNextTick (C4TimeMilliseconds tNow)
bool	IsSignaled ()
virtual bool	IsLowPriority ()
virtual uint32_t	TimerInterval ()

Static Public Member Functions
static std::vector< HostAddress >	GetLocalAddresses ()

Static Public Attributes
static const int	TO_INF = -1

Protected Member Functions
const addr_t &	getMCAddr () const
bool	SetMCLoopback (int fLoopback)
bool	getMCLoopback () const
void	SetReUseAddress (bool fAllow)
bool	InitIPv6Socket (SOCKET socket)
void	SetError (const char *strnError, bool fSockErr=false)
void	Changed ()

Protected Attributes
StdCopyStrBuf	Error

Detailed Description

Definition at line 515 of file C4NetIO.h.

Member Typedef Documentation

addr_t

typedef EndpointAddress C4NetIO::addr_t

inherited

Definition at line 213 of file C4NetIO.h.

Constructor & Destructor Documentation

C4NetIOSimpleUDP()

C4NetIOSimpleUDP::C4NetIOSimpleUDP

(

)

Definition at line 1887 of file C4NetIO.cpp.

        : iPort(~0), sock(INVALID_SOCKET)
{
 
}

~C4NetIOSimpleUDP()

C4NetIOSimpleUDP::~C4NetIOSimpleUDP ( )

override

Definition at line 1893 of file C4NetIO.cpp.

{
    Close();
}

References Close().

Here is the call graph for this function:

Member Function Documentation

Broadcast() [1/2]

bool C4NetIOSimpleUDP::Broadcast ( const C4NetIOPacket &  rPacket )

override

Definition at line 2200 of file C4NetIO.cpp.

{
    // just set broadcast address and send
    return C4NetIOSimpleUDP::Send(C4NetIOPacket(rPacket.getRef(), MCAddr));
}

References C4NetIOPacket::getRef(), and Send().

Referenced by C4NetIOUDP::DoLoopbackTest(), and C4NetIOUDP::InitBroadcast().

Here is the call graph for this function:

Here is the caller graph for this function:

Broadcast() [2/2]

virtual bool C4NetIO::Broadcast ( const class C4NetIOPacket &  rPacket )

pure virtualinherited

Changed()

void StdSchedulerProc::Changed ( )

protectedinherited

Definition at line 108 of file StdScheduler.cpp.

{
    auto s = scheduler;
    if (s)
        s->Changed(this);
}

References s.

Referenced by C4NetIOTCP::Accept(), C4NetIOTCP::AddConnectWait(), C4NetIOUDP::AddPeer(), C4NetIOTCP::Listen(), and CStdTimerProc::SetDelay().

Here is the caller graph for this function:

ClearStatistic()

void C4NetIOSimpleUDP::ClearStatistic ( )

inlineoverridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 547 of file C4NetIO.h.

{ assert(false); }

Close() [1/2]

bool C4NetIOSimpleUDP::Close ( )

overridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 2041 of file C4NetIO.cpp.

{
    // should be initialized
    if (!fInit) return true;
 
    ResetError();
 
    // deactivate multicast
    if (fMultiCast)
        CloseBroadcast();
 
    // close sockets
    if (sock != INVALID_SOCKET)
    {
        closesocket(sock);
        sock = INVALID_SOCKET;
    }
 
#ifdef STDSCHEDULER_USE_EVENTS
    // close event
    if (hEvent != nullptr)
    {
        WSACloseEvent(hEvent);
        hEvent = nullptr;
    }
#else
    // close pipes
    close(Pipe[0]);
    close(Pipe[1]);
#endif
 
#ifdef HAVE_WINSOCK
    // release winsock
    ReleaseWinSock();
#endif
 
    // ok
    fInit = false;
    return false;
}

References CloseBroadcast(), closesocket, INVALID_SOCKET, and C4NetIO::ResetError().

Referenced by C4NetIOUDP::Close(), Init(), ~C4NetIOSimpleUDP(), and C4StartupNetDlg::~C4StartupNetDlg().

Here is the call graph for this function:

Here is the caller graph for this function:

Close() [2/2]

bool C4NetIOSimpleUDP::Close ( const addr_t &  addr )

inlineoverridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 540 of file C4NetIO.h.

{ assert(false); return false; }

CloseBroadcast()

bool C4NetIOSimpleUDP::CloseBroadcast ( )

virtual

Reimplemented in C4NetIOUDP.

Definition at line 2082 of file C4NetIO.cpp.

{
    // multicast not active?
    if (!fMultiCast) return true;
 
    // leave multicast group
    if (setsockopt(sock, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP,
                   reinterpret_cast<const char *>(&MCGrpInfo), sizeof(MCGrpInfo)) == SOCKET_ERROR)
    {
        SetError("could not leave multicast group"); // to do: more error information
        return false;
    }
 
    // ok
    fMultiCast = false;
    return true;
}

References C4NetIO::SetError(), and SOCKET_ERROR.

Referenced by Close(), C4NetIOUDP::CloseBroadcast(), InitBroadcast(), and C4NetIOUDP::InitBroadcast().

Here is the call graph for this function:

Here is the caller graph for this function:

Connect()

bool C4NetIOSimpleUDP::Connect ( const addr_t &  addr )

inlineoverridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 539 of file C4NetIO.h.

{ assert(false); return false; }

Execute()

bool C4NetIOSimpleUDP::Execute ( int  iMaxTime = TO_INF, pollfd *  = nullptr  )

overridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 2100 of file C4NetIO.cpp.

{
    if (!fInit) { SetError("not yet initialized"); return false; }
    ResetError();
 
#ifdef __APPLE__
    iMaxTime = fix_poll_timeout(iMaxTime);
#endif
 
    // wait for socket / timeout
    WaitResult eWR = WaitForSocket(iMaxTime);
    if (eWR == WR_Error) return false;
 
    // cancelled / timeout?
    if (eWR == WR_Cancelled || eWR == WR_Timeout) return true;
    assert(eWR == WR_Readable);
 
    // read packets from socket
    for (;;)
    {
        // how much can be read?
#ifdef _WIN32
        u_long iMaxMsgSize;
#else
        // The FIONREAD ioctl call takes an int on unix
        int iMaxMsgSize;
#endif
        if (::ioctlsocket(sock, FIONREAD, &iMaxMsgSize) == SOCKET_ERROR)
        {
            SetError("Could not determine the amount of data that can be read from socket", true);
            return false;
        }
 
        // nothing?
        if (!iMaxMsgSize)
            break;
        // alloc buffer
        C4NetIOPacket Pkt; Pkt.New(iMaxMsgSize);
        // read data (note: it is _not_ garantueed that iMaxMsgSize bytes are available)
        addr_t SrcAddr; socklen_t iSrcAddrLen = sizeof(sockaddr_in6);
        int iMsgSize = ::recvfrom(sock, getMBufPtr<char>(Pkt), iMaxMsgSize, 0, &SrcAddr, &iSrcAddrLen);
        // error?
        if (iMsgSize == SOCKET_ERROR)
        {
            if (HaveConnResetError())
            {
                // this is actually some kind of notification: an ICMP msg (unreachable)
                // came back, so callback and continue reading
                if (pCB) pCB->OnDisconn(SrcAddr, this, GetSocketErrorMsg());
                continue;
            }
            else
            {
                // this is the real thing, though
                SetError("could not receive data from socket", true);
                return false;
            }
        }
        // invalid address?
        if ((iSrcAddrLen != sizeof(sockaddr_in) && iSrcAddrLen != sizeof(sockaddr_in6)) || SrcAddr.GetFamily() == addr_t::UnknownFamily)
        {
            SetError("recvfrom returned an invalid address");
            return false;
        }
        // again: nothing?
        if (!iMsgSize)
            // docs say that the connection has been closed (whatever that means for a connectionless socket...)
            // let's just pretend it didn't happen, but stop reading.
            break;
        // fill in packet information
        Pkt.SetSize(iMsgSize);
        Pkt.SetAddr(SrcAddr);
        // callback
        if (pCB) pCB->OnPacket(Pkt, this);
    }
 
    // ok
    return true;
}

References C4NetIO::HostAddress::GetFamily(), GetSocketErrorMsg(), HaveConnResetError(), ioctlsocket, StdBuf::New(), C4NetIO::CBClass::OnDisconn(), C4NetIO::CBClass::OnPacket(), C4NetIO::ResetError(), C4NetIOPacket::SetAddr(), C4NetIO::SetError(), StdBuf::SetSize(), SOCKET_ERROR, and C4NetIO::HostAddress::UnknownFamily.

Referenced by C4NetIOUDP::DoLoopbackTest(), C4NetIOUDP::Execute(), C4NetIOUDP::InitBroadcast(), and C4StartupNetDlg::OnSec1Timer().

Here is the call graph for this function:

Here is the caller graph for this function:

ExecuteUntil()

bool StdSchedulerProc::ExecuteUntil ( int  iTimeout = -1 )

inherited

Definition at line 33 of file StdScheduler.cpp.

{
    // Infinite?
    if (iTimeout < 0)
        for (;;)
            if (!Execute())
                return false;
    // Calculate endpoint
    C4TimeMilliseconds tStopTime = C4TimeMilliseconds::Now() + iTimeout;
    for (;;)
    {
        // Call execute with given timeout
        if (!Execute(std::max(iTimeout, 0)))
            return false;
        // Calculate timeout
        C4TimeMilliseconds tTime = C4TimeMilliseconds::Now();
        if (tTime >= tStopTime)
            break;
        iTimeout = tStopTime - tTime;
    }
    // All ok.
    return true;
}

References StdSchedulerProc::Execute(), and C4TimeMilliseconds::Now().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

GetConnStatistic()

bool C4NetIOSimpleUDP::GetConnStatistic ( const addr_t &  addr, int *  pIRate, int *  pORate, int *  pLoss  )

inlineoverridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 545 of file C4NetIO.h.

    { assert(false); return false; }

GetError()

virtual const char* C4NetIO::GetError ( ) const

inlinevirtualinherited

Definition at line 286 of file C4NetIO.h.

{ return Error.getData(); }

References C4NetIO::Error, and StdStrBuf::getData().

Referenced by C4Network2IO::ConnectWithSocket(), C4NetIOUDP::DoLoopbackTest(), C4StartupNetDlg::DoRefresh(), C4Network2IO::Init(), C4NetIOUDP::InitBroadcast(), main(), MyCBClass::OnConn(), C4ChatControl::OnConnectBtn(), MyCBClass::OnPacket(), C4ChatControl::ProcessInput(), and C4Network2IOConnection::Send().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFDs()

void C4NetIOSimpleUDP::GetFDs ( std::vector< struct pollfd > &  FDs )

overridevirtual

Reimplemented from StdSchedulerProc.

Definition at line 2252 of file C4NetIO.cpp.

{
    // add pipe
    pollfd pfd = { Pipe[0], POLLIN, 0 };
    fds.push_back(pfd);
    // add socket
    if (sock != INVALID_SOCKET)
    {
        pollfd pfd = { sock, POLLIN, 0 };
        fds.push_back(pfd);
    }
}

References INVALID_SOCKET.

GetLocalAddresses()

std::vector< C4NetIO::HostAddress > C4NetIO::GetLocalAddresses ( )

staticinherited

Definition at line 631 of file C4NetIO.cpp.

{
    std::vector<HostAddress> result;
 
#ifdef HAVE_WINSOCK
    HostAddress addr;
    const size_t BUFFER_SIZE = 16000;
    PIP_ADAPTER_ADDRESSES addresses = nullptr;
    for (int i = 0; i < 3; ++i)
    {
        addresses = (PIP_ADAPTER_ADDRESSES) realloc(addresses, BUFFER_SIZE * (i+1));
        if (!addresses)
            // allocation failed
            return result;
        ULONG bufsz = BUFFER_SIZE * (i+1);
        DWORD rv = GetAdaptersAddresses(AF_UNSPEC,
            GAA_FLAG_SKIP_ANYCAST|GAA_FLAG_SKIP_MULTICAST|GAA_FLAG_SKIP_DNS_SERVER|GAA_FLAG_SKIP_FRIENDLY_NAME,
            nullptr, addresses, &bufsz);
        if (rv == ERROR_BUFFER_OVERFLOW)
            // too little space, try again
            continue;
        if (rv != NO_ERROR)
        {
            // Something else happened
            free(addresses);
            return result;
        }
        // All okay, add addresses
        for (PIP_ADAPTER_ADDRESSES address = addresses; address; address = address->Next)
        {
            for (PIP_ADAPTER_UNICAST_ADDRESS unicast = address->FirstUnicastAddress; unicast; unicast = unicast->Next)
            {
                addr.SetHost(unicast->Address.lpSockaddr);
                if (addr.IsLoopback())
                    continue;
                result.push_back(addr);
            }
        }
    }
    free(addresses);
#else
    bool have_ipv6 = false;
 
#ifdef __linux__
    // Get IPv6 addresses on Linux from procfs which allows filtering deprecated privacy addresses.
    FILE *f = fopen("/proc/net/if_inet6", "r");
    if (f)
    {
        sockaddr_in6 sa6 = sockaddr_in6();
        sa6.sin6_family = AF_INET6;
        auto a6 = sa6.sin6_addr.s6_addr;
        uint8_t if_idx, plen, scope, flags;
        char devname[20];
        while (fscanf(f, "%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx %02hhx %02hhx %02hhx %02hhx %20s\n",
                    &a6[0], &a6[1], &a6[2],  &a6[3],  &a6[4],  &a6[5],  &a6[6],  &a6[7],
                    &a6[8], &a6[9], &a6[10], &a6[11], &a6[12], &a6[13], &a6[14], &a6[15],
                    &if_idx, &plen, &scope, &flags, devname) != EOF)
        {
            // Skip loopback and deprecated addresses.
            if (scope == IPV6_ADDR_LOOPBACK || flags & IFA_F_DEPRECATED)
                continue;
            sa6.sin6_scope_id = scope == IPV6_ADDR_LINKLOCAL ? if_idx : 0;
            result.emplace_back((sockaddr*) &sa6);
        }
        have_ipv6 = result.size() > 0;
        fclose(f);
    }
#endif
 
    struct ifaddrs* addrs;
    if (getifaddrs(&addrs) < 0)
        return result;
    for (struct ifaddrs* ifaddr = addrs; ifaddr != nullptr; ifaddr = ifaddr->ifa_next)
    {
        struct sockaddr* ad = ifaddr->ifa_addr;
        if (ad == nullptr) continue;
 
        if ((ad->sa_family == AF_INET || (!have_ipv6 && ad->sa_family == AF_INET6)) && (~ifaddr->ifa_flags & IFF_LOOPBACK)) // Choose only non-loopback IPv4/6 devices
        {
            result.emplace_back(ad);
        }
    }
    freeifaddrs(addrs);
#endif
 
    return result;
}

References C4NetIO::HostAddress::IsLoopback(), and C4NetIO::HostAddress::SetHost().

Referenced by C4Network2Client::AddLocalAddrs(), and C4NetIOUDP::InitBroadcast().

Here is the call graph for this function:

Here is the caller graph for this function:

getMCAddr()

const addr_t& C4NetIOSimpleUDP::getMCAddr ( ) const

inlineprotected

Definition at line 573 of file C4NetIO.h.

{ return MCAddr; }

Referenced by C4NetIOUDP::SendDirect().

Here is the caller graph for this function:

getMCLoopback()

bool C4NetIOSimpleUDP::getMCLoopback ( ) const

inlineprotected

Definition at line 577 of file C4NetIO.h.

{ return fMCLoopback; }

Referenced by C4NetIOUDP::DoLoopbackTest(), and C4NetIOUDP::InitBroadcast().

Here is the caller graph for this function:

GetNextTick()

C4TimeMilliseconds StdSchedulerProc::GetNextTick ( C4TimeMilliseconds  tNow )

virtualinherited

Reimplemented in CStdTimerProc, C4Network2IO, C4NetIOUDP, and C4HTTPClient.

Definition at line 115 of file StdScheduler.cpp.

{
    return C4TimeMilliseconds::PositiveInfinity;
}

References C4TimeMilliseconds::PositiveInfinity.

GetStatistic()

bool C4NetIOSimpleUDP::GetStatistic ( int *  pBroadcastRate )

inlineoverridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 544 of file C4NetIO.h.

{ assert(false); return false; }

Init()

bool C4NetIOSimpleUDP::Init ( uint16_t  iPort = addr_t::IPPORT_NONE )

overridevirtual

Implements C4NetIO.

Reimplemented in C4Network2IODiscoverClient, C4Network2IODiscover, and C4NetIOUDP.

Definition at line 1898 of file C4NetIO.cpp.

{
    // reset error
    ResetError();
 
    // already initialized? close first
    if (fInit) Close();
 
#ifdef HAVE_WINSOCK
    // init winsock
    if (!AcquireWinSock())
    {
        SetError("could not start winsock");
        return false;
    }
#endif
 
    // create sockets
    if ((sock = ::socket(AF_INET6, SOCK_DGRAM | SOCK_CLOEXEC, IPPROTO_UDP)) == INVALID_SOCKET)
    {
        SetError("could not create socket", true);
        return false;
    }
 
    if (!InitIPv6Socket(sock))
        return false;
 
    // set reuse socket option
    if (::setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, reinterpret_cast<char *>(&fAllowReUse), sizeof fAllowReUse) == SOCKET_ERROR)
    {
        SetError("could not set reuse options", true);
        return false;
    }
 
    // bind socket
    iPort = inPort;
    addr_t naddr = addr_t::Any;
    naddr.SetPort(iPort);
    if (::bind(sock, &naddr, sizeof(naddr)) == SOCKET_ERROR)
    {
        SetError("could not bind socket", true);
        return false;
    }
 
#ifdef STDSCHEDULER_USE_EVENTS
 
    // create event
    if ((hEvent = WSACreateEvent()) == WSA_INVALID_EVENT)
    {
        SetError("could not create event", true);
        return false;
    }
 
    // set event for socket
    if (WSAEventSelect(sock, hEvent, FD_READ | FD_CLOSE) == SOCKET_ERROR)
    {
        SetError("could not select event", true);
        return false;
    }
 
#else
 
    // disable blocking
    if (::fcntl(sock, F_SETFL, fcntl(sock, F_GETFL) | O_NONBLOCK) == SOCKET_ERROR)
    {
        // set error
        SetError("could not disable blocking", true);
        return false;
    }
 
    // create pipe
    if (pipe(Pipe) != 0)
    {
        SetError("could not create pipe", true);
        return false;
    }
 
#endif
 
    // set flags
    fInit = true;
    fMultiCast = false;
 
    // ok, that's all for know.
    // call InitBroadcast for more initialization fun
    return true;
}

References C4NetIO::HostAddress::Any, Close(), C4NetIO::InitIPv6Socket(), INVALID_SOCKET, C4NetIO::ResetError(), C4NetIO::SetError(), C4NetIO::EndpointAddress::SetPort(), SOCK_CLOEXEC, and SOCKET_ERROR.

Referenced by C4NetIOUDP::Init(), C4Network2IODiscover::Init(), and C4Network2IODiscoverClient::Init().

Here is the call graph for this function:

Here is the caller graph for this function:

InitBroadcast()

bool C4NetIOSimpleUDP::InitBroadcast ( addr_t *  pBroadcastAddr )

virtual

Reimplemented in C4NetIOUDP.

Definition at line 1986 of file C4NetIO.cpp.

{
    // no error... yet
    ResetError();
 
    // security
    if (!pBroadcastAddr) return false;
 
    // Init() has to be called first
    if (!fInit) return false;
    // already activated?
    if (fMultiCast) CloseBroadcast();
 
    // broadcast addr valid?
    if (!pBroadcastAddr->IsMulticast() || pBroadcastAddr->GetFamily() != HostAddress::IPv6)
    {
        SetError("invalid broadcast address (only IPv6 multicast addresses are supported)");
        return false;
    }
    if (pBroadcastAddr->GetPort() != iPort)
    {
        SetError("invalid broadcast address (different port)");
        return false;
    }
 
    // set mc ttl to somewhat about "same net"
    int TTL = 16;
    if (setsockopt(sock, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, reinterpret_cast<char*>(&TTL), sizeof(TTL)) == SOCKET_ERROR)
    {
        SetError("could not set mc ttl", true);
        return false;
    }
 
    // set up multicast group information
    this->MCAddr = *pBroadcastAddr;
    MCGrpInfo.ipv6mr_multiaddr = static_cast<sockaddr_in6>(MCAddr).sin6_addr;
    // TODO: do multicast on all interfaces?
    MCGrpInfo.ipv6mr_interface = 0; // default interface
 
    // join multicast group
    if (setsockopt(sock, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP,
                   reinterpret_cast<const char *>(&MCGrpInfo), sizeof(MCGrpInfo)) == SOCKET_ERROR)
    {
        SetError("could not join multicast group"); // to do: more error information
        return false;
    }
 
    // (try to) disable loopback (will set fLoopback accordingly)
    SetMCLoopback(false);
 
    // ok
    fMultiCast = true;
    return true;
}

References CloseBroadcast(), C4NetIO::HostAddress::GetFamily(), C4NetIO::EndpointAddress::GetPort(), C4NetIO::HostAddress::IPv6, C4NetIO::HostAddress::IsMulticast(), C4NetIO::ResetError(), C4NetIO::SetError(), SetMCLoopback(), and SOCKET_ERROR.

Referenced by C4Network2IODiscover::Init(), C4Network2IODiscoverClient::Init(), and C4NetIOUDP::InitBroadcast().

Here is the call graph for this function:

Here is the caller graph for this function:

InitIPv6Socket()

bool C4NetIO::InitIPv6Socket ( SOCKET  socket )

protectedinherited

Definition at line 730 of file C4NetIO.cpp.

{
    int opt = 0;
    if (setsockopt(socket, IPPROTO_IPV6, IPV6_V6ONLY, reinterpret_cast<char*>(&opt), sizeof(opt)) == SOCKET_ERROR)
    {
        SetError("could not enable dual-stack socket", true);
        return false;
    }
 
#ifdef IPV6_ADDR_PREFERENCES
    // Prefer stable addresses. This should prevent issues with address
    // deprecation while a match is running. No error handling - if the call
    // fails, we just take any address.
    opt = IPV6_PREFER_SRC_PUBLIC;
    setsockopt(socket, IPPROTO_IPV6, IPV6_ADDR_PREFERENCES, reinterpret_cast<char*>(&opt), sizeof(opt));
#endif
 
    return true;
}

References C4NetIO::SetError(), and SOCKET_ERROR.

Referenced by C4NetIOTCP::CreateSocket(), Init(), and C4NetIOTCP::Listen().

Here is the call graph for this function:

Here is the caller graph for this function:

IsLowPriority()

virtual bool StdSchedulerProc::IsLowPriority ( )

inlinevirtualinherited

Definition at line 82 of file StdScheduler.h.

{ return false; }

IsNotify()

bool C4NetIO::IsNotify ( )

inlineoverridevirtualinherited

Reimplemented from StdSchedulerProc.

Definition at line 260 of file C4NetIO.h.

{ return true; }

IsSignaled()

bool StdSchedulerProc::IsSignaled ( )

inherited

ResetError()

void C4NetIO::ResetError ( )

inlineinherited

Definition at line 287 of file C4NetIO.h.

{ Error.Clear(); }

References StdStrBuf::Clear(), and C4NetIO::Error.

Referenced by C4NetIO::C4NetIO(), C4NetIOTCP::Close(), Close(), C4NetIOUDP::CloseBroadcast(), C4Network2IO::ConnectWithSocket(), Execute(), C4NetIOUDP::Execute(), Init(), InitBroadcast(), C4NetIOUDP::InitBroadcast(), Send(), and C4Network2IOConnection::Send().

Here is the call graph for this function:

Here is the caller graph for this function:

Send() [1/2]

bool C4NetIOSimpleUDP::Send ( const C4NetIOPacket &  rPacket )

override

Definition at line 2180 of file C4NetIO.cpp.

{
    if (!fInit) { SetError("not yet initialized"); return false; }
 
    // send it
    C4NetIO::addr_t addr = rPacket.getAddr();
    if (::sendto(sock, getBufPtr<char>(rPacket), rPacket.getSize(), 0,
                 &addr, addr.GetAddrLen())
        != int(rPacket.getSize()) &&
        !HaveWouldBlockError())
    {
        SetError("socket sendto failed", true);
        return false;
    }
 
    // ok
    ResetError();
    return true;
}

References C4NetIOPacket::getAddr(), C4NetIO::HostAddress::GetAddrLen(), StdBuf::getSize(), HaveWouldBlockError(), C4NetIO::ResetError(), and C4NetIO::SetError().

Referenced by C4Network2IODiscover::Announce(), Broadcast(), C4NetIOUDP::SendDirect(), and C4Network2IODiscoverClient::StartDiscovery().

Here is the call graph for this function:

Here is the caller graph for this function:

Send() [2/2]

virtual bool C4NetIO::Send ( const class C4NetIOPacket &  rPacket )

pure virtualinherited

Referenced by main(), MyCBClass::OnConn(), MyCBClass::OnPacket(), C4Network2IOConnection::Send(), and C4Network2IO::SendPuncherPacket().

Here is the caller graph for this function:

SetBroadcast()

bool C4NetIOSimpleUDP::SetBroadcast ( const addr_t &  addr, bool  fSet = true  )

inlineoverridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 542 of file C4NetIO.h.

{ assert(false); return false; }

SetCallback()

void C4NetIOSimpleUDP::SetCallback ( CBClass *  pnCallback )

inlineoverridevirtual

Implements C4NetIO.

Reimplemented in C4NetIOUDP.

Definition at line 590 of file C4NetIO.h.

{ pCB = pnCallback; };

Referenced by C4Network2IODiscover::C4Network2IODiscover(), C4Network2IODiscoverClient::C4Network2IODiscoverClient(), C4NetIOUDP::Init(), C4Network2IODiscover::Init(), and C4Network2IODiscoverClient::Init().

Here is the caller graph for this function:

SetError()

void C4NetIO::SetError ( const char *  strnError, bool  fSockErr = false  )

protectedinherited

Definition at line 750 of file C4NetIO.cpp.

{
    fSockErr &= HaveSocketError();
    if (fSockErr)
        Error.Format("%s (%s)", strnError, GetSocketErrorMsg());
    else
        Error.Copy(strnError);
}

References StdStrBuf::Copy(), C4NetIO::Error, StdStrBuf::Format(), GetSocketErrorMsg(), and HaveSocketError().

Referenced by C4NetIOTCP::Accept(), C4NetIOTCP::Bind(), CloseBroadcast(), C4NetIOTCP::Connect(), C4Network2IRCClient::Connect(), C4NetIOTCP::CreateSocket(), C4NetIOUDP::DoLoopbackTest(), Execute(), C4NetIOUDP::Execute(), C4NetIOTCP::Execute(), C4NetIOTCP::Init(), Init(), InitBroadcast(), C4NetIOUDP::InitBroadcast(), C4NetIO::InitIPv6Socket(), C4Network2IRCClient::Join(), C4NetIOTCP::Listen(), Send(), C4Network2IRCClient::Send(), C4NetIOTCP::UnBlock(), and UnBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

SetMCLoopback()

bool C4NetIOSimpleUDP::SetMCLoopback ( int  fLoopback )

protected

Definition at line 2290 of file C4NetIO.cpp.

{
    // enable/disable MC loopback
    setsockopt(sock, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, reinterpret_cast<char *>(&fLoopback), sizeof fLoopback);
    // read result
    socklen_t iSize = sizeof(fLoopback);
    if (getsockopt(sock, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, reinterpret_cast<char *>(&fLoopback), &iSize) == SOCKET_ERROR)
        return false;
    fMCLoopback = !! fLoopback;
    return true;
}

References iSize, and SOCKET_ERROR.

Referenced by C4NetIOUDP::DoLoopbackTest(), C4Network2IODiscover::Init(), C4Network2IODiscoverClient::Init(), InitBroadcast(), and C4NetIOUDP::InitBroadcast().

Here is the caller graph for this function:

SetReUseAddress()

void C4NetIOSimpleUDP::SetReUseAddress ( bool  fAllow )

protected

Definition at line 2302 of file C4NetIO.cpp.

{
    fAllowReUse = fAllow;
}

Referenced by C4Network2IODiscover::Init(), and C4Network2IODiscoverClient::Init().

Here is the caller graph for this function:

TimerInterval()

virtual uint32_t StdSchedulerProc::TimerInterval ( )

inlinevirtualinherited

Reimplemented in CStdTimerProc.

Definition at line 84 of file StdScheduler.h.

{ return 0; }

UnBlock()

void C4NetIOSimpleUDP::UnBlock ( )

virtual

Definition at line 2243 of file C4NetIO.cpp.

{
    // write one character to the pipe, this will unblock everything that
    // waits for the FD set returned by GetFDs.
    char c = 42;
    if (write(Pipe[1], &c, 1) == -1)
        SetError("write failed");
}

References C4NetIO::SetError().

Here is the call graph for this function:

Member Data Documentation

Error

StdCopyStrBuf C4NetIO::Error

protectedinherited

Definition at line 283 of file C4NetIO.h.

Referenced by C4NetIO::GetError(), C4NetIO::ResetError(), and C4NetIO::SetError().

TO_INF

const int C4NetIO::TO_INF = -1

staticinherited

Definition at line 66 of file C4NetIO.h.

Referenced by C4NetIOUDP::Execute(), C4NetIOTCP::Execute(), C4NetIOUDP::Peer::OnConn(), C4NetIOUDP::Peer::OnTimeout(), and C4NetIOUDP::Peer::SetTimeout().

---

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

• C4NetIO.h
• C4NetIO.cpp