• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

  • KNetwork
  • KMulticastSocketImpl
Public Member Functions | List of all members
KNetwork::KMulticastSocketImpl Class Reference

#include <kmulticastsocketdevice.h>

Inheritance diagram for KNetwork::KMulticastSocketImpl:
KNetwork::KSocketDevice KNetwork::KActiveSocketBase KNetwork::KPassiveSocketBase KNetwork::KSocketBase KNetwork::KSocketBase

Public Member Functions

 KMulticastSocketImpl (const KSocketBase *=0L)
 
virtual ~KMulticastSocketImpl ()
 
virtual int capabilities () const
 
virtual bool create (int family, int type, int protocol)
 
virtual bool connect (const KResolverEntry &address)
 
virtual int timeToLive () const
 
virtual bool setTimeToLive (int ttl)
 
virtual bool multicastLoop () const
 
virtual bool setMulticastLoop (bool enable)
 
virtual KNetworkInterface networkInterface ()
 
virtual bool setNetworkInterface (const KNetworkInterface &iface)
 
virtual bool joinGroup (const KSocketAddress &group)
 
virtual bool joinGroup (const KSocketAddress &group, const KNetworkInterface &iface)
 
virtual bool leaveGroup (const KSocketAddress &group)
 
virtual bool leaveGroup (const KSocketAddress &group, const KNetworkInterface &iface)
 
- Public Member Functions inherited from KNetwork::KSocketDevice
 KSocketDevice (const KSocketBase *=0L)
 
 KSocketDevice (int fd)
 
virtual ~KSocketDevice ()
 
int socket () const
 
virtual bool setSocketOptions (int opts)
 
virtual bool open (TQ_OpenMode mode)
 
virtual void close ()
 
virtual void flush ()
 
bool create (const KResolverEntry &address)
 
virtual bool bind (const KResolverEntry &address)
 
virtual bool listen (int backlog=5)
 
virtual KSocketDevice * accept ()
 
virtual bool disconnect ()
 
virtual TQ_LONG waitForMore (int msecs, bool *timeout=0L)
 
virtual TQT_TQIO_LONG tqreadBlock (char *data, TQT_TQIO_ULONG maxlen)
 
virtual TQT_TQIO_LONG tqreadBlock (char *data, TQT_TQIO_ULONG maxlen, KSocketAddress &from)
 
virtual TQ_LONG peekBlock (char *data, TQ_ULONG maxlen)
 
virtual TQ_LONG peekBlock (char *data, TQ_ULONG maxlen, KSocketAddress &from)
 
virtual TQT_TQIO_LONG tqwriteBlock (const char *data, TQT_TQIO_ULONG len)
 
virtual TQT_TQIO_LONG tqwriteBlock (const char *data, TQT_TQIO_ULONG len, const KSocketAddress &to)
 
virtual KSocketAddress localAddress () const
 
virtual KSocketAddress peerAddress () const
 
virtual KSocketAddress externalAddress () const
 
TQSocketNotifier * readNotifier () const
 
TQSocketNotifier * writeNotifier () const
 
TQSocketNotifier * exceptionNotifier () const
 
virtual bool poll (bool *input, bool *output, bool *exception=0L, int timeout=-1, bool *timedout=0L)
 
bool poll (int timeout=-1, bool *timedout=0L)
 
- Public Member Functions inherited from KNetwork::KActiveSocketBase
 KActiveSocketBase ()
 
virtual ~KActiveSocketBase ()
 
virtual Offset size () const
 
virtual Offset at () const
 
virtual bool at (Offset)
 
virtual bool atEnd () const
 
virtual int getch ()
 
virtual int putch (int ch)
 
virtual int ungetch (int)
 
- Public Member Functions inherited from KNetwork::KSocketBase
 KSocketBase ()
 
virtual ~KSocketBase ()
 
virtual bool setBlocking (bool enable)
 
bool blocking () const
 
virtual bool setAddressReuseable (bool enable)
 
bool addressReuseable () const
 
virtual bool setIPv6Only (bool enable)
 
bool isIPv6Only () const
 
virtual bool setBroadcast (bool enable)
 
bool broadcast () const
 
KSocketDevice * socketDevice () const
 
virtual void setSocketDevice (KSocketDevice *device)
 
int setRequestedCapabilities (int add, int remove=0)
 
SocketError error () const
 
TQString errorString () const
 
TQMutex * mutex () const
 
- Public Member Functions inherited from KNetwork::KPassiveSocketBase
 KPassiveSocketBase ()
 
virtual ~KPassiveSocketBase ()
 

Additional Inherited Members

- Public Types inherited from KNetwork::KSocketDevice
enum  Capabilities {
  CanConnectString = 0x01, CanBindString = 0x02, CanNotBind = 0x04, CanNotListen = 0x08,
  CanMulticast = 0x10, CanNotUseDatagrams = 0x20
}
 
- Public Types inherited from KNetwork::KSocketBase
enum  SocketOptions {
  Blocking = 0x01, AddressReuseable = 0x02, IPv6Only = 0x04, Keepalive = 0x08,
  Broadcast = 0x10
}
 
