utilities/serviceipcserver/serviceipcserver.cpp
author hgs
Fri, 15 Oct 2010 17:30:59 -0400
changeset 16 3c88a81ff781
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16
hgs
parents:
diff changeset
     1
/**
hgs
parents:
diff changeset
     2
   This file is part of CWRT package **
hgs
parents:
diff changeset
     3
hgs
parents:
diff changeset
     4
   Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). **
hgs
parents:
diff changeset
     5
hgs
parents:
diff changeset
     6
   This program is free software: you can redistribute it and/or modify
hgs
parents:
diff changeset
     7
   it under the terms of the GNU (Lesser) General Public License as
hgs
parents:
diff changeset
     8
   published by the Free Software Foundation, version 2.1 of the License.
hgs
parents:
diff changeset
     9
   This program is distributed in the hope that it will be useful, but
hgs
parents:
diff changeset
    10
   WITHOUT ANY WARRANTY; without even the implied warranty of
hgs
parents:
diff changeset
    11
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
hgs
parents:
diff changeset
    12
   (Lesser) General Public License for more details. You should have
hgs
parents:
diff changeset
    13
   received a copy of the GNU (Lesser) General Public License along
hgs
parents:
diff changeset
    14
   with this program. If not, see <http://www.gnu.org/licenses/>.
hgs
parents:
diff changeset
    15
*/
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#include "serviceipcserver.h"
hgs
parents:
diff changeset
    19
#include "serviceipcserver_p.h"
hgs
parents:
diff changeset
    20
#include "serviceipcserverfactory.h"
hgs
parents:
diff changeset
    21
#include "serviceipcobserver.h"
hgs
parents:
diff changeset
    22
