logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

ost::UDPReceive - Representing half of a two-way UDP connection, the UDP receiver can receive data from

Author

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                              ost::UDPReceive(3)

Constructor & Destructor Documentation

ost::UDPReceive::UDPReceive(constIPV4Address&bind,tpport_tport)[protected]
       Create a UDP receiver, bind it to a specific interface and port address so that other UDP sockets on
       remote machines (or the same host) may find and send UDP messages to it, and associate it with a given
       port on a peer host. On failure to bind, an exception is thrown.

       Parametersbind address to bind this socket to.
           port number to bind this socket to.

   ost::UDPReceive::UDPReceive(constIPV6Address&bind,tpport_tport)[protected]

Detailed Description

       Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host
       or subnet.

       This class is used exclusivily to derive the UDPDuplex.

       Author
           David Sugar dyfet@ostel.com

       Unreliable Datagram Peer Associations.

Member Function Documentation

Errorost::UDPReceive::connect(constIPV4Host&host,tpport_tport)[protected]
       Associate this socket with a specified peer host. The port number from the constructor will be used. All
       UDP packets will be sent received from the specified host.

       Returns
           0 on success, -1 on error.

       Parametershost host network address to connect socket to.
           port host transport port to connect socket to.

   Errorost::UDPReceive::connect(constIPV6Host&host,tpport_tport)[protected]Errorost::UDPReceive::drop(constIPV4Multicast&ia)[inline],[protected]
       References ost::Socket::drop().

   Errorost::UDPReceive::drop(constIPV6Multicast&ia)[inline],[protected]
       References ost::Socket::drop().

   voidost::UDPReceive::endReceiver(void)[inline],[protected]
       End receiver.

       References ost::Socket::endSocket().

   SOCKETost::UDPReceive::getReceiver(void)const[inline],[protected]boolost::UDPReceive::isInputReady(timeout_ttimeout=TIMEOUT_INF)[inline]
       See if input queue has data packets available.

       Returns
           true if data packets available.

       Parameterstimeout in milliseconds.

       References ost::Socket::isPending(), and ost::Socket::pendingInput.

   boolost::UDPReceive::isPendingReceive(timeout_ttimeout)[inline],[protected]
       Check for pending data.

       Returns
           true if data is waiting.

       Parameterstimeout in milliseconds.

       References ost::Socket::isPending(), and ost::Socket::pendingInput.

   Errorost::UDPReceive::join(constIPV4Multicast&ia)[inline],[protected]
       References ost::Socket::join().

   Errorost::UDPReceive::join(constIPV6Multicast&ia)[inline],[protected]
       References ost::Socket::join().

   ssize_tost::UDPReceive::receive(void*buf,size_tlen)[inline]
       Receive a data packet from the connected peer host.

       Returns
           num of bytes actually received.

       Parametersbuf address of data receive buffer.
           len size of data receive buffer.

       References _IOLEN64.

   Errorost::UDPReceive::setMulticast(boolenable)[inline],[protected]
       References ost::Socket::setMulticastByFamily().

   Errorost::UDPReceive::setRouting(boolenable)[inline],[protected]
       References ost::Socket::setRouting().

Name

       ost::UDPReceive - Representing half of a two-way UDP connection, the UDP receiver can receive data from
       another peer host or subnet.

Synopsis

       #include <socket.h>

       Inherits ost::UDPSocket.

       Inherited by ost::UDPDuplex.

   PublicMemberFunctions
       ssize_t receive (void *buf, size_t len)
           Receive a data packet from the connected peer host.
       bool isInputReady (timeout_t timeout=TIMEOUT_INF)
           See if input queue has data packets available.

   ProtectedMemberFunctionsUDPReceive (const IPV4Address &bind, tpport_t port)
           Create a UDP receiver, bind it to a specific interface and port address so that other UDP sockets on
           remote machines (or the same host) may find and send UDP messages to it, and associate it with a
           given port on a peer host.
       UDPReceive (const IPV6Address &bind, tpport_t port)
       Errorconnect (const IPV4Host &host, tpport_t port)
           Associate this socket with a specified peer host.
       Errorconnect (const IPV6Host &host, tpport_t port)
       bool isPendingReceive (timeout_t timeout)
           Check for pending data.
       void endReceiver (void)
           End receiver.
       SOCKETgetReceiver (void) const
       ErrorsetRouting (bool enable)
       ErrorsetMulticast (bool enable)
       Errorjoin (const IPV4Multicast &ia)
       Errorjoin (const IPV6Multicast &ia)
       Errordrop (const IPV4Multicast &ia)
       Errordrop (const IPV6Multicast &ia)

   AdditionalInheritedMembers

See Also