ost::UDPTransmit - Representing half of a two-way UDP connection, the UDP transmitter can broadcast data

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

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

ost::UDPTransmit::UDPTransmit(Familyfamily=IPV4)[protected]
       Create a UDP transmitter.

   ost::UDPTransmit::UDPTransmit(constIPV4Address&bind,tpport_tport=5005)[protected]
       Create a UDP transmitter, 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. This class is only used to build the UDP
       Duplex.

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

   ost::UDPTransmit::UDPTransmit(constIPV6Address&bind,tpport_tport=5005)[protected]

       Representing half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected
       peer host or to an entire subnet.

       Author
           David Sugar dyfet@ostel.com

       Unreliable Datagram Peer Associations.

Errorost::UDPTransmit::connect(constIPV4Broadcast&subnet,tpport_tport)[protected]
       Associate this socket with a subnet of peer hosts for subnet broadcasting. The server must be able to
       assert broadcast permission for the socket.

       Returns
           0 on success, -1 on error.

       Parameterssubnet subnet address to broadcast into.
           port transport port to broadcast into.

   Errorost::UDPTransmit::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 to and received from the specified host.

       Returns
           0 on success, -1 on error.

       Parametershost address to connect socket to.
           port to connect socket to.

   Errorost::UDPTransmit::connect(constIPV4Multicast&mgroup,tpport_tport)[protected]
       Associate this socket with a multicast group.

       Returns
           0 on success, -1 on error.

       Parametersmgroup address of the multicast group to send to.
           port port number

   Errorost::UDPTransmit::connect(constIPV6Address&host,tpport_tport)[protected]Errorost::UDPTransmit::connect(constIPV6Multicast&mgroup,tpport_tport)[protected]voidost::UDPTransmit::endTransmitter(void)[inline],[protected]
       Stop transmitter.

       References ost::Socket::endSocket().

   SOCKETost::UDPTransmit::getTransmitter(void)[inline],[protected]boolost::UDPTransmit::isOutputReady(unsignedlongtimeout=0l)[inline]
       See if output queue is empty for sending more packets.

       Returns
           true if output available.

       Parameterstimeout in milliseconds to wait.

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

   ssize_tost::UDPTransmit::send(constvoid*buf,size_tlen)[inline],[protected]
       Transmit 'send' to use 'connected' send rather than sendto.

       Returns
           number of bytes sent.

       Parametersbuf address of buffer to send.
           len of bytes to send.

       References _IOLEN64, and MSG_NOSIGNAL.

   Errorost::UDPTransmit::setBroadcast(boolenable)[inline]
       References ost::Socket::setBroadcast().

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

   Errorost::UDPTransmit::setRouting(boolenable)[inline]
       References ost::Socket::setRouting().

   Errorost::UDPTransmit::setTimeToLive(unsignedcharttl)[inline],[protected]
       References ost::Socket::setTimeToLiveByFamily().

   Errorost::UDPTransmit::setTypeOfService(Tostos)[inline]
       References ost::Socket::setTypeOfService().

   ssize_tost::UDPTransmit::transmit(constchar*buffer,size_tlen)[inline]
       Transmit 'send' to use 'connected' send rather than sendto.

       Note
           Windows does not support MSG_DONTWAIT, so it is defined as 0 on that platform.

       Returns
           number of bytes sent.

       Parametersbuffer address of buffer to send.
           len of bytes to send.

       References _IOLEN64, MSG_DONTWAIT, and MSG_NOSIGNAL.

       ost::UDPTransmit - Representing half of a two-way UDP connection, the UDP transmitter can broadcast data
       to another selected peer host or to an entire subnet.

       #include <socket.h>

       Inherits ost::UDPSocket.

       Inherited by ost::UDPDuplex.

   PublicMemberFunctions
       ssize_t transmit (const char *buffer, size_t len)
           Transmit 'send' to use 'connected' send rather than sendto.
       bool isOutputReady (unsigned long timeout=0l)
           See if output queue is empty for sending more packets.
       ErrorsetRouting (bool enable)
       ErrorsetTypeOfService (Tos tos)
       ErrorsetBroadcast (bool enable)

   ProtectedMemberFunctionsUDPTransmit (Familyfamily=IPV4)
           Create a UDP transmitter.
       UDPTransmit (const IPV4Address &bind, tpport_t port=5005)
           Create a UDP transmitter, 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.
       UDPTransmit (const IPV6Address &bind, tpport_t port=5005)
       Errorconnect (const IPV4Host &host, tpport_t port)
           Associate this socket with a specified peer host.
       Errorconnect (const IPV6Address &host, tpport_t port)
       Errorconnect (const IPV4Broadcast &subnet, tpport_t port)
           Associate this socket with a subnet of peer hosts for subnet broadcasting.
       Errorconnect (const IPV4Multicast &mgroup, tpport_t port)
           Associate this socket with a multicast group.
       Errorconnect (const IPV6Multicast &mgroup, tpport_t port)
       ssize_t send (const void *buf, size_t len)
           Transmit 'send' to use 'connected' send rather than sendto.
       void endTransmitter (void)
           Stop transmitter.
       SOCKETgetTransmitter (void)
       ErrorsetMulticast (bool enable)
       ErrorsetTimeToLive (unsigned char ttl)

   AdditionalInheritedMembers