qthighway/inc/xqserviceclientinfo.h
changeset 24 9d760f716ca8
parent 1 2b40d63a9c3d
equal deleted inserted replaced
19:46686fb6258c 24:9d760f716ca8
    26 #include <QString>
    26 #include <QString>
    27 #include <QBitArray>
    27 #include <QBitArray>
    28 
    28 
    29 namespace QtService {
    29 namespace QtService {
    30 
    30 
       
    31 /*!
       
    32     \class ClientInfo
       
    33     \brief Container class for client information in ipc requests.
       
    34 */
    31     // FORWARD DECLARATIONS
    35     // FORWARD DECLARATIONS
    32     class ClientInfo: public QObject
    36     class ClientInfo: public QObject
    33     {
    37     {
    34 
    38 
    35     public:    
    39     public:    
    36         /*!
    40         /*!
    37          * Sets the client's name
    41             Sets the client's name.
    38          * @param aName - Client's name
    42             \param aName Client's name.
    39          */
    43         */
    40         inline void setName(const QString &aName) { iName = aName; }
    44         inline void setName(const QString &aName) { iName = aName; }
    41 
    45 
    42         /*!
    46         /*!
    43          * Gets the client's name
    47             Gets the client's name.
    44          */
    48             \return Client's name as QString.
       
    49         */
    45         inline QString name() { return iName; }
    50         inline QString name() { return iName; }
    46 
    51 
    47         /*!
    52         /*!
    48          * Sets the client's process Id
    53             Sets the client's process ID.
    49          */
    54             \param aProcessId Id of the process.
       
    55         */
    50         inline void setProcessId(const qint64 aProcessId) { iProcessId = aProcessId; }
    56         inline void setProcessId(const qint64 aProcessId) { iProcessId = aProcessId; }
    51 
    57 
    52         /*!
    58         /*!
    53          * Gets the client's process ID
    59             Gets the client's process ID.
    54          */
    60             \return Process ID.
       
    61         */
    55         inline qint64 processId() { return iProcessId; }
    62         inline qint64 processId() { return iProcessId; }
    56 
    63 
    57         /*!
    64         /*!
    58          * Sets the client's vendor ID 
    65             Sets the client's vendor ID.
    59          */
    66             \param aVendorId Vendor ID.
       
    67         */
    60         inline void setVendorId(const qint64 aVendorId) { iVendorId = aVendorId; }
    68         inline void setVendorId(const qint64 aVendorId) { iVendorId = aVendorId; }
    61 
    69 
    62         /*!
    70         /*!
    63          * Get's the client's vendor ID
    71             Gets the client's vendor ID.
    64          */
    72             \return Vendor ID.
       
    73         */
    65         inline const qint64 vendorId() { return iVendorId; }
    74         inline const qint64 vendorId() { return iVendorId; }
    66 
    75 
    67         /*!
    76         /*!
    68          * Sets the client's capabilities
    77             Sets the client's capabilities.
    69          */
    78             \param capabilities Capabilities to be set.
       
    79         */
    70         inline void setCapabilities(const quint32 capabilities) { iCapabilities = capabilities; }
    80         inline void setCapabilities(const quint32 capabilities) { iCapabilities = capabilities; }
    71 
    81 
    72         /*!
    82         /*!
    73          * Get's the client's capabilities
    83             Gets the client's capabilities.
    74          */
    84             \return Client capabilities.
       
    85         */
    75         inline const quint32 capabilities() { return iCapabilities; }
    86         inline const quint32 capabilities() { return iCapabilities; }
    76 
    87 
    77         
    88         
    78     private:
    89     private:
    79         QString iName;
    90         QString iName;