ost::UDPTransmit(3) | Library Functions Manual | ost::UDPTransmit(3) |
NAME¶
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.SYNOPSIS¶
#include <socket.h> Inherits ost::UDPSocket. Inherited by ost::UDPDuplex.Public Member Functions¶
ssize_t transmit (const char *buffer, size_t len)
Protected Member Functions¶
UDPTransmit (Family family=IPV4)
Additional Inherited Members¶
Detailed Description¶
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.
Constructor & Destructor Documentation¶
ost::UDPTransmit::UDPTransmit ( Familyfamily = IPV4) [protected]¶
Create a UDP transmitter.ost::UDPTransmit::UDPTransmit (const IPV4Address &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. Parameters:bind address to bind this socket to.
port number to bind this socket to.
ost::UDPTransmit::UDPTransmit (const IPV6Address &bind, tpport_tport = 5005) [protected]¶
Member Function Documentation¶
Error ost::UDPTransmit::connect (const IPV4Host &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.
Parameters:
host address to connect socket to.
port to connect socket to.
Error ost::UDPTransmit::connect (const IPV6Address &host, tpport_tport) [protected]¶
Error ost::UDPTransmit::connect (const IPV4Broadcast &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.
Parameters:
subnet subnet address to broadcast into.
port transport port to broadcast into.
Error ost::UDPTransmit::connect (const IPV4Multicast &mgroup, tpport_tport) [protected]¶
Associate this socket with a multicast group. Returns:0 on success, -1 on error.
Parameters:
mgroup address of the multicast group to send to.
port port number
Error ost::UDPTransmit::connect (const IPV6Multicast &mgroup, tpport_tport) [protected]¶
void ost::UDPTransmit::endTransmitter (void) [inline], [protected]¶
Stop transmitter. References ost::Socket::endSocket().SOCKET ost::UDPTransmit::getTransmitter (void) [inline], [protected]¶
bool ost::UDPTransmit::isOutputReady (unsigned longtimeout = 0l) [inline]¶
See if output queue is empty for sending more packets. Returns:true if output available.
Parameters:
timeout in milliseconds to wait.
References ost::Socket::isPending(), and ost::Socket::pendingOutput.
ssize_t ost::UDPTransmit::send (const void *buf, size_tlen) [inline], [protected]¶
Transmit 'send' to use 'connected' send rather than sendto. Returns:number of bytes sent.
Parameters:
buf address of buffer to send.
len of bytes to send.
References _IOLEN64, and MSG_NOSIGNAL.
Error ost::UDPTransmit::setBroadcast (boolenable) [inline]¶
References ost::Socket::setBroadcast().Error ost::UDPTransmit::setMulticast (boolenable) [inline], [protected]¶
References ost::Socket::setMulticastByFamily().Error ost::UDPTransmit::setRouting (boolenable) [inline]¶
References ost::Socket::setRouting().Error ost::UDPTransmit::setTimeToLive (unsigned charttl) [inline], [protected]¶
References ost::Socket::setTimeToLiveByFamily().Error ost::UDPTransmit::setTypeOfService ( Tostos) [inline]¶
References ost::Socket::setTypeOfService().ssize_t ost::UDPTransmit::transmit (const char *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.
Parameters:
buffer address of buffer to send.
len of bytes to send.
References _IOLEN64, MSG_DONTWAIT, and MSG_NOSIGNAL.
Author¶
Generated automatically by Doxygen for GNU CommonC++ from the source code.Sun Dec 29 2013 | GNU CommonC++ |