FCL/sf/mw/qtextensions: comparison qthighway/xqserviceipc/xqserviceipcserver/xqserviceipcrequest.cpp

equal deleted inserted replaced

-:46686fb6258c
+:9d760f716ca8
 #include "xqrequestutil.h"
 namespace QtService
 {
 /*!
 \class ServiceIPCRequest
-Class to encapsulate a service request
+\brief Class to encapsulate a service request
 */
 /*!
-Constructor
+Constructor.
-@param aSession session associated with this request
+\param aSession Session associated with this request.
-@param aDataLength amount of data to be received in this request
+\param aDataLength Amount of data to be received in this request.
-@param aRequestOp operaion name
+\param aRequestOp Operation name.
 */
 ServiceIPCRequest::ServiceIPCRequest(ServiceIPCSession* aSession,
 qint64 aDataLength,
 const QString& aRequestOp) :
 QObject(NULL),
 iSession(aSession),
 XQSERVICE_DEBUG_PRINT("aDataLength: %d", aDataLength);
 XQSERVICE_DEBUG_PRINT("aRequestOp: %s", qPrintable(aRequestOp));
 }
 /*!
-Copy Constructor
+Copy Constructor.
-@param aRequest request to be copied
+\param aRequest Request to be copied.
 */
 ServiceIPCRequest::ServiceIPCRequest(ServiceIPCRequest& aRequest)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::ServiceIPCRequest(2)");
 //session
 iSession = aRequest.getSession();
 iRequestInfo = aRequest.requestInfo();
 }
 /*!
-Destructor
+Destructor.
 */
 ServiceIPCRequest::~ServiceIPCRequest()
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::~ServiceIPCRequest");
 delete iClientInfo;
 }
 /*!
-Assignment operator
+Assignment operator.
-@param aRequest request to be assigned
+\param aRequest Request to be assigned.
-@return ServiceIPCRequest assigned request
+\return ServiceIPCRequest assigned request.
 */
 ServiceIPCRequest& ServiceIPCRequest::operator=(ServiceIPCRequest& aRequest)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::operator=");
 if (this != &aRequest) {
 //session
 }
 return *this;
 }
 /*!
-Get the requested operation
+Get the requested operation.
-@return QString operation ID
+\return QString operation ID.
 */
 const QString& ServiceIPCRequest::getOperation()
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::getOperation");
 XQSERVICE_DEBUG_PRINT("iRequestOp: %s", qPrintable(iRequestOp));
 return iRequestOp;
 }
 /*!
-Get the requested data
+Get the requested data.
-@return QByteArray data for this operation
+\return QByteArray data for this operation.
 */
 const QByteArray& ServiceIPCRequest::getData()
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::getData");
 XQSERVICE_DEBUG_PRINT("iRequestData: %s", iRequestData.constData());
 return iRequestData;
 }
 /*!
-Write some data to the request
+Write some data to the request.
-@param aData data to write to the socket
+\param aData Data to write to the socket.
 */
 bool ServiceIPCRequest::write(const QByteArray& aData)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::write");
 XQSERVICE_DEBUG_PRINT("aData: %s", aData.constData());
 // Do we want to buffer the writes?
 return iSession->write(aData);
 }
 /*!
-Complete the request
+Complete the request.
-@return true if request completed successfully
+\return true if request completed successfully.
 */
 bool ServiceIPCRequest::completeRequest()
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::completeRequest");
 return iSession->completeRequest();
 }
 /*!
-Append more data when creating the request
+Append more data when creating the request.
-@arg aMoreData data to be appended to the request
+\param aMoreData Data to be appended to the request.
-@return true if iDataLength now equals the full length
+\return true if iDataLength now equals the full length.
 */
 bool ServiceIPCRequest::addRequestdata(const QByteArray& aMoreData)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::addRequestdata");
 XQSERVICE_DEBUG_PRINT("aMoreData: %s", aMoreData.constData());
 iRequestData.append(aMoreData);
 return (iRequestData.length() == iDatalength);
 }
 /*!
-Sets the client info.  Onwership of the object is passed in.
+Sets the client info. Onwership of the object is passed in.
-@arg aClientInfo Client information
+\param aClientInfo Client information.
 */
 void ServiceIPCRequest::setClientInfo(ClientInfo *aClientInfo)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::setClientInfo");
 delete iClientInfo;
 iClientInfo = aClientInfo;
 iRequestInfo.setInfo(XQServiceUtils::InfoCap, iClientInfo->capabilities());
 }
 /*!
 Gets the client info.
-@return Client Information object.  NULL if none is available
+\return Client Information object, NULL if none is available.
 */
 ClientInfo* ServiceIPCRequest::clientInfo()
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::clientInfo");
 return iClientInfo;
 }
 /*!
 Gets the session.
-@return ServiceIPCSession.  NULL if none is available
+\return ServiceIPCSession, NULL if none is available.
 */
 ServiceIPCSession* ServiceIPCRequest::getSession()
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::getSession");
 return iSession;
 }
 /*!
 Sets id of the request.
-@arg id Identifier of the request.
+\param aId Identifier of the request.
 */
 void ServiceIPCRequest::setId(int aId)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::setId");
 XQSERVICE_DEBUG_PRINT("\t aId = %d", aId);
 iId = aId;
 }
 /*!
 Returns id of the request.
-@return Id of the request.
+\return Id of the request.
 */
 int ServiceIPCRequest::id() const
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::id");
 XQSERVICE_DEBUG_PRINT("\t iId = %d", iId);
 return iId;
 }
 /*!
 Sets asynchcronous flag to true or false.
-@arg A value of the async flag.
+\param aAsync Value of the async flag.
 */
 void ServiceIPCRequest::setAsync(bool aAsync)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::setAsync");
 XQSERVICE_DEBUG_PRINT("\t iAsync = %d", aAsync);
 iAsync = aAsync;
 }
 /*!
-Returns asynch flag.
+Returns async flag.
-@return True if the request is asynchronous. False, if synchronous
+\return True if the request is asynchronous. False, if synchronous.
 */
 bool ServiceIPCRequest::isAsync() const
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::getAsync");
 XQSERVICE_DEBUG_PRINT("\t iAsync = %d", iAsync);
 return iAsync;
 }
+/*!
-// Set request info passed alomg with the request
+Set request info passed along with the request.
+\param info Info to be passed with the request.
+*/
 void ServiceIPCRequest::setRequestInfo(XQRequestInfo *info)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::setRequestInfo");
 if (info)
 {
 iRequestInfo.setInfo(XQServiceUtils::InfoId, id());
 }
 }
 }
+/*!
+Get info added to the request.
+\return Info to be passed with the request.
+*/
 XQRequestInfo ServiceIPCRequest::requestInfo() const
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::requestInfo");
 return iRequestInfo;
 }
+/*!
+Add sharable file to be passed with the request.
+\param file Sharable file to be added to the request.
+\param index Currently not used.
+*/
 void ServiceIPCRequest::addSharableFile(XQSharableFile *file, int index)
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::setSharableFile");
 if (file != NULL)
 iSharableFiles.append(*file);
 }
+/*!
+Get sharable file from request.
+\param index Index of the sharable file to get.
+*/
 XQSharableFile ServiceIPCRequest::sharableFile(int index) const
 {
 XQSERVICE_DEBUG_PRINT("ServiceIPCRequest::setSharableFile");
 if (index >= 0 && index < iSharableFiles.size())
 {

changeset 24	9d760f716ca8
parent 4	90517678cc4f