summaryrefslogtreecommitdiffstats
path: root/src/network/socket/qsymbiansocketengine_p.h
blob: 85ab54af122622e9d07f4a38bfd980c8e1c34b51 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtNetwork module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QSYMBIANSOCKETENGINE_P_H
#define QSYMBIANSOCKETENGINE_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of the QLibrary class.  This header file may change from
// version to version without notice, or even be removed.
//
// We mean it.
//
#include "QtNetwork/qhostaddress.h"
#include "private/qabstractsocketengine_p.h"
#include "qplatformdefs.h"

#include <private/qeventdispatcher_symbian_p.h>
#include <unistd.h>
#include <es_sock.h>
#include <in_sock.h>

QT_BEGIN_NAMESPACE


class QSymbianSocketEnginePrivate;
class QNetworkInterface;

class Q_AUTOTEST_EXPORT QSymbianSocketEngine : public QAbstractSocketEngine
{
    Q_OBJECT
    friend class QAsyncSelect;
public:
    QSymbianSocketEngine(QObject *parent = 0);
    ~QSymbianSocketEngine();

    bool initialize(QAbstractSocket::SocketType type, QAbstractSocket::NetworkLayerProtocol protocol = QAbstractSocket::IPv4Protocol);
    bool initialize(int socketDescriptor, QAbstractSocket::SocketState socketState = QAbstractSocket::ConnectedState);

    int socketDescriptor() const;

    bool isValid() const;

    bool connectToHost(const QHostAddress &address, quint16 port);
    bool connectToHostByName(const QString &name, quint16 port);
    bool bind(const QHostAddress &address, quint16 port);
    bool listen();
    int accept();
    void close();

    bool joinMulticastGroup(const QHostAddress &groupAddress,
                            const QNetworkInterface &iface);
    bool leaveMulticastGroup(const QHostAddress &groupAddress,
                             const QNetworkInterface &iface);
    QNetworkInterface multicastInterface() const;
    bool setMulticastInterface(const QNetworkInterface &iface);

    qint64 bytesAvailable() const;

    qint64 read(char *data, qint64 maxlen);
    qint64 write(const char *data, qint64 len);

    qint64 readDatagram(char *data, qint64 maxlen, QHostAddress *addr = 0,
                            quint16 *port = 0);
    qint64 writeDatagram(const char *data, qint64 len, const QHostAddress &addr,
                             quint16 port);
    bool hasPendingDatagrams() const;
    qint64 pendingDatagramSize() const;

    qint64 bytesToWrite() const;

    qint64 receiveBufferSize() const;
    void setReceiveBufferSize(qint64 bufferSize);

    qint64 sendBufferSize() const;
    void setSendBufferSize(qint64 bufferSize);

    int option(SocketOption option) const;
    bool setOption(SocketOption option, int value);

    bool waitForRead(int msecs = 30000, bool *timedOut = 0);
    bool waitForWrite(int msecs = 30000, bool *timedOut = 0);
    bool waitForReadOrWrite(bool *readyToRead, bool *readyToWrite,
                bool checkRead, bool checkWrite,
                int msecs = 30000, bool *timedOut = 0);

    bool isReadNotificationEnabled() const;
    void setReadNotificationEnabled(bool enable);
    bool isWriteNotificationEnabled() const;
    void setWriteNotificationEnabled(bool enable);
    bool isExceptionNotificationEnabled() const;
    void setExceptionNotificationEnabled(bool enable);

    bool event(QEvent* ev);

    Q_INVOKABLE void startNotifications();

public Q_SLOTS:
    // TODO: Why do we do this? This is private Qt implementation stuff anyway, no need for it
    // non-virtual override;
    void connectionNotification();

private:
    Q_DECLARE_PRIVATE(QSymbianSocketEngine)
    Q_DISABLE_COPY(QSymbianSocketEngine)
};

class QSocketNotifier;

class QReadNotifier;
class QWriteNotifier;
class QExceptionNotifier;
class QAsyncSelect : public QActiveObject
{
public:
    QAsyncSelect(QEventDispatcherSymbian *dispatcher, RSocket& sock, QSymbianSocketEngine *parent);
    ~QAsyncSelect();

    void deleteLater();
    void IssueRequest();

    void refresh();

protected:
    void DoCancel();
    void RunL();
    void run();
    TInt RunError(TInt aError);

private:
    bool m_inSocketEvent;
    bool m_deleteLater;
    RSocket &m_socket;

    TUint m_selectFlags;
    TPckgBuf<TUint> m_selectBuf; //in & out IPC buffer
    QSymbianSocketEngine *engine;
};

class QSymbianSocketEnginePrivate : public QAbstractSocketEnginePrivate
{
    Q_DECLARE_PUBLIC(QSymbianSocketEngine)
public:
    QSymbianSocketEnginePrivate();
    ~QSymbianSocketEnginePrivate();

    int socketDescriptor;
    mutable RSocket nativeSocket;
    // From QtCore:
    RSocketServ& socketServer;
    mutable RTimer selectTimer;

    bool readNotificationsEnabled;
    bool writeNotificationsEnabled;
    bool exceptNotificationsEnabled;
    QAsyncSelect* asyncSelect;

    // FIXME this is duplicated from qnativesocketengine_p.h
    enum ErrorString {
        NonBlockingInitFailedErrorString,
        BroadcastingInitFailedErrorString,
        NoIpV6ErrorString,
        RemoteHostClosedErrorString,
        TimeOutErrorString,
        ResourceErrorString,
        OperationUnsupportedErrorString,
        ProtocolUnsupportedErrorString,
        InvalidSocketErrorString,
        HostUnreachableErrorString,
        NetworkUnreachableErrorString,
        AccessErrorString,
        ConnectionTimeOutErrorString,
        ConnectionRefusedErrorString,
        AddressInuseErrorString,
        AddressNotAvailableErrorString,
        AddressProtectedErrorString,
        DatagramTooLargeErrorString,
        SendDatagramErrorString,
        ReceiveDatagramErrorString,
        WriteErrorString,
        ReadErrorString,
        PortInuseErrorString,
        NotSocketErrorString,
        InvalidProxyTypeString,
        //symbian specific
        InvalidAddressErrorString,
        SessionNotOpenErrorString,

        UnknownSocketErrorString = -1
    };
    void setError(QAbstractSocket::SocketError error, ErrorString errorString) const;

    void getPortAndAddress(const TInetAddr& a, quint16 *port, QHostAddress *addr);
    void setPortAndAddress(TInetAddr& nativeAddr, quint16 port, const QHostAddress &addr);
    void setError(TInt symbianError);

    int nativeSelect(int timeout, bool selectForRead) const;
    int nativeSelect(int timeout, bool checkRead, bool checkWrite,
                           bool *selectForRead, bool *selectForWrite) const;

    bool createNewSocket(QAbstractSocket::SocketType socketType,
                                             QAbstractSocket::NetworkLayerProtocol socketProtocol);

    bool checkProxy(const QHostAddress &address);
    bool fetchConnectionParameters();

    bool multicastGroupMembershipHelper(const QHostAddress &groupAddress,
                              const QNetworkInterface &iface,
                              TUint operation);
    static bool translateSocketOption(QAbstractSocketEngine::SocketOption opt, TUint &n, TUint &level);
};

QT_END_NAMESPACE

#endif // QSYMBIANSOCKETENGINE_P_H