#include <PracticalSocket.h>
List of all members.
Public Member Functions |
| UDPSocket () throw (SocketException) |
| UDPSocket (unsigned short localPort) throw (SocketException) |
| UDPSocket (const string &localAddress, unsigned short localPort) throw (SocketException) |
void | disconnect () throw (SocketException) |
void | sendTo (const void *buffer, int bufferLen, const string &foreignAddress, unsigned short foreignPort) throw (SocketException) |
int | recvFrom (void *buffer, int bufferLen, string &sourceAddress, unsigned short &sourcePort) throw (SocketException) |
void | setMulticastTTL (unsigned char multicastTTL) throw (SocketException) |
void | joinGroup (const string &multicastGroup) throw (SocketException) |
void | leaveGroup (const string &multicastGroup) throw (SocketException) |
void | connect (const string &foreignAddress, unsigned short foreignPort) throw (SocketException) |
void | send (const void *buffer, int bufferLen) throw (SocketException) |
int | recv (void *buffer, int bufferLen) throw (SocketException) |
string | getForeignAddress () throw (SocketException) |
unsigned short | getForeignPort () throw (SocketException) |
| ~Socket () |
string | getLocalAddress () throw (SocketException) |
unsigned short | getLocalPort () throw (SocketException) |
void | setLocalPort (unsigned short localPort) throw (SocketException) |
void | setLocalAddressAndPort (const string &localAddress, unsigned short localPort=0) throw (SocketException) |
Additional Inherited Members |
| CommunicatingSocket (int type, int protocol) throw (SocketException) |
| CommunicatingSocket (int newConnSD) |
| Socket (int type, int protocol) throw (SocketException) |
| Socket (int sockDesc) |
Detailed Description
Constructor & Destructor Documentation
Construct a UDP socket
- Exceptions:
-
Construct a UDP socket with the given local port
- Parameters:
-
- Exceptions:
-
UDPSocket::UDPSocket |
( |
const string & |
localAddress, |
|
|
unsigned short |
localPort |
|
) |
| throw (SocketException) |
Construct a UDP socket with the given local port and address
- Parameters:
-
localAddress | local address |
localPort | local port |
- Exceptions:
-
Member Function Documentation
Unset foreign address and port
- Returns:
- true if disassociation is successful
- Exceptions:
-
void UDPSocket::joinGroup |
( |
const string & |
multicastGroup | ) |
throw (SocketException) |
Join the specified multicast group
- Parameters:
-
multicastGroup | multicast group address to join |
- Exceptions:
-
void UDPSocket::leaveGroup |
( |
const string & |
multicastGroup | ) |
throw (SocketException) |
Leave the specified multicast group
- Parameters:
-
multicastGroup | multicast group address to leave |
- Exceptions:
-
int UDPSocket::recvFrom |
( |
void * |
buffer, |
|
|
int |
bufferLen, |
|
|
string & |
sourceAddress, |
|
|
unsigned short & |
sourcePort |
|
) |
| throw (SocketException) |
Read read up to bufferLen bytes data from this socket. The given buffer is where the data will be placed
- Parameters:
-
buffer | buffer to receive data |
bufferLen | maximum number of bytes to receive |
sourceAddress | address of datagram source |
sourcePort | port of data source |
- Returns:
- number of bytes received and -1 for error
- Exceptions:
-
void UDPSocket::sendTo |
( |
const void * |
buffer, |
|
|
int |
bufferLen, |
|
|
const string & |
foreignAddress, |
|
|
unsigned short |
foreignPort |
|
) |
| throw (SocketException) |
Send the given buffer as a UDP datagram to the specified address/port
- Parameters:
-
buffer | buffer to be written |
bufferLen | number of bytes to write |
foreignAddress | address (IP address or name) to send to |
foreignPort | port number to send to |
- Returns:
- true if send is successful
- Exceptions:
-
void UDPSocket::setMulticastTTL |
( |
unsigned char |
multicastTTL | ) |
throw (SocketException) |
Set the multicast TTL
- Parameters:
-
multicastTTL | multicast TTL |
- Exceptions:
-
The documentation for this class was generated from the following file: