.TH "KNetwork::KMulticastSocketImpl" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KNetwork::KMulticastSocketImpl \- The low-level backend for multicasting sockets.  

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

.in +1c
.ti -1c
.RI "\fBKMulticastSocketImpl\fP (const \fBKSocketBase\fP *=0L)"
.br
.ti -1c
.RI "virtual \fB~KMulticastSocketImpl\fP ()"
.br
.ti -1c
.RI "virtual int \fBcapabilities\fP () const "
.br
.ti -1c
.RI "virtual bool \fBcreate\fP (int family, int type, int protocol)"
.br
.ti -1c
.RI "virtual bool \fBconnect\fP (const \fBKResolverEntry\fP &address)"
.br
.ti -1c
.RI "virtual int \fBtimeToLive\fP () const "
.br
.ti -1c
.RI "virtual bool \fBsetTimeToLive\fP (int ttl)"
.br
.ti -1c
.RI "virtual bool \fBmulticastLoop\fP () const "
.br
.ti -1c
.RI "virtual bool \fBsetMulticastLoop\fP (bool enable)"
.br
.ti -1c
.RI "virtual \fBKNetworkInterface\fP \fBnetworkInterface\fP ()"
.br
.ti -1c
.RI "virtual bool \fBsetNetworkInterface\fP (const \fBKNetworkInterface\fP &iface)"
.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 
The low-level backend for multicasting sockets. 

This class is an interface providing methods for handling multicast operations.
.PP
\fBAuthor:\fP
.RS 4
Thiago Macieira <thiago.macieira@kdemail.net> 
.RE
.PP

.PP
Definition at line 45 of file kmulticastsocketdevice.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KNetwork::KMulticastSocketImpl::KMulticastSocketImpl (const \fBKSocketBase\fP * = \fC0L\fP)"
.PP
Constructor. 
.PP
.SS "virtual KNetwork::KMulticastSocketImpl::~\fBKMulticastSocketImpl\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
.SH "Member Function Documentation"
.PP 
.SS "virtual int KNetwork::KMulticastSocketImpl::capabilities () const\fC [virtual]\fP"
.PP
Sets our capabilities. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.SS "virtual bool KNetwork::KMulticastSocketImpl::create (int family, int type, int protocol)\fC [virtual]\fP"
.PP
Overrides the socket creation. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.SS "virtual bool KNetwork::KMulticastSocketImpl::connect (const \fBKResolverEntry\fP & address)\fC [virtual]\fP"
.PP
Overrides connection. 
.PP
Multicast sockets may not connect. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.SS "virtual int KNetwork::KMulticastSocketImpl::timeToLive () const\fC [virtual]\fP"
.PP
Retrieves the time-to-live/hop count value on multicast packets being sent. 
.PP
.SS "virtual bool KNetwork::KMulticastSocketImpl::setTimeToLive (int ttl)\fC [virtual]\fP"
.PP
Sets the time-to-live/hop count for outgoing multicast packets. 
.PP
\fBParameters:\fP
.RS 4
\fIttl\fP the hop count, from 0 to 255 
.RE
.PP
\fBReturns:\fP
.RS 4
true if setting the value was successful. 
.RE
.PP

.SS "virtual bool KNetwork::KMulticastSocketImpl::multicastLoop () const\fC [virtual]\fP"
.PP
Retrieves the flag indicating if sent packets will be echoed back to sender. 
.PP
.SS "virtual bool KNetwork::KMulticastSocketImpl::setMulticastLoop (bool enable)\fC [virtual]\fP"
.PP
Sets the flag indicating the loopback of packets to the sender. 
.PP
\fBParameters:\fP
.RS 4
\fIenable\fP if true, will echo back 
.RE
.PP
\fBReturns:\fP
.RS 4
true if setting the value was successful. 
.RE
.PP

.SS "virtual \fBKNetworkInterface\fP KNetwork::KMulticastSocketImpl::networkInterface ()\fC [virtual]\fP"
.PP
Retrieves the network interface this socket is associated to. 
.PP
.SS "virtual bool KNetwork::KMulticastSocketImpl::setNetworkInterface (const \fBKNetworkInterface\fP & iface)\fC [virtual]\fP"
.PP
Sets the network interface on which this socket should work. 
.PP
\fBParameters:\fP
.RS 4
\fIiface\fP the interface to associate with 
.RE
.PP
\fBReturns:\fP
.RS 4
true if setting the value was successful. 
.RE
.PP

.SS "virtual bool KNetwork::KMulticastSocketImpl::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::KMulticastSocketImpl::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::KMulticastSocketImpl::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::KMulticastSocketImpl::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.