enum  SocketError {
  NoError = 0, LookupFailure, AddressInUse, AlreadyCreated,
  AlreadyBound, AlreadyConnected, NotConnected, NotBound,
  NotCreated, WouldBlock, ConnectionRefused, ConnectionTimedOut,
  InProgress, NetFailure, NotSupported, Timeout,
  UnknownError, RemotelyDisconnected
}
 
- Static Public Member Functions inherited from KNetwork::KSocketDevice
static KSocketDevice * createDefault (KSocketBase *parent)
 
static KSocketDevice * createDefault (KSocketBase *parent, int capabilities)
 
static KSocketDeviceFactoryBase * setDefaultImpl (KSocketDeviceFactoryBase *factory)
 
static void addNewImpl (KSocketDeviceFactoryBase *factory, int capabilities)
 
- Static Public Member Functions inherited from KNetwork::KSocketBase
static TQString errorString (SocketError code)
 
static bool isFatalError (int code)
 
- Protected Member Functions inherited from KNetwork::KSocketDevice
 KSocketDevice (bool, const KSocketBase *parent=0L)
 
virtual TQSocketNotifier * createNotifier (TQSocketNotifier::Type type) const
 
- Protected Member Functions inherited from KNetwork::KActiveSocketBase
void setError (int status, SocketError error)
 
void resetError ()
 
- Protected Member Functions inherited from KNetwork::KSocketBase
virtual int socketOptions () const
 
bool hasDevice () const
 
void setError (SocketError error)
 
- Protected Attributes inherited from KNetwork::KSocketDevice
int m_sockfd
 

Detailed Description

The low-level backend for multicasting sockets.

This class is an interface providing methods for handling multicast operations.

Author
Thiago Macieira thiag.nosp@m.o.ma.nosp@m.cieir.nosp@m.a@kd.nosp@m.email.nosp@m..net

Definition at line 45 of file kmulticastsocketdevice.h.

Constructor & Destructor Documentation

KNetwork::KMulticastSocketImpl::KMulticastSocketImpl ( const KSocketBase *  = 0L)

Constructor.

virtual KNetwork::KMulticastSocketImpl::~KMulticastSocketImpl ( )
virtual

Destructor.

Member Function Documentation

virtual int KNetwork::KMulticastSocketImpl::capabilities ( ) const
virtual

Sets our capabilities.

Reimplemented from KNetwork::KSocketDevice.

virtual bool KNetwork::KMulticastSocketImpl::connect ( const KResolverEntry &  address)
virtual

Overrides connection.

Multicast sockets may not connect.

Reimplemented from KNetwork::KSocketDevice.

virtual bool KNetwork::KMulticastSocketImpl::create ( int  family,
int  type,
int  protocol 
)
virtual

Overrides the socket creation.

Reimplemented from KNetwork::KSocketDevice.

virtual bool KNetwork::KMulticastSocketImpl::joinGroup ( const KSocketAddress &  group)
virtual

Joins a multicast group.

The group to be joined is identified by the group parameter.

Parameters
groupthe multicast group to join
Returns
true on success
virtual bool KNetwork::KMulticastSocketImpl::joinGroup ( const KSocketAddress &  group,
const KNetworkInterface &  iface 
)
virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Joins a multicast group.

This function also specifies the network interface to be used.

virtual bool KNetwork::KMulticastSocketImpl::leaveGroup ( const KSocketAddress &  group)
virtual

Leaves a multicast group.

The group being left is given by its address in the group parameter.

Parameters
groupthe group to leave
Returns
true on successful leaving the group
virtual bool KNetwork::KMulticastSocketImpl::leaveGroup ( const KSocketAddress &  group,
const KNetworkInterface &  iface 
)
virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Leaves a multicast group.

virtual bool KNetwork::KMulticastSocketImpl::multicastLoop ( ) const
virtual

Retrieves the flag indicating if sent packets will be echoed back to sender.

virtual KNetworkInterface KNetwork::KMulticastSocketImpl::networkInterface ( )
virtual

Retrieves the network interface this socket is associated to.

virtual bool KNetwork::KMulticastSocketImpl::setMulticastLoop ( bool  enable)
virtual

Sets the flag indicating the loopback of packets to the sender.

Parameters
enableif true, will echo back
Returns
true if setting the value was successful.
virtual bool KNetwork::KMulticastSocketImpl::setNetworkInterface ( const KNetworkInterface &  iface)
virtual

Sets the network interface on which this socket should work.

Parameters
ifacethe interface to associate with
Returns
true if setting the value was successful.
virtual bool KNetwork::KMulticastSocketImpl::setTimeToLive ( int  ttl)
virtual

Sets the time-to-live/hop count for outgoing multicast packets.

Parameters
ttlthe hop count, from 0 to 255
Returns
true if setting the value was successful.
virtual int KNetwork::KMulticastSocketImpl::timeToLive ( ) const
virtual

Retrieves the time-to-live/hop count value on multicast packets being sent.


The documentation for this class was generated from the following file:
  • kmulticastsocketdevice.h

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.8.6
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |