OpenJAUS SAE SDK  6.0.0
Public Member Functions | Protected Attributes | Private Attributes | Friends | List of all members
openjaus::system::DatagramSocket Class Reference

This is a brief description. More...

#include <DatagramSocket.h>

Inherits openjaus::system::Socket.

Public Member Functions

 DatagramSocket ()
 
virtual ~DatagramSocket ()
 
 DatagramSocket (InetAddress ipAddress, short port)
 
bool open (InetAddress ipAddress, short port)
 Operation open. More...
 
int send (Packet &packet)
 Operation send. More...
 
int receive (Packet &packet)
 Operation receive. More...
 
bool reuseAddress (bool enabled)
 Operation reuseAddress. More...
 
bool enableBroadcast (bool enabled)
 Operation enableBroadcast. More...
 
bool setBufferSize (uint32_t size)
 Sets the size of the UDP Send & Recv buffers. More...
 
virtual std::string toString () const
 
bool isOpened () const
 
int setTimeToLive (uint8 ttl)
 
- Public Member Functions inherited from openjaus::system::Socket
 Socket ()
 
virtual ~Socket ()
 
bool isBlocking () const
 Accessor to get the value of blocking. More...
 
uint16_t getPort () const
 Accessor to get the value of port. More...
 
int getDescriptor () const
 Accessor to get the value of descriptor. More...
 
const InetAddress & getIpAddress () const
 Accessor to get the value of ipAddress. More...
 
const Time & getTimeout () const
 Accessor to get the value of timeout. More...
 
bool setTimeout (const Time &timeout)
 Accessor to set value of timeout. More...
 
const std::vector< NetworkInterface *> & getInterfaces () const
 Accessor to get the value of interfaces. More...
 
void readInterfaces ()
 Operation readInterfaces. More...
 
bool isLocalAddress (const InetAddress &ipAddress)
 Operation isLocalAddress. More...
 
uint64_t addressHash ()
 Operation addressHash. More...
 

Protected Attributes

bool opened
 
- Protected Attributes inherited from openjaus::system::Socket
bool blocking
 
uint16_t port
 
int descriptor
 
InetAddress ipAddress
 
Time timeout
 
std::vector< NetworkInterface *> interfaces
 

Private Attributes

MemoryBlock tempReceiveBuffer
 
MemoryBlock tempSendBuffer
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const DatagramSocket &object)
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const DatagramSocket *object)
 

Additional Inherited Members

- Static Public Member Functions inherited from openjaus::system::Socket
static std::vector< NetworkInterface > lookupInterfaces ()
 
- Static Protected Member Functions inherited from openjaus::system::Socket
static void initialize ()
 
static void deinitialize ()
 
- Static Protected Attributes inherited from openjaus::system::Socket
static int descriptorCount = 0
 

Detailed Description

Detailed description.

Author
Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

◆ DatagramSocket() [1/2]

openjaus::system::DatagramSocket::DatagramSocket ( )

◆ ~DatagramSocket()

openjaus::system::DatagramSocket::~DatagramSocket ( )
virtual

◆ DatagramSocket() [2/2]

openjaus::system::DatagramSocket::DatagramSocket ( InetAddress  ipAddress,
short  port 
)

Member Function Documentation

◆ enableBroadcast()

bool openjaus::system::DatagramSocket::enableBroadcast ( bool  enabled)
Parameters
enabled

◆ isOpened()

bool openjaus::system::DatagramSocket::isOpened ( ) const

◆ open()

bool openjaus::system::DatagramSocket::open ( InetAddress  ipAddress,
short  port 
)
Parameters
ipAddress
port

◆ receive()

int openjaus::system::DatagramSocket::receive ( Packet &  packet)
virtual
Parameters
packet

Implements openjaus::system::Socket.

◆ reuseAddress()

bool openjaus::system::DatagramSocket::reuseAddress ( bool  enabled)
Parameters
enabled

◆ send()

int openjaus::system::DatagramSocket::send ( Packet &  packet)
virtual
Parameters
packet

Implements openjaus::system::Socket.

◆ setBufferSize()

bool openjaus::system::DatagramSocket::setBufferSize ( uint32_t  size)
Parameters
size

◆ setTimeToLive()

int openjaus::system::DatagramSocket::setTimeToLive ( uint8  ttl)

◆ toString()

std::string openjaus::system::DatagramSocket::toString ( ) const
virtual

Reimplemented from openjaus::system::Socket.

Friends And Related Function Documentation

◆ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const DatagramSocket &  object 
)
friend

◆ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const DatagramSocket *  object 
)
friend

Member Data Documentation

◆ opened

bool openjaus::system::DatagramSocket::opened
protected

◆ tempReceiveBuffer

MemoryBlock openjaus::system::DatagramSocket::tempReceiveBuffer
private

◆ tempSendBuffer

MemoryBlock openjaus::system::DatagramSocket::tempSendBuffer
private
The documentation for this class was generated from the following files: