.TH "KNetwork::KMulticastSocket" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KNetwork::KMulticastSocket \- A multicast-capable datagram socket class.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kmulticastsocket.h>\fP
.PP
Inherits \fBKNetwork::KDatagramSocket\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKMulticastSocket\fP (\fBQObject\fP *\fBparent\fP=0L, const char *\fBname\fP=0L)"
.br
.ti -1c
.RI "\fB~KMulticastSocket\fP ()"
.br
.ti -1c
.RI "\fBKMulticastSocketImpl\fP * \fBmulticastSocketDevice\fP ()"
.br
.ti -1c
.RI "const \fBKMulticastSocketImpl\fP * \fBmulticastSocketDevice\fP () const "
.br
.ti -1c
.RI "virtual bool \fBjoinGroup\fP (const \fBKSocketAddress\fP &group)"
.br
.ti -1c
.RI "virtual bool \fBjoinGroup\fP (const \fBKSocketAddress\fP &group, const \fBKNetworkInterface\fP &iface)"
.br
.ti -1c
.RI "virtual bool \fBleaveGroup\fP (const \fBKSocketAddress\fP &group)"
.br
.ti -1c
.RI "virtual bool \fBleaveGroup\fP (const \fBKSocketAddress\fP &group, const \fBKNetworkInterface\fP &iface)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A multicast-capable datagram socket class. 

This class derives from \fBKDatagramSocket\fP adding methods to it to allow better control over the multicast functionality. In special, the join and leave group functions are added.
.PP
Other more low-level options on multicast sockets can be accessed directly with the \fBKMulticastSocketImpl\fP class returned by \fBmulticastSocketDevice\fP.
.PP
\fBAuthor:\fP
.RS 4
Thiago Macieira <thiago.macieira@kdemail.net> 
.RE
.PP

.PP
Definition at line 48 of file kmulticastsocket.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KNetwork::KMulticastSocket::KMulticastSocket (\fBQObject\fP * parent = \fC0L\fP, const char * name = \fC0L\fP)"
.PP
Constructor. 
.PP
.SS "KNetwork::KMulticastSocket::~\fBKMulticastSocket\fP ()"
.PP
Destructor. 
.PP
.SH "Member Function Documentation"
.PP 
.SS "\fBKMulticastSocketImpl\fP* KNetwork::KMulticastSocket::multicastSocketDevice ()"
.PP
Returns the multicast socket device in use by this object. 
.PP
\fBNote:\fP
.RS 4
The returned object can be null. 
.RE
.PP

.SS "const \fBKMulticastSocketImpl\fP* KNetwork::KMulticastSocket::multicastSocketDevice () const"
.PP
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 
.SS "virtual bool KNetwork::KMulticastSocket::joinGroup (const \fBKSocketAddress\fP & group)\fC [virtual]\fP"
.PP
Joins a multicast group. 
.PP
The group to be joined is identified by the \fCgroup\fP parameter.
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP the multicast group to join 
.RE
.PP
\fBReturns:\fP
.RS 4
true on success 
.RE
.PP

.SS "virtual bool KNetwork::KMulticastSocket::joinGroup (const \fBKSocketAddress\fP & group, const \fBKNetworkInterface\fP & iface)\fC [virtual]\fP"
.PP
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
.PP
Joins a multicast group. This function also specifies the network interface to be used. 
.SS "virtual bool KNetwork::KMulticastSocket::leaveGroup (const \fBKSocketAddress\fP & group)\fC [virtual]\fP"
.PP
Leaves a multicast group. 
.PP
The group being left is given by its address in the \fCgroup\fP parameter.
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP the group to leave 
.RE
.PP
\fBReturns:\fP
.RS 4
true on successful leaving the group 
.RE
.PP

.SS "virtual bool KNetwork::KMulticastSocket::leaveGroup (const \fBKSocketAddress\fP & group, const \fBKNetworkInterface\fP & iface)\fC [virtual]\fP"
.PP
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
.PP
Leaves a multicast group. 

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
