Qt 4.8
qlocalsocket.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtNetwork module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QLOCALSOCKET_H
43 #define QLOCALSOCKET_H
44 
45 #include <QtCore/qiodevice.h>
46 #include <QtNetwork/qabstractsocket.h>
47 
48 QT_BEGIN_HEADER
49 
50 QT_BEGIN_NAMESPACE
51 
52 QT_MODULE(Network)
53 
54 #ifndef QT_NO_LOCALSOCKET
55 
56 class QLocalSocketPrivate;
57 
58 class Q_NETWORK_EXPORT QLocalSocket : public QIODevice
59 {
60  Q_OBJECT
61  Q_DECLARE_PRIVATE(QLocalSocket)
62 
63 public:
64  enum LocalSocketError
65  {
66  ConnectionRefusedError = QAbstractSocket::ConnectionRefusedError,
67  PeerClosedError = QAbstractSocket::RemoteHostClosedError,
68  ServerNotFoundError = QAbstractSocket::HostNotFoundError,
69  SocketAccessError = QAbstractSocket::SocketAccessError,
70  SocketResourceError = QAbstractSocket::SocketResourceError,
71  SocketTimeoutError = QAbstractSocket::SocketTimeoutError,
72  DatagramTooLargeError = QAbstractSocket::DatagramTooLargeError,
73  ConnectionError = QAbstractSocket::NetworkError,
74  UnsupportedSocketOperationError = QAbstractSocket::UnsupportedSocketOperationError,
75  UnknownSocketError = QAbstractSocket::UnknownSocketError
76  };
77 
78  enum LocalSocketState
79  {
80  UnconnectedState = QAbstractSocket::UnconnectedState,
81  ConnectingState = QAbstractSocket::ConnectingState,
82  ConnectedState = QAbstractSocket::ConnectedState,
83  ClosingState = QAbstractSocket::ClosingState
84  };
85 
86  QLocalSocket(QObject *parent = 0);
87  ~QLocalSocket();
88 
89  void connectToServer(const QString &name, OpenMode openMode = ReadWrite);
90  void disconnectFromServer();
91 
92  QString serverName() const;
93  QString fullServerName() const;
94 
95  void abort();
96  virtual bool isSequential() const;
97  virtual qint64 bytesAvailable() const;
98  virtual qint64 bytesToWrite() const;
99  virtual bool canReadLine() const;
100  virtual void close();
101  LocalSocketError error() const;
102  bool flush();
103  bool isValid() const;
104  qint64 readBufferSize() const;
105  void setReadBufferSize(qint64 size);
106 
107  bool setSocketDescriptor(quintptr socketDescriptor,
108  LocalSocketState socketState = ConnectedState,
109  OpenMode openMode = ReadWrite);
110  quintptr socketDescriptor() const;
111 
112  LocalSocketState state() const;
113  bool waitForBytesWritten(int msecs = 30000);
114  bool waitForConnected(int msecs = 30000);
115  bool waitForDisconnected(int msecs = 30000);
116  bool waitForReadyRead(int msecs = 30000);
117 
118 Q_SIGNALS:
119  void connected();
120  void disconnected();
121  void error(QLocalSocket::LocalSocketError socketError);
122  void stateChanged(QLocalSocket::LocalSocketState socketState);
123 
124 protected:
125  virtual qint64 readData(char*, qint64);
126  virtual qint64 writeData(const char*, qint64);
127 
128 private:
129  Q_DISABLE_COPY(QLocalSocket)
130 #if defined(QT_LOCALSOCKET_TCP)
131  Q_PRIVATE_SLOT(d_func(), void _q_stateChanged(QAbstractSocket::SocketState))
132  Q_PRIVATE_SLOT(d_func(), void _q_error(QAbstractSocket::SocketError))
133 #elif defined(Q_OS_WIN)
134  Q_PRIVATE_SLOT(d_func(), void _q_notified())
135  Q_PRIVATE_SLOT(d_func(), void _q_canWrite())
136  Q_PRIVATE_SLOT(d_func(), void _q_pipeClosed())
137  Q_PRIVATE_SLOT(d_func(), void _q_emitReadyRead())
138 #else
139  Q_PRIVATE_SLOT(d_func(), void _q_stateChanged(QAbstractSocket::SocketState))
140  Q_PRIVATE_SLOT(d_func(), void _q_error(QAbstractSocket::SocketError))
141  Q_PRIVATE_SLOT(d_func(), void _q_connectToSocket())
142  Q_PRIVATE_SLOT(d_func(), void _q_abortConnectionAttempt())
143 #endif
144 };
145 
146 #ifndef QT_NO_DEBUG_STREAM
147 #include <QtCore/qdebug.h>
148 Q_NETWORK_EXPORT QDebug operator<<(QDebug, QLocalSocket::LocalSocketError);
149 Q_NETWORK_EXPORT QDebug operator<<(QDebug, QLocalSocket::LocalSocketState);
150 #endif
151 
152 #endif // QT_NO_LOCALSOCKET
153 
154 QT_END_NAMESPACE
155 
156 QT_END_HEADER
157 
158 #endif // QLOCALSOCKET_H
QDebug
The QDebug class provides an output stream for debugging information.
Definition: qdebug.h:62
quintptr
QIntegerForSizeof< void * >::Unsigned quintptr
Definition: qglobal.h:986
QT_END_NAMESPACE
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
QLocalSocket::LocalSocketState
LocalSocketState
This enum describes the different states in which a socket can be.
Definition: qlocalsocket.h:78
operator<<
Q_NETWORK_EXPORT QDebug operator<<(QDebug, QLocalSocket::LocalSocketError)
Definition: qlocalsocket.cpp:500
QT_MODULE
#define QT_MODULE(x)
Definition: qglobal.h:2783
QIODevice::waitForReadyRead
virtual bool waitForReadyRead(int msecs)
Blocks until new data is available for reading and the readyRead() signal has been emitted...
Definition: qiodevice.cpp:1616
QIODevice::close
virtual void close()
First emits aboutToClose(), then closes the device and sets its OpenMode to NotOpen.
Definition: qiodevice.cpp:590
QT_BEGIN_HEADER
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
error
#define error(msg)
Definition: qabstractduration.cpp:58
QIODevice::writeData
virtual qint64 writeData(const char *data, qint64 len)=0
Writes up to maxSize bytes from data to the device.
Q_DISABLE_COPY
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
Q_PRIVATE_SLOT
#define Q_PRIVATE_SLOT(d, signature)
Definition: qobjectdefs.h:73
QString
The QString class provides a Unicode character string.
Definition: qstring.h:83
QObject
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
Q_SIGNALS
#define Q_SIGNALS
Definition: qobjectdefs.h:72
QLocalSocket
The QLocalSocket class provides a local socket.
Definition: qlocalsocket.h:58
QAbstractSocket::SocketState
SocketState
This enum describes the different states in which a socket can be.
Definition: qabstractsocket.h:102
QIODevice::bytesToWrite
virtual qint64 bytesToWrite() const
For buffered devices, this function returns the number of bytes waiting to be written.
Definition: qiodevice.cpp:767
QT_BEGIN_NAMESPACE
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
connected
static QIntfbScreen * connected
Definition: qscreenintegrityfb_qws.cpp:178
name
const char * name
Definition: qkeysequence.cpp:396
QAbstractSocket::SocketError
SocketError
This enum describes the socket errors that can occur.
Definition: qabstractsocket.h:79
qint64
__int64 qint64
Definition: qglobal.h:942
Q_OBJECT
#define Q_OBJECT
Definition: qobjectdefs.h:157
QIODevice::isSequential
virtual bool isSequential() const
Returns true if this device is sequential; otherwise returns false.
Definition: qiodevice.cpp:454
QIODevice::readData
virtual qint64 readData(char *data, qint64 maxlen)=0
Reads up to maxSize bytes from the device into data, and returns the number of bytes read or -1 if an...
Q_NETWORK_EXPORT
#define Q_NETWORK_EXPORT
Definition: qglobal.h:1452
QIODevice::bytesAvailable
virtual qint64 bytesAvailable() const
Returns the number of bytes that are available for reading.
Definition: qiodevice.cpp:752
QIODevice::waitForBytesWritten
virtual bool waitForBytesWritten(int msecs)
For buffered devices, this function waits until a payload of buffered written data has been written t...
Definition: qiodevice.cpp:1648
flush
Q_CORE_EXPORT QTextStream & flush(QTextStream &s)
Q_DECLARE_PRIVATE
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
QIODevice::canReadLine
virtual bool canReadLine() const
Returns true if a complete line of data can be read from the device; otherwise returns false...
Definition: qiodevice.cpp:1330
QIODevice
The QIODevice class is the base interface class of all I/O devices in Qt.
Definition: qiodevice.h:66
QT_END_HEADER
#define QT_END_HEADER
Definition: qglobal.h:137
QLocalSocket::LocalSocketError
LocalSocketError
The LocalServerError enumeration represents the errors that can occur.
Definition: qlocalsocket.h:64
Qt 4.8 Source Code Browser