diff options
author | Fabian Bumberger <fbumberger@rim.com> | 2013-09-16 21:44:40 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-09-18 17:24:25 +0200 |
commit | 4810f41772cd0b86f04064f556d2c88cdc4a548f (patch) | |
tree | 3fd385e167f2fafd3244c098dabee7f1a7b0444b /src | |
parent | 8e86bc19f4be7d2d01181ab45a8cadd4320887ec (diff) |
BlackBerry: Add some platform documentation
Change-Id: If2a8d289578f3bc7622cedd9faf35893880a2157
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/bluetooth/qbluetoothserver.cpp | 7 | ||||
-rw-r--r-- | src/bluetooth/qbluetoothservicediscoveryagent.cpp | 2 | ||||
-rw-r--r-- | src/bluetooth/qbluetoothsocket.cpp | 20 |
3 files changed, 19 insertions, 10 deletions
diff --git a/src/bluetooth/qbluetoothserver.cpp b/src/bluetooth/qbluetoothserver.cpp index ee94e110..5a5144d1 100644 --- a/src/bluetooth/qbluetoothserver.cpp +++ b/src/bluetooth/qbluetoothserver.cpp @@ -62,6 +62,8 @@ QT_BEGIN_NAMESPACE applicable attributes for your service and register it using QBluetoothServiceInfo::registerService(). Call serverPort() to get the channel number that is being used. + If the \l QBluetoothServer::ServerType is not supported by a platform, \l listen() will return \c false. + \sa QBluetoothServiceInfo, QBluetoothSocket */ @@ -70,7 +72,7 @@ QT_BEGIN_NAMESPACE This enum describes the Bluetooth server type. - \value L2capServer L2CAP server. + \value L2capServer L2CAP server (Not supported on BlackBerry). \value RfcommServer RFCOMM server. */ @@ -131,7 +133,7 @@ QT_BEGIN_NAMESPACE /*! \fn quint16 QBluetoothServer::serverPort() const - Returns the server port number. + Returns the server port number. On BlackBerry, this port might not correspond to the real RFCOMM port. */ /*! @@ -241,6 +243,7 @@ int QBluetoothServer::maxPendingConnections() const /*! \fn QBluetoothServer::setSecurityFlags(QBluetooth::SecurityFlags security) Sets the Bluetooth security flags to \a security. This function must be called before calling listen(). + On BlackBerry, security flags are not supported and will be ignored. */ /*! diff --git a/src/bluetooth/qbluetoothservicediscoveryagent.cpp b/src/bluetooth/qbluetoothservicediscoveryagent.cpp index fa7cc376..35c2f795 100644 --- a/src/bluetooth/qbluetoothservicediscoveryagent.cpp +++ b/src/bluetooth/qbluetoothservicediscoveryagent.cpp @@ -224,7 +224,7 @@ QBluetoothAddress QBluetoothServiceDiscoveryAgent::remoteAddress() const /*! Starts service discovery. \a mode specifies the type of service discovery to perform. - On Blackberry devices device discovery may lead to pairing requests. + On BlackBerry devices, device discovery may lead to pairing requests. \sa DiscoveryMode */ diff --git a/src/bluetooth/qbluetoothsocket.cpp b/src/bluetooth/qbluetoothsocket.cpp index 24ecbc2a..9b1848a0 100644 --- a/src/bluetooth/qbluetoothsocket.cpp +++ b/src/bluetooth/qbluetoothsocket.cpp @@ -61,7 +61,8 @@ QT_BEGIN_NAMESPACE QBluetoothSocket supports two socket types, \l {QBluetoothSocket::L2capSocket}{L2CAP} and \l {QBluetoothSocket::RfcommSocket}{RFCOMM}. - \l {QBluetoothSocket::L2capSocket}{L2CAP} is a low level datagram-oriented Bluetooth socket. + \l {QBluetoothSocket::L2capSocket}{L2CAP} is a low level datagram-oriented Bluetooth socket + (Not supported on BlackBerry). \l {QBluetoothSocket::RfcommSocket}{RFCOMM} is a reliable, stream-oriented socket. RFCOMM sockets emulate an RS-232 serial port. @@ -70,6 +71,8 @@ QT_BEGIN_NAMESPACE connectToService() passing the Bluetooth address and port number. QBluetoothSocket will emit the connected() signal when the connection is established. + If the \l {QBluetoothSocket::SocketType}{SocketType} is not supported on a platform, calling + \l connectToService() will emit a \l {QBluetoothSocket::UnsupportedSocketTypeError}{UnsupportedSocketTypeError} error. */ @@ -79,7 +82,7 @@ QT_BEGIN_NAMESPACE This enum describes the Bluetooth socket type. \value UnknownSocketType Unknown socket type. - \value L2capSocket L2CAP socket. + \value L2capSocket L2CAP socket. (Not supported on BlackBerry). \value RfcommSocket RFCOMM socket. */ @@ -106,9 +109,9 @@ QT_BEGIN_NAMESPACE \value UnknownSocketError An unknown error has occurred. \value NoSocketError No error. Used for testing. \value ConnectionRefusedError Connection refused or device not available. - \value RemoteHostClosedError The remote host closed the socket - \value HostNotFoundError Could not find the remote host - \value ServiceNotFoundError Could not find the service UUID on remote host + \value RemoteHostClosedError The remote host closed the socket. + \value HostNotFoundError Could not find the remote host. + \value ServiceNotFoundError Could not find the service UUID on remote host. \value NetworkError Attempt to read or write from socket returned an error */ @@ -185,6 +188,7 @@ QT_BEGIN_NAMESPACE \fn quint16 QBluetoothSocket::localPort() const Returns the port number of the local socket if available, otherwise returns 0. + On BlackBerry, this feature is not supported and returns 0. */ /*! @@ -203,6 +207,7 @@ QT_BEGIN_NAMESPACE \fn quint16 QBluetoothSocket::peerPort() const Return the port number of the peer socket if available, otherwise returns 0. + On BlackBerry, this feature is not supported. */ /*! @@ -337,7 +342,7 @@ void QBluetoothSocket::connectToService(const QBluetoothServiceInfo &service, Op ConnectingState, and attempts to connect to \a address. If a connection is established, QBluetoothSocket enters Connected State and emits connected(). - On QNX the service connection can be established directly using the UUID of the remote service. + On BlackBerry, the service connection can be established directly using the UUID of the remote service. At any point, the socket can emit error() to signal that an error occurred. @@ -367,7 +372,8 @@ void QBluetoothSocket::connectToService(const QBluetoothAddress &address, const At any point, the socket can emit error() to signal that an error occurred. - On QNX a connection to a service can not be established using a port. + On BlackBerry, a connection to a service can not be established using a port. Calling this function + will emit a \l {QBluetoothSocket::ServiceNotFoundError}{ServiceNotFoundError} \sa state(), disconnectFromService() */ |