#include "serviceipcserversession.h"
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
namespace WRT
hgs
parents:
diff changeset
    25
{
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
const int KServerShutdownDelay=10000;
hgs
parents:
diff changeset
    28
/*!
hgs
parents:
diff changeset
    29
 \class ServiceFwIPCServer
hgs
parents:
diff changeset
    30
 Service Framework IPC Server public class
hgs
parents:
diff changeset
    31
 */
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/*!
hgs
parents:
diff changeset
    34
    Constructor
hgs
parents:
diff changeset
    35
    @param aBackend backend to instantiate
hgs
parents:
diff changeset
    36
    @param aObserver engine observer to call back to handle new requests
hgs
parents:
diff changeset
    37
    @param aParent QObject's parent
hgs
parents:
diff changeset
    38
*/
hgs
parents:
diff changeset
    39
ServiceFwIPCServer::ServiceFwIPCServer( MServiceIPCObserver* aObserver, 
hgs
parents:
diff changeset
    40
                                        QObject* aParent, 
hgs
parents:
diff changeset
    41
                                        TServiceIPCBackends aBackend ) 
hgs
parents:
diff changeset
    42
    : QObject(aParent )
hgs
parents:
diff changeset
    43
    , m_Observer( aObserver )
hgs
parents:
diff changeset
    44
{
hgs
parents:
diff changeset
    45
    d = ServiceFwIPCServerFactory::createBackend( aParent,aBackend );
hgs
parents:
diff changeset
    46
    d->q = this;
hgs
parents:
diff changeset
    47
    m_Timer = new QTimer();
hgs
parents:
diff changeset
    48
    connect(m_Timer, SIGNAL(timeout()), this, SIGNAL(handleExit()));
hgs
parents:
diff changeset
    49
}
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
/*!
hgs
parents:
diff changeset
    52
 Destructor
hgs
parents:
diff changeset
    53
 */
hgs
parents:
diff changeset
    54
ServiceFwIPCServer::~ServiceFwIPCServer()
hgs
parents:
diff changeset
    55
{
hgs
parents:
diff changeset
    56
    delete d;
hgs
parents:
diff changeset
    57
    if(m_Timer){
hgs
parents:
diff changeset
    58
        if (m_Timer->isActive()) {
hgs
parents:
diff changeset
    59
            m_Timer->stop();          
hgs
parents:
diff changeset
    60
        }
hgs
parents:
diff changeset
    61
        delete m_Timer;
hgs
parents:
diff changeset
    62
        m_Timer = NULL;
hgs
parents:
diff changeset
    63
    }
hgs
parents:
diff changeset
    64
}
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
/*!
hgs
parents:
diff changeset
    67
 Start listening for new service requests
hgs
parents:
diff changeset
    68
 @param aServerName name of the server
hgs
parents:
diff changeset
    69
 @return bool if connected
hgs
parents:
diff changeset
    70
 */
hgs
parents:
diff changeset
    71
bool ServiceFwIPCServer::listen(const QString& aServerName)
hgs
parents:
diff changeset
    72
{
hgs
parents:
diff changeset
    73
    return d->listen(aServerName);
hgs
parents:
diff changeset
    74
}
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
/*!
hgs
parents:
diff changeset
    77
 Shutdown the server and stop serving clients 
hgs
parents:
diff changeset
    78
 @return void
hgs
parents:
diff changeset
    79
 */
hgs
parents:
diff changeset
    80
void ServiceFwIPCServer::disconnect()
hgs
parents:
diff changeset
    81
{
hgs
parents:
diff changeset
    82
    d->disconnect();
hgs
parents:
diff changeset
    83
}
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
/*!
hgs
parents:
diff changeset
    86
 Start the server shutdown timer
hgs
parents:
diff changeset
    87
 @return void
hgs
parents:
diff changeset
    88
 */
hgs
parents:
diff changeset
    89
void ServiceFwIPCServer::startTimer()
hgs
parents:
diff changeset
    90
{
hgs
parents:
diff changeset
    91
   if (m_Timer){        
hgs
parents:
diff changeset
    92
       m_Timer->start(KServerShutdownDelay);
hgs
parents:
diff changeset
    93
   }
hgs
parents:
diff changeset
    94
}
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
hgs
parents:
diff changeset
    97
/*!
hgs
parents:
diff changeset
    98
 Stop the server shutdown timer
hgs
parents:
diff changeset
    99
 @return void
hgs
parents:
diff changeset
   100
 */
hgs
parents:
diff changeset
   101
void ServiceFwIPCServer::stopTimer()
hgs
parents:
diff changeset
   102
{
hgs
parents:
diff changeset
   103
    if (m_Timer){
hgs
parents:
diff changeset
   104
        if (m_Timer->isActive()){
hgs
parents:
diff changeset
   105
            m_Timer->stop();
hgs
parents:
diff changeset
   106
        }
hgs
parents:
diff changeset
   107
    }
hgs
parents:
diff changeset
   108
}
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
/*!
hgs
parents:
diff changeset
   111
 IPC server lifetime should be configurable 
hgs
parents:
diff changeset
   112
 @param aKeepLife to keep or disconnect IPC server when all clients are shutdown. 
hgs
parents:
diff changeset
   113
 @return void
hgs
parents:
diff changeset
   114
 */
hgs
parents:
diff changeset
   115
void ServiceFwIPCServer::configIpcServerLifetime(bool aKeepServer)
hgs
parents:
diff changeset
   116
{
hgs
parents:
diff changeset
   117
    d->configIpcServerLifetime(aKeepServer);
hgs
parents:
diff changeset
   118
}
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
/*!
hgs
parents:
diff changeset
   121
 * Send a message to all broadcast clients connected to this server
hgs
parents:
diff changeset
   122
 * @param aMessage the contents of the message
hgs
parents:
diff changeset
   123
 */ 
hgs
parents:
diff changeset
   124
void ServiceFwIPCServer::broadcast( const QByteArray& aMessage )
hgs
parents:
diff changeset
   125
{
hgs
parents:
diff changeset
   126
    QHash<int, ServiceIPCSession*> sessions = d->getBroadcastSessions(); 
hgs
parents:
diff changeset
   127
    for (int i = 0; i < sessions.count(); ++i) {
hgs
parents:
diff changeset
   128
        ServiceIPCSession* session = sessions[i];
hgs
parents:
diff changeset
   129
        if ((session->getReadyToSend()) && (session->messageListIsEmpty())) {
hgs
parents:
diff changeset
   130
            session->write(aMessage);
hgs
parents:
diff changeset
   131
            session->completeRequest();
hgs
parents:
diff changeset
   132
            session->setReadyToSend(false);
hgs
parents:
diff changeset
   133
        }
hgs
parents:
diff changeset
   134
        else {
hgs
parents:
diff changeset
   135
            //queue the aMessage to be sent
hgs
parents:
diff changeset
   136
            session->appendMessageList(aMessage);
hgs
parents:
diff changeset
   137
        }
hgs
parents:
diff changeset
   138
    }
hgs
parents:
diff changeset
   139
}
hgs
parents:
diff changeset
   140
 
hgs
parents:
diff changeset
   141
/*!
hgs
parents:
diff changeset
   142
 * Send a message to a particular client connected to this server
hgs
parents:
diff changeset
   143
 * @param aSessionId, id of a session to broadcast to
hgs
parents:
diff changeset
   144
 * @param aMessage the contents of the message
hgs
parents:
diff changeset
   145
 */ 
hgs
parents:
diff changeset
   146
void ServiceFwIPCServer::sendMessage( qint32 aSessionId, QByteArray& aMessage )
hgs
parents:
diff changeset
   147
{
hgs
parents:
diff changeset
   148
    QHash<int, ServiceIPCSession*> sessions = d->getBroadcastSessions(); 
hgs
parents:
diff changeset
   149
    ServiceIPCSession* session = sessions.value(aSessionId);
hgs
parents:
diff changeset
   150
    if (session != NULL) {
hgs
parents:
diff changeset
   151
        if ((session->getReadyToSend()) && (session->messageListIsEmpty())) { 
hgs
parents:
diff changeset
   152
            session->write(aMessage);
hgs
parents:
diff changeset
   153
            session->completeRequest();
hgs
parents:
diff changeset
   154
            session->setReadyToSend(false);
hgs
parents:
diff changeset
   155
        }
hgs
parents:
diff changeset
   156
        else {
hgs
parents:
diff changeset
   157
            //queue the aMessage to be sent
hgs
parents:
diff changeset
   158
            session->appendMessageList(aMessage);
hgs
parents:
diff changeset
   159
        }
hgs
parents:
diff changeset
   160
    }
hgs
parents:
diff changeset
   161
}
hgs
parents:
diff changeset
   162
                                
hgs
parents:
diff changeset
   163
}
hgs
parents:
diff changeset
   164
hgs
parents:
diff changeset
   165
/*!
hgs
parents:
diff changeset
   166
 \fn WRT::ServiceFwIPCServer::handleExit()
hgs
parents:
diff changeset
   167
hgs
parents:
diff changeset
   168
 Handle server shutdown\n
hgs
parents:
diff changeset
   169
 Emitted when all client sessions were closed and server should shutdown
hgs
parents:
diff changeset
   170
 @return void
hgs
parents:
diff changeset
   171
 */
hgs
parents:
diff changeset
   172
// END OF FILE