utilities/serviceipcserver/platform/qt/serviceipcserverlocalsocket.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 "serviceipclocalsocketsession.h"
hgs
parents:
diff changeset
    19
#include "serviceipcserverlocalsocket_p.h"
hgs
parents:
diff changeset
    20
#include "serviceipcserver.h"
hgs
parents:
diff changeset
    21
#include <QLocalSocket>
hgs
parents:
diff changeset
    22
#include <QLocalServer>
hgs
parents:
diff changeset
    23
#include <serviceipcdefs.h>
hgs
parents:
diff changeset
    24
#include <clientinfo.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
namespace WRT
hgs
parents:
diff changeset
    27
{
hgs
parents:
diff changeset
    28
/*!
hgs
parents:
diff changeset
    29
 \class ServiceFwIPCServerLocalSocket
hgs
parents:
diff changeset
    30
 Service Framework IPC Server using QLocalSocket
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 aParent parent to this object
hgs
parents:
diff changeset
    36
 */
hgs
parents:
diff changeset
    37
ServiceFwIPCServerLocalSocket::ServiceFwIPCServerLocalSocket(QObject* aParent) 
hgs
parents:
diff changeset
    38
    : QObject(aParent)
hgs
parents:
diff changeset
    39
    , m_Listener(NULL)
hgs
parents:
diff changeset
    40
{
hgs
parents:
diff changeset
    41
    m_Listener = new QLocalServer(this);
hgs
parents:
diff changeset
    42
    QObject::connect(m_Listener, SIGNAL(newConnection()),
hgs
parents:
diff changeset
    43
    this, SLOT(handleNewConnection()) );
hgs
parents:
diff changeset
    44
    m_isValidSession = true;
hgs
parents:
diff changeset
    45
    m_isKeepServer = false;
hgs
parents:
diff changeset
    46
    m_sessionIdTable = new SessionIdTable();
hgs
parents:
diff changeset
    47
}
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
/*!
hgs
parents:
diff changeset
    50
 Destructor
hgs
parents:
diff changeset
    51
 */
hgs
parents:
diff changeset
    52
ServiceFwIPCServerLocalSocket::~ServiceFwIPCServerLocalSocket()
hgs
parents:
diff changeset
    53
{
hgs
parents:
diff changeset
    54
    m_Listener->close();
hgs
parents:
diff changeset
    55
    if(m_isValidSession){
hgs
parents:
diff changeset
    56
        char* data = (char*) m_SharedMem.data();
hgs
parents:
diff changeset
    57
        if (data) {
hgs
parents:
diff changeset
    58
            strcpy(data, SERVERNOTSTARTED);
hgs
parents:
diff changeset
    59
        }
hgs
parents:
diff changeset
    60
    }
hgs
parents:
diff changeset
    61
    m_SharedMem.detach();
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
    delete m_sessionIdTable;
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 this server
hgs
parents:
diff changeset
    69
 @return true if listen was successful
hgs
parents:
diff changeset
    70
 */
hgs
parents:
diff changeset
    71
bool ServiceFwIPCServerLocalSocket::listen(const QString& aServerName)
hgs
parents:
diff changeset
    72
{
hgs
parents:
diff changeset
    73
    m_isValidSession = false; 
hgs
parents:
diff changeset
    74
    bool firstLaunch(false);
hgs
parents:
diff changeset
    75
    // Create the global chunk that this process owns
hgs
parents:
diff changeset
    76
    m_SharedMem.setKey(aServerName);
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
    if (!m_SharedMem.attach()) {
hgs
parents:
diff changeset
    79
        // Single byte of data + \0
hgs
parents:
diff changeset
    80
        m_SharedMem.create(2);
hgs
parents:
diff changeset
    81
        firstLaunch = true;
hgs
parents:
diff changeset
    82
    }
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
    // Initial data is 0, ie server not started
hgs
parents:
diff changeset
    85
    // Check if data is NULL, this handles the case where shared mem cannot attach or create
hgs
parents:
diff changeset
    86
    //
hgs
parents:
diff changeset
    87
    char* data = (char*) m_SharedMem.data();
hgs
parents:
diff changeset
    88
    if ((data && (strcmp(data, SERVERNOTSTARTED)==0)) || firstLaunch) {
hgs
parents:
diff changeset
    89
        strcpy(data, SERVERNOTSTARTED);
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
        //Try to listen
hgs
parents:
diff changeset
    92
        for (int i=2; i>0; i--) {
hgs
parents:
diff changeset
    93
            m_isValidSession = m_Listener->listen(aServerName);
hgs
parents:
diff changeset
    94
            if (m_isValidSession) {
hgs
parents:
diff changeset
    95
                // Server started flag
hgs
parents:
diff changeset
    96
                strcpy(data, SERVERSTARTED);
hgs
parents:
diff changeset
    97
                break;
hgs
parents:
diff changeset
    98
            } else {
hgs
parents:
diff changeset
    99
                QLocalServer::removeServer(aServerName);        
hgs
parents:
diff changeset
   100
            }
hgs
parents:
diff changeset
   101
        }
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
        // Signal the client to continue and that server is started
hgs
parents:
diff changeset
   104
        QSystemSemaphore sem(aServerName + SERVERSEM, 0);
hgs
parents:
diff changeset
   105
        sem.release(1);
hgs
parents:
diff changeset
   106
    }
hgs
parents:
diff changeset
   107
    return m_isValidSession;
hgs
parents:
diff changeset
   108
}
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
/*!
hgs
parents:
diff changeset
   111
 Shutdown the server and stop serving clients 
hgs
parents:
diff changeset
   112
 @return void
hgs
parents:
diff changeset
   113
 */
hgs
parents:
diff changeset
   114
void ServiceFwIPCServerLocalSocket::disconnect()
hgs
parents:
diff changeset
   115
{
hgs
parents:
diff changeset
   116
    m_Listener->close();
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
    // Clean up all sessions
hgs
parents:
diff changeset
   119
    int count = m_Sessions.count();
hgs
parents:
diff changeset
   120
    for (int i = 0; i < count; ++i) {
hgs
parents:
diff changeset
   121
        QObject::disconnect(m_Sessions[i], SIGNAL(disconnected( ServiceIPCSession* ) ),
hgs
parents:
diff changeset
   122
        this, SLOT( handleSessionDisconnect( ServiceIPCSession* ) ) );
hgs
parents:
diff changeset
   123
        m_Sessions[i]->close();
hgs
parents:
diff changeset
   124
        delete m_Sessions[i];
hgs
parents:
diff changeset
   125
    }
hgs
parents:
diff changeset
   126
    m_Sessions.clear();
hgs
parents:
diff changeset
   127
}
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
/*!
hgs
parents:
diff changeset
   130
 Handle a new connection, this slot is connected to the socket's newConnection() signal
hgs
parents:
diff changeset
   131
 @return void
hgs
parents:
diff changeset
   132
 */
hgs
parents:
diff changeset
   133
void ServiceFwIPCServerLocalSocket::handleNewConnection()
hgs
parents:
diff changeset
   134
{
hgs
parents:
diff changeset
   135
    // Create a new session to host the client
hgs
parents:
diff changeset
   136
    //
hgs
parents:
diff changeset
   137
    QLocalSocket* newSocket = m_Listener->nextPendingConnection();
hgs
parents:
diff changeset
   138
    ServiceIPCSession* session = new LocalSocketSession(newSocket, Observer());
hgs
parents:
diff changeset
   139
    if (session) {
hgs
parents:
diff changeset
   140
        session->setParent(this);
hgs
parents:
diff changeset
   141
hgs
parents:
diff changeset
   142
        QObject::connect(session, SIGNAL(disconnected( ServiceIPCSession* ) ),
hgs
parents:
diff changeset
   143
        this, SLOT( handleSessionDisconnect( ServiceIPCSession* ) ) );
hgs
parents:
diff changeset
   144
        m_Sessions.append(session);
hgs
parents:
diff changeset
   145
        stopExitTimer(); 
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
        ClientInfo *client = new ClientInfo();
hgs
parents:
diff changeset
   148
        client->setSessionId(m_sessionIdTable->allocate());
hgs
parents:
diff changeset
   149
        session->setClientInfo(client);
hgs
parents:
diff changeset
   150
    }
hgs
parents:
diff changeset
   151
}
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
/*!
hgs
parents:
diff changeset
   154
 Handle the end of a session
hgs
parents:
diff changeset
   155
 @param aSession session to be disconnected
hgs
parents:
diff changeset
   156
 */
hgs
parents:
diff changeset
   157
void ServiceFwIPCServerLocalSocket::handleSessionDisconnect(ServiceIPCSession* aSession)
hgs
parents:
diff changeset
   158
{
hgs
parents:
diff changeset
   159
    int c = m_Sessions.removeAll(aSession);
hgs
parents:
diff changeset
   160
hgs
parents:
diff changeset
   161
    if ((m_Sessions.count() == 0) && (!m_isKeepServer)) {
hgs
parents:
diff changeset
   162
        startExitTimer(); 
hgs
parents:
diff changeset
   163
    }  
hgs
parents:
diff changeset
   164
hgs
parents:
diff changeset
   165
    qDebug() << "Session cleaned up: " << c;
hgs
parents:
diff changeset
   166
}
hgs
parents:
diff changeset
   167
 
hgs
parents:
diff changeset
   168
/*!
hgs
parents:
diff changeset
   169
 Config IPC server Life time \n
hgs
parents:
diff changeset
   170
 Start the shutdown timer if it is the last session and aKeepServer is trues.
hgs
parents:
diff changeset
   171
 @param aKeepLife to keep or disconnect IPC server when all clients are shutdown. 
hgs
parents:
diff changeset
   172
*/
hgs
parents:
diff changeset
   173
void ServiceFwIPCServerLocalSocket::configIpcServerLifetime(bool aKeepServer)
hgs
parents:
diff changeset
   174
{
hgs
parents:
diff changeset
   175
    if ((m_isKeepServer) && (m_Sessions.count() == 0) && (!aKeepServer)) {
hgs
parents:
diff changeset
   176
        startExitTimer(); 
hgs
parents:
diff changeset
   177
    }  
hgs
parents:
diff changeset
   178
    m_isKeepServer = aKeepServer;
hgs
parents:
diff changeset
   179
}
hgs
parents:
diff changeset
   180
}
hgs
parents:
diff changeset
   181
// END OF FILE