sfSocketUDP Class Reference

sfSocketUDP wraps a socket using UDP protocol to send data fastly (but with less safety) More...

#include <SocketUDP.hpp>

List of all members.


Public Member Functions

 sfSocketUDP ()
 Default constructor.
bool Send (const char *Data, std::size_t Size, const sfIPAddress &Address, unsigned short Port)
 Send an array of bytes.
bool Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived, sfIPAddress &Address, unsigned short Port)
 Receive an array of bytes.
bool Send (sfPacket &Packet, const sfIPAddress &Address, unsigned short Port)
 Send a packet of data.
bool Receive (sfPacket &Packet, sfIPAddress &Address, unsigned short Port)
 Receive a packet.
bool Close ()
 Close the socket.
bool operator== (const sfSocketUDP &Other) const
 Comparison operator ==.
bool operator!= (const sfSocketUDP &Other) const
 Comparison operator !=.
bool operator< (const sfSocketUDP &Other) const
 Comparison operator <.

Friends

class sfSelector< sfSocketUDP >

Detailed Description

sfSocketUDP wraps a socket using UDP protocol to send data fastly (but with less safety)

Definition at line 43 of file SocketUDP.hpp.


Constructor & Destructor Documentation

sfSocketUDP::sfSocketUDP (  ) 

Default constructor.

Definition at line 37 of file SocketUDP.cpp.


Member Function Documentation

bool sfSocketUDP::Send ( const char *  Data,
std::size_t  Size,
const sfIPAddress Address,
unsigned short  Port 
)

Send an array of bytes.

Parameters:
Data : Pointer to the bytes to send
Size : Number of bytes to send
Address : Address of the computer to send the packet to
Port : Port to use for communication
Returns:
True if operation has been successful

Definition at line 48 of file SocketUDP.cpp.

bool sfSocketUDP::Receive ( char *  Data,
std::size_t  MaxSize,
std::size_t &  SizeReceived,
sfIPAddress Address,
unsigned short  Port 
)

Receive an array of bytes.

This function is blocking, ie. it won't return before some bytes have been received

Parameters:
Data : Pointer to a byte array to fill (make sure it is big enough)
MaxSize : Maximum number of bytes to read
SizeReceived : Number of bytes received
Address : Address of the computer to send the packet to
Port : Port to use for communication
Returns:
True if operation has been successful

Definition at line 93 of file SocketUDP.cpp.

bool sfSocketUDP::Send ( sfPacket Packet,
const sfIPAddress Address,
unsigned short  Port 
)

Send a packet of data.

Parameters:
Packet : Packet to send
Address : Address of the computer to send the packet to
Port : Port to use for communication
Returns:
True if operation has been successful

Definition at line 174 of file SocketUDP.cpp.

bool sfSocketUDP::Receive ( sfPacket Packet,
sfIPAddress Address,
unsigned short  Port 
)

Receive a packet.

This function is blocking, ie. it won't return before a packet is received

Parameters:
Packet : Packet to fill with received data
Address : Address of the computer that sent the packet
Port : Port to use for communication
Returns:
True if operation has been successful

Definition at line 197 of file SocketUDP.cpp.

bool sfSocketUDP::Close (  ) 

Close the socket.

Returns:
True if operation has been successful

Definition at line 239 of file SocketUDP.cpp.

bool sfSocketUDP::operator== ( const sfSocketUDP Other  )  const

Comparison operator ==.

Parameters:
Other : Socket to compare
Returns:
True if *this == Other

Definition at line 254 of file SocketUDP.cpp.

bool sfSocketUDP::operator!= ( const sfSocketUDP Other  )  const

Comparison operator !=.

Parameters:
Other : Socket to compare
Returns:
True if *this != Other

Definition at line 263 of file SocketUDP.cpp.

bool sfSocketUDP::operator< ( const sfSocketUDP Other  )  const

Comparison operator <.

Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

Parameters:
Other : Socket to compare
Returns:
True if *this < Other

Definition at line 274 of file SocketUDP.cpp.


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