openjaus::system::MulticastSocket Class Reference

This is a brief description. More...

#include <MulticastSocket.h>

Inherits openjaus::system::Socket.

Public Member Functions
	MulticastSocket ()
virtual	~MulticastSocket ()
	MulticastSocket (InetAddress ipAddress, short port)
int	getMultiDescriptor () const
	Accessor to get the value of multiDescriptor. More...
int	getMaxDescriptor () const
	Accessor to get the value of maxDescriptor. More...
bool	open (InetAddress ipAddress, short port)
	Operation open. More...
bool	joinGroup (InetAddress group)
	Operation joinGroup. More...
int	setTimeToLive (uint8 ttl)
	Operation setTimeToLive. More...
int	setLoopback (bool enabled)
	Operation setLoopback. 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...
virtual std::string	toString () const
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
int	multiDescriptor
int	maxDescriptor
fd_set	readSet
Protected Attributes inherited from openjaus::system::Socket
bool	blocking
uint16_t	port
int	descriptor
InetAddress	ipAddress
Time	timeout
std::vector< NetworkInterface *>	interfaces

Private Member Functions
void	setSocketOptionReuseAddress (int socket, bool value)

Private Attributes
MemoryBlock	tempReceiveBuffer
MemoryBlock	tempSendBuffer

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const MulticastSocket &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const MulticastSocket *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

MulticastSocket() [1/2]

openjaus::system::MulticastSocket::MulticastSocket

(

)

~MulticastSocket()

openjaus::system::MulticastSocket::~MulticastSocket ( )

virtual

MulticastSocket() [2/2]

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

Member Function Documentation

enableBroadcast()

bool openjaus::system::MulticastSocket::enableBroadcast

(

bool

enabled

)

Parameters

enabled

getMaxDescriptor()

int openjaus::system::MulticastSocket::getMaxDescriptor

(

)

const

getMultiDescriptor()

int openjaus::system::MulticastSocket::getMultiDescriptor

(

)

const

joinGroup()

bool openjaus::system::MulticastSocket::joinGroup

(

InetAddress

group

)

Parameters

group

open()

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

Parameters

ipAddress
port

receive()

int openjaus::system::MulticastSocket::receive ( Packet &  packet )

virtual

Parameters

packet

Implements openjaus::system::Socket.

reuseAddress()

bool openjaus::system::MulticastSocket::reuseAddress

(

bool

enabled

)

Parameters

enabled

send()

int openjaus::system::MulticastSocket::send ( Packet &  packet )

virtual

Parameters

packet

Implements openjaus::system::Socket.

setLoopback()

int openjaus::system::MulticastSocket::setLoopback

(

bool

enabled

)

Parameters

enabled

setSocketOptionReuseAddress()

void openjaus::system::MulticastSocket::setSocketOptionReuseAddress ( int  socket, bool  value  )

private

setTimeToLive()

int openjaus::system::MulticastSocket::setTimeToLive

(

uint8

ttl

)

Parameters

ttl

toString()

std::string openjaus::system::MulticastSocket::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 MulticastSocket &  object  )

friend

operator<< [2/2]

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

friend

Member Data Documentation

maxDescriptor

int openjaus::system::MulticastSocket::maxDescriptor

protected

multiDescriptor

int openjaus::system::MulticastSocket::multiDescriptor

protected

readSet

fd_set openjaus::system::MulticastSocket::readSet

protected

tempReceiveBuffer

MemoryBlock openjaus::system::MulticastSocket::tempReceiveBuffer

private

tempSendBuffer

MemoryBlock openjaus::system::MulticastSocket::tempSendBuffer

private

---

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

• include/openjaus/system/MulticastSocket.h
• src/openjaus/system/MulticastSocket.cpp