MulticastClient Class Reference

Provides User Datagram Protocol (UDP) multicast mode network services. More...

List of all members.

Public Member Functions
	MulticastClient ()
	Creates a MulticastClient.
virtual	~MulticastClient ()
	Destructor.
void	join (const std::string &ip, int port)
	Adds a MulticastClient to the multicast group using all network interfaces.
void	join (const std::string &ip, int port, const std::string &networkInterface)
	Adds a MulticastClient to the multicast group using the given network interface.
void	drop ()
	Leaves the multicast group.
const std::vector< char > &	receive ()
	Receives a multicast packet.
const std::vector< char > &	receive (long timeoutInMilliseconds)
	Receives a multicast packet.
void	send (const std::string &packet)
	Sends the given multicast packet.
void	send (const char *packet, size_t packetSize)
	Sends the given multicast packet.

---

Detailed Description

Provides User Datagram Protocol (UDP) multicast mode network services.

Definition at line 19 of file MulticastClient.h.

---

Constructor & Destructor Documentation

MulticastClient

(

)

Creates a MulticastClient.

virtual ~MulticastClient

(

)

[virtual]

Destructor.

---

Member Function Documentation

void join	(	const std::string &	ip,
		int	port
	)

Adds a MulticastClient to the multicast group using all network interfaces.

void join	(	const std::string &	ip,
		int	port,
		const std::string &	networkInterface
	)

Adds a MulticastClient to the multicast group using the given network interface.

void drop

(

)

Leaves the multicast group.

const std::vector<char>& receive

(

)

Receives a multicast packet.

Note:

Blocks until the packet is received.

Multicast group must be joined first.

Returns:

The received multicast packet.

const std::vector<char>& receive

(

long

timeoutInMilliseconds

)

Receives a multicast packet.

Note:

Blocks until the packet is received or the timeout period is elapsed.

Multicast group must be joined first.

Returns:

The received multicast packet or an empty vector if the timeout period is elapsed.

void send

(

const std::string &

packet

)

Sends the given multicast packet.

void send	(	const char *	packet,
		size_t	packetSize
	)

Sends the given multicast packet.

---

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

• MulticastClient.h

---