• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDECore

  • kdecore
  • network
k3datagramsocket.cpp
Go to the documentation of this file.
1 /* -*- C++ -*-
2  * Copyright (C) 2003,2004 Thiago Macieira <thiago@kde.org>
3  *
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included
14  * in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
25 #include "k3datagramsocket.h"
26 
27 #include <config.h>
28 #include <config-network.h>
29 
30 #include <sys/types.h>
31 #include <sys/socket.h>
32 
33 #include "k3socketaddress.h"
34 #include "k3resolver.h"
35 #include "k3socketdevice.h"
36 
37 using namespace KNetwork;
38 
39 /*
40  * TODO:
41  *
42  * don't use signals and slots to track state changes: use stateChanging
43  *
44  */
45 
46 KDatagramSocket::KDatagramSocket(QObject* parent)
47  : KClientSocketBase(parent), d(0L)
48 {
49  peerResolver().setFamily(KResolver::KnownFamily);
50  localResolver().setFamily(KResolver::KnownFamily);
51 
52  peerResolver().setSocketType(SOCK_DGRAM);
53  localResolver().setSocketType(SOCK_DGRAM);
54 
55  localResolver().setFlags(KResolver::Passive);
56 
57  // QObject::connect(localResolver(), SIGNAL(finished(KNetwork::KResolverResults))
58  // this, SLOT(lookupFinishedLocal()));
59  QObject::connect(&peerResolver(),
60  SIGNAL(finished(KNetwork::KResolverResults)),
61  this, SLOT(lookupFinishedPeer()));
62  QObject::connect(this, SIGNAL(hostFound()), this, SLOT(lookupFinishedLocal()));
63 }
64 
65 KDatagramSocket::~KDatagramSocket()
66 {
67  // KClientSocketBase's destructor closes the socket
68 
69  //delete d;
70 }
71 
72 bool KDatagramSocket::bind(const QString& node, const QString& service)
73 {
74  if (state() >= Bound)
75  return false;
76 
77  if (localResolver().isRunning())
78  localResolver().cancel(false);
79 
80  // no, we must do a host lookup
81  localResolver().setAddress(node, service);
82 
83  if (!lookup())
84  return false;
85 
86  // see if lookup has finished already
87  // this also catches blocking mode, since lookup has to finish
88  // its processing if we're in blocking mode
89  if (state() > HostLookup)
90  return doBind();
91 
92  return true;
93 }
94 
95 bool KDatagramSocket::bind(const KResolverEntry& entry)
96 {
97  return KClientSocketBase::bind(entry);
98 }
99 
100 bool KDatagramSocket::connect(const QString& node, const QString& service,
101  OpenMode mode)
102 {
103  if (state() >= Connected)
104  return true; // already connected
105 
106  if (peerResolver().nodeName() != node ||
107  peerResolver().serviceName() != service)
108  peerResolver().setAddress(node, service); // this resets the resolver's state
109 
110  // KClientSocketBase::lookup only works if the state is Idle or HostLookup
111  // therefore, we store the old state, call the lookup routine and then set
112  // it back.
113  SocketState s = state();
114  setState(s == Connecting ? HostLookup : Idle);
115  bool ok = lookup();
116  if (!ok)
117  {
118  setState(s); // go back
119  return false;
120  }
121 
122  // check if lookup is finished
123  // if we're in blocking mode, then the lookup has to be finished
124  if (state() == HostLookup)
125  {
126  // it hasn't finished
127  setState(Connecting);
128  emit stateChanged(Connecting);
129  return true;
130  }
131 
132  // it has to be finished here
133  if (state() != Connected)
134  {
135  setState(Connecting);
136  emit stateChanged(Connecting);
137  lookupFinishedPeer();
138  }
139 
140  KActiveSocketBase::open(mode | Unbuffered);
141  return state() == Connected;
142 }
143 
144 bool KDatagramSocket::connect(const KResolverEntry& entry, OpenMode mode)
145 {
146  return KClientSocketBase::connect(entry, mode);
147 }
148 
149 KDatagramPacket KDatagramSocket::receive()
150 {
151  qint64 size = bytesAvailable();
152  if (size == 0)
153  {
154  // nothing available yet to read
155  // wait for data if we're not blocking
156  if (blocking())
157  socketDevice()->waitForMore(-1); // wait forever
158  else
159  {
160  // mimic error
161  setError(WouldBlock);
162  emit gotError(WouldBlock);
163  return KDatagramPacket();
164  }
165 
166  // try again
167  size = bytesAvailable();
168  }
169 
170  QByteArray data;
171  data.resize(size);
172  KSocketAddress address;
173 
174  // now do the reading
175  size = read(data.data(), size, address);
176  if (size < 0)
177  // error has been set
178  return KDatagramPacket();
179 
180  data.resize(size); // just to be sure
181  return KDatagramPacket(data, address);
182 }
183 
184 qint64 KDatagramSocket::send(const KDatagramPacket& packet)
185 {
186  return write(packet.data(), packet.size(), packet.address());
187 }
188 
189 qint64 KDatagramSocket::writeData(const char *data, qint64 len,
190  const KSocketAddress* to)
191 {
192  if (to->family() != AF_UNSPEC)
193  {
194  // make sure the socket is open at this point
195  if (!socketDevice()->isOpen())
196  // error handling will happen below
197  socketDevice()->create(to->family(), SOCK_DGRAM, 0);
198  }
199  return KClientSocketBase::writeData(data, len, to);
200 }
201 
202 void KDatagramSocket::lookupFinishedLocal()
203 {
204  // bind lookup has finished and succeeded
205  // state() == HostFound
206 
207  if (!doBind())
208  return; // failed binding
209 
210  if (peerResults().count() > 0)
211  {
212  setState(Connecting);
213  emit stateChanged(Connecting);
214 
215  lookupFinishedPeer();
216  }
217 }
218 
219 void KDatagramSocket::lookupFinishedPeer()
220 {
221  // this function is called by lookupFinishedLocal above
222  // and is also connected to a signal
223  // so it might be called twice.
224 
225  if (state() != Connecting)
226  return;
227 
228  if (peerResults().count() == 0)
229  {
230  setState(Unconnected);
231  emit stateChanged(Unconnected);
232  return;
233  }
234 
235  KResolverResults::ConstIterator it = peerResults().begin();
236  for ( ; it != peerResults().end(); ++it)
237  if (connect(*it))
238  {
239  // weee, we connected
240 
241  setState(Connected); // this sets up signals
242  //setupSignals(); // setState sets up the signals
243 
244  emit stateChanged(Connected);
245  emit connected(*it);
246  return;
247  }
248 
249  // no connection
250  copyError();
251  setState(Unconnected);
252  emit stateChanged(Unconnected);
253  emit gotError(error());
254 }
255 
256 bool KDatagramSocket::doBind()
257 {
258  if (localResults().count() == 0)
259  return true;
260  if (state() >= Bound)
261  return true; // already bound
262 
263  KResolverResults::ConstIterator it = localResults().begin();
264  for ( ; it != localResults().end(); ++it)
265  if (bind(*it))
266  {
267  // bound
268  setupSignals();
269  KActiveSocketBase::open(ReadWrite | Unbuffered);
270  return true;
271  }
272 
273  // not bound
274  // no need to set state since it can only be HostFound already
275  copyError();
276  emit gotError(error());
277  return false;
278 }
279 
280 void KDatagramSocket::setupSignals()
281 {
282  QSocketNotifier *n = socketDevice()->readNotifier();
283  if (n)
284  {
285  n->setEnabled(emitsReadyRead());
286  QObject::connect(n, SIGNAL(activated(int)), this, SLOT(slotReadActivity()));
287  }
288  else
289  return;
290 
291  n = socketDevice()->writeNotifier();
292  if (n)
293  {
294  n->setEnabled(emitsReadyWrite());
295  QObject::connect(n, SIGNAL(activated(int)), this, SLOT(slotWriteActivity()));
296  }
297  else
298  return;
299 }
300 
301 #include "k3datagramsocket.moc"
KNetwork::KDatagramPacket::size
uint size() const
Returns the data length.
Definition: k3datagramsocket.h:120
KNetwork::KSocketDevice::readNotifier
QSocketNotifier * readNotifier() const
Returns a socket notifier for input on this socket.
Definition: k3socketdevice.cpp:647
k3socketaddress.h
KNetwork::KClientSocketBase::connect
virtual bool connect(const QString &node=QString(), const QString &service=QString(), OpenMode mode=ReadWrite)=0
Attempts to connect to a given hostname and service, or use the default ones if none are given...
qint64
KNetwork::KClientSocketBase::Idle
Definition: k3clientsocketbase.h:74
k3socketdevice.h
KNetwork::KClientSocketBase::HostLookup
Definition: k3clientsocketbase.h:75
KNetwork::KDatagramSocket::receive
virtual KDatagramPacket receive()
Receives one datagram from the stream.
Definition: k3datagramsocket.cpp:149
KNetwork::KSocketDevice::writeNotifier
QSocketNotifier * writeNotifier() const
Returns a socket notifier for output on this socket.
Definition: k3socketdevice.cpp:665
KNetwork::KSocketBase::blocking
bool blocking() const
Retrieves this socket&#39;s blocking mode.
Definition: k3socketbase.cpp:102
KNetwork::KResolverEntry
One resolution entry.
Definition: k3resolver.h:68
k3datagramsocket.h
KNetwork::KClientSocketBase::state
SocketState state() const
Returns the current state for this socket.
Definition: k3clientsocketbase.cpp:66
KNetwork::KResolver::setFamily
void setFamily(int families)
Sets the allowed socket families.
Definition: k3resolver.cpp:385
KNetwork::KClientSocketBase::bind
virtual bool bind(const QString &node=QString(), const QString &service=QString())=0
Binds this socket to the given nodename and service, or use the default ones if none are given...
KNetwork::KClientSocketBase::peerResults
const KResolverResults & peerResults() const
Returns the internal list of resolved results for the peer address.
Definition: k3clientsocketbase.cpp:98
KNetwork::KClientSocketBase::lookup
virtual bool lookup()
Starts the lookup for peer and local hostnames as well as their services.
Definition: k3clientsocketbase.cpp:133
KNetwork::KClientSocketBase::Bound
Definition: k3clientsocketbase.h:77
KNetwork::KClientSocketBase::slotReadActivity
virtual void slotReadActivity()
This slot is connected to the read notifier&#39;s signal meaning the socket can read more data...
Definition: k3clientsocketbase.cpp:394
KNetwork::KSocketAddress
A generic socket address.
Definition: k3socketaddress.h:414
QString
KNetwork::KClientSocketBase::gotError
void gotError(int code)
This signal is emitted when this object finds an error.
KNetwork::KDatagramSocket::bind
virtual bool bind(const QString &node=QString(), const QString &service=QString())
Performs host lookups.
Definition: k3datagramsocket.cpp:72
KNetwork::KClientSocketBase::hostFound
void hostFound()
This signal is emitted when the lookup is successfully completed.
QObject
KNetwork::KResolverResults
Name and service resolution results.
Definition: k3resolver.h:212
KNetwork::KDatagramSocket::KDatagramSocket
KDatagramSocket(QObject *parent=0L)
Default constructor.
Definition: k3datagramsocket.cpp:46
KNetwork::KDatagramSocket::connect
virtual bool connect(const QString &node=QString(), const QString &service=QString(), OpenMode mode=ReadWrite)
"Connects" this socket to the given address.
Definition: k3datagramsocket.cpp:100
KNetwork::KActiveSocketBase::open
virtual bool open(OpenMode mode)
Reimplemented from QIODevice.
Definition: k3socketbase.cpp:339
KNetwork::KClientSocketBase::writeData
virtual qint64 writeData(const char *data, qint64 len, const KSocketAddress *to)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: k3clientsocketbase.cpp:340
KNetwork::KActiveSocketBase::read
qint64 read(char *data, qint64 maxlen)
Reads data from the socket.
Definition: k3socketbase.cpp:378
KNetwork::KSocketBase::WouldBlock
Definition: k3socketbase.h:154
KNetwork
A namespace to store all networking-related (socket) classes.
Definition: k3bufferedsocket.h:35
KNetwork::KClientSocketBase::copyError
void copyError()
Convenience function to set this object&#39;s error code to match that of the socket device.
Definition: k3clientsocketbase.cpp:453
KNetwork::KDatagramSocket::writeData
virtual qint64 writeData(const char *data, qint64 len, const KSocketAddress *to)
Writes data to the socket.
Definition: k3datagramsocket.cpp:189
KNetwork::KClientSocketBase::emitsReadyWrite
bool emitsReadyWrite() const
Returns true if the readyWrite signal is set to be emitted.
Definition: k3clientsocketbase.cpp:379
KNetwork::KSocketDevice::create
virtual bool create(int family, int type, int protocol)
Creates a socket but don&#39;t connect or bind anywhere.
Definition: k3socketdevice.cpp:261
KNetwork::KDatagramPacket::address
const KSocketAddress & address() const
Returns the socket address.
Definition: k3datagramsocket.h:138
KNetwork::KClientSocketBase::localResults
const KResolverResults & localResults() const
Returns the internal list of resolved results for the local address.
Definition: k3clientsocketbase.cpp:108
KNetwork::KClientSocketBase::SocketState
SocketState
Socket states.
Definition: k3clientsocketbase.h:72
KNetwork::KClientSocketBase::localResolver
KResolver & localResolver() const
Returns the internal KResolver object used for looking up the local host name and service...
Definition: k3clientsocketbase.cpp:103
KNetwork::KDatagramSocket::~KDatagramSocket
virtual ~KDatagramSocket()
Destructor.
Definition: k3datagramsocket.cpp:65
KNetwork::KClientSocketBase::setState
void setState(SocketState state)
Sets the socket state to state.
Definition: k3clientsocketbase.cpp:71
KNetwork::KClientSocketBase::Connected
Definition: k3clientsocketbase.h:83
KNetwork::KResolver::KnownFamily
Definition: k3resolver.h:346
KNetwork::KClientSocketBase::stateChanged
void stateChanged(int newstate)
This signal is emitted whenever the socket state changes.
KNetwork::KActiveSocketBase::setError
void setError(SocketError error)
Sets the socket&#39;s error code.
Definition: k3socketbase.cpp:435
KNetwork::KActiveSocketBase::write
qint64 write(const char *data, qint64 len)
Writes the given data to the socket.
Definition: k3socketbase.cpp:404
k3resolver.h
KNetwork::KSocketAddress::family
int family() const
Returns the family of this address.
Definition: k3socketaddress.cpp:487
KNetwork::KDatagramPacket
one datagram
Definition: k3datagramsocket.h:52
KNetwork::KActiveSocketBase::size
virtual qint64 size() const
This call is not supported on sockets.
Definition: k3socketbase.cpp:358
KNetwork::KClientSocketBase::emitsReadyRead
bool emitsReadyRead() const
Returns true if the readyRead signal is set to be emitted.
Definition: k3clientsocketbase.cpp:364
KNetwork::KSocketDevice::waitForMore
virtual qint64 waitForMore(int msecs, bool *timeout=0L)
Waits up to msecs for more data to be available on this socket.
Definition: k3socketdevice.cpp:451
KNetwork::KClientSocketBase::Connecting
Definition: k3clientsocketbase.h:78
KNetwork::KDatagramSocket::send
virtual qint64 send(const KDatagramPacket &packet)
Sends one datagram into the stream.
Definition: k3datagramsocket.cpp:184
KNetwork::KResolver::Passive
Definition: k3resolver.h:369
KNetwork::KClientSocketBase
Abstract client socket class.
Definition: k3clientsocketbase.h:50
KNetwork::KClientSocketBase::Unconnected
Definition: k3clientsocketbase.h:82
KNetwork::KClientSocketBase::peerResolver
KResolver & peerResolver() const
Returns the internal KResolver object used for looking up the peer host name and service.
Definition: k3clientsocketbase.cpp:93
KNetwork::KResolver::setSocketType
void setSocketType(int type)
Sets the socket type we want.
Definition: k3resolver.cpp:395
KNetwork::KResolver::cancel
void cancel(bool emitSignal=true)
Cancels a running request.
Definition: k3resolver.cpp:496
KNetwork::KSocketBase::error
SocketError error() const
Retrieves the socket error code.
Definition: k3socketbase.cpp:197
KNetwork::KClientSocketBase::bytesAvailable
virtual qint64 bytesAvailable() const
Returns the number of bytes available on this socket.
Definition: k3clientsocketbase.cpp:296
KNetwork::KResolver::setFlags
int setFlags(int flags)
Sets the flags.
Definition: k3resolver.cpp:373
KNetwork::KSocketBase::socketDevice
KSocketDevice * socketDevice() const
Retrieves the socket implementation used on this socket.
Definition: k3socketbase.cpp:148
KNetwork::KClientSocketBase::connected
void connected(const KNetwork::KResolverEntry &remote)
This socket is emitted when the socket successfully connects to a remote address. ...
KNetwork::KResolver::setAddress
void setAddress(const QString &node, const QString &service)
Sets both the host and the service names.
Definition: k3resolver.cpp:360
KNetwork::KClientSocketBase::slotWriteActivity
virtual void slotWriteActivity()
This slot is connected to the write notifier&#39;s signal meaning the socket can write more data...
Definition: k3clientsocketbase.cpp:400
KNetwork::KDatagramPacket::data
const QByteArray & data() const
Returns the data.
Definition: k3datagramsocket.h:108
This file is part of the KDE documentation.
Documentation copyright © 1996-2018 The KDE developers.
Generated on Wed Aug 22 2018 19:24:29 by doxygen 1.8.14 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

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

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal