cbs/cbsserver/ServerInc/CCbsRecEtelMonitor.h
author hgs
Tue, 10 Aug 2010 13:19:41 +0300
changeset 38 bc103bfb69cf
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201031_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  This file contains the header file of the CCbsRecEtelMonitor class
hgs
parents:
diff changeset
    15
*    
hgs
parents:
diff changeset
    16
*                This class receives CBS message pages from the EPOC Telephony server and
hgs
parents:
diff changeset
    17
*                sends them to a CCbsRecEtel instance.
hgs
parents:
diff changeset
    18
*
hgs
parents:
diff changeset
    19
*/
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#ifndef     CCBSRECETELMONITOR_H
hgs
parents:
diff changeset
    24
#define     CCBSRECETELMONITOR_H
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
//  INCLUDES
hgs
parents:
diff changeset
    27
        /*****************************************************
hgs
parents:
diff changeset
    28
		*	Series 60 Customer / ETel
hgs
parents:
diff changeset
    29
		*	Series 60  ETel API
hgs
parents:
diff changeset
    30
		*****************************************************/
hgs
parents:
diff changeset
    31
#include <etelmm.h>
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
//  FORWARD DECLARATIONS
hgs
parents:
diff changeset
    34
class TGsmBroadcastMessageData;
hgs
parents:
diff changeset
    35
class CCbsRecEtel;
hgs
parents:
diff changeset
    36
class MCbsEtelMessaging;
hgs
parents:
diff changeset
    37
class CCbsMessageFactory;
hgs
parents:
diff changeset
    38
class CCbsLivecastHandler;
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
//  CLASS DECLARATION 
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
/**
hgs
parents:
diff changeset
    43
*   CCbsRecEtelMonitor is an active object handling the reception of 
hgs
parents:
diff changeset
    44
*   CB message pages from the EPOC Telephony server.
hgs
parents:
diff changeset
    45
*    
hgs
parents:
diff changeset
    46
*   CCbsRecMessages are constructed from the received CBS message pages and
hgs
parents:
diff changeset
    47
*   forwarded to an instance of CCbsRecEtel for decoding.
hgs
parents:
diff changeset
    48
*   Constructing a whole message, in case of multipage messages, is also left 
hgs
parents:
diff changeset
    49
*   to CCbsRecEtel and CCbsRecCollector.
hgs
parents:
diff changeset
    50
*/
hgs
parents:
diff changeset
    51
class CCbsRecEtelMonitor : public CActive
hgs
parents:
diff changeset
    52
    {
hgs
parents:
diff changeset
    53
    public:     // New functions
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
        /**
hgs
parents:
diff changeset
    56
        *   Creates an instance of the class.
hgs
parents:
diff changeset
    57
        *
hgs
parents:
diff changeset
    58
        *   @param      aEtel               A reference to the receiver
hgs
parents:
diff changeset
    59
        *   @param      aSmsMessaging       A reference to the messaging object
hgs
parents:
diff changeset
    60
        *   @param      aFactory            A reference to the message factory
hgs
parents:
diff changeset
    61
        *   @param      aLivecastHandler    A reference to the Livecast handler
hgs
parents:
diff changeset
    62
        *   @return                         A new instance of CCbsRecEtelMonitor
hgs
parents:
diff changeset
    63
        */
hgs
parents:
diff changeset
    64
        static CCbsRecEtelMonitor* NewL( CCbsRecEtel& aEtel, 
hgs
parents:
diff changeset
    65
            MCbsEtelMessaging& aSmsMessaging,  
hgs
parents:
diff changeset
    66
            CCbsMessageFactory& aFactory,
hgs
parents:
diff changeset
    67
            CCbsLivecastHandler& aLivecastHandler );
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
        /**
hgs
parents:
diff changeset
    70
        *   Destructor.
hgs
parents:
diff changeset
    71
        */
hgs
parents:
diff changeset
    72
        ~CCbsRecEtelMonitor();
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
        /** 
hgs
parents:
diff changeset
    75
        *   Requests EPOC Telephony server to forward next received CB message to 
hgs
parents:
diff changeset
    76
        *   this object.
hgs
parents:
diff changeset
    77
        */
hgs
parents:
diff changeset
    78
        void IssueRequest();
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
    private:    // From CActive
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
        /**
hgs
parents:
diff changeset
    83
        *   Becomes active when EPOC Telephony server has copied a CB message to 
hgs
parents:
diff changeset
    84
        *   iCbsMessagePage. The page is then given to CCbsRecEtel for
hgs
parents:
diff changeset
    85
        *   processing.
hgs
parents:
diff changeset
    86
        *
hgs
parents:
diff changeset
    87
        *   Finally this function reissues the ReceiveMessage request.
hgs
parents:
diff changeset
    88
        */
hgs
parents:
diff changeset
    89
        void RunL();
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
        /**
hgs
parents:
diff changeset
    92
        *   Cancels an outstanding ReceiveMessage request.
hgs
parents:
diff changeset
    93
        */
hgs
parents:
diff changeset
    94
        void DoCancel();
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    private:
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
        /**
hgs
parents:
diff changeset
    99
        *   The constructor.
hgs
parents:
diff changeset
   100
        *
hgs
parents:
diff changeset
   101
        *   @param  aEtel               CCbsRecEtel object.
hgs
parents:
diff changeset
   102
        *   @param  aMessaging          ETel messaging object
hgs
parents:
diff changeset
   103
        *   @param  aFactory            A reference to the message factory
hgs
parents:
diff changeset
   104
        *   @param  aLivecastHandler    A reference to the Livecast handler
hgs
parents:
diff changeset
   105
        */
hgs
parents:
diff changeset
   106
        CCbsRecEtelMonitor( CCbsRecEtel& aEtel, MCbsEtelMessaging& aMessaging,
hgs
parents:
diff changeset
   107
            CCbsMessageFactory& aFactory, CCbsLivecastHandler& aLivecastHandler );
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
        /**
hgs
parents:
diff changeset
   110
        *   Finalizes the construction.
hgs
parents:
diff changeset
   111
        */
hgs
parents:
diff changeset
   112
        void ConstructL();
hgs
parents:
diff changeset
   113
      
hgs
parents:
diff changeset
   114
    private:    // Data
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
        // CCbsRecEtel instance to which CB messages are passed.
hgs
parents:
diff changeset
   117
        CCbsRecEtel& iEtel;
hgs
parents:
diff changeset
   118
                
hgs
parents:
diff changeset
   119
        // Messaging subsession.
hgs
parents:
diff changeset
   120
        MCbsEtelMessaging& iSmsMessaging;       
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
        /**
hgs
parents:
diff changeset
   123
        *   Message page is stored here when the monitor becomes active
hgs
parents:
diff changeset
   124
        *   due the arrival of a CBS message.
hgs
parents:
diff changeset
   125
        */        
hgs
parents:
diff changeset
   126
        // Message data
hgs
parents:
diff changeset
   127
        RMobileBroadcastMessaging::TBroadcastPageData iMsgData;
hgs
parents:
diff changeset
   128
        
hgs
parents:
diff changeset
   129
        // Attributedata of an incoming broadcast message
hgs
parents:
diff changeset
   130
        RMobileBroadcastMessaging::TMobileBroadcastAttributesV2 iAttributes;
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
        // Attributepackage of an incoming broadcast message
hgs
parents:
diff changeset
   133
        RMobileBroadcastMessaging::TMobileBroadcastAttributesV2Pckg iMsgAttributesPckg;
hgs
parents:
diff changeset
   134
        
hgs
parents:
diff changeset
   135
        // Message factory
hgs
parents:
diff changeset
   136
        CCbsMessageFactory& iFactory;
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
        // LC message handler
hgs
parents:
diff changeset
   139
        CCbsLivecastHandler& iLivecastHandler;
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
        // Is Newsticker feature supported
hgs
parents:
diff changeset
   142
        TBool iNewstickerSupported;
hgs
parents:
diff changeset
   143
hgs
parents:
diff changeset
   144
    };
hgs
parents:
diff changeset
   145
hgs
parents:
diff changeset
   146
#endif      //  CCBSRECETELMONITOR_H   
hgs
parents:
diff changeset
   147
            
hgs
parents:
diff changeset
   148
// End of File
hgs
parents:
diff changeset
   149
hgs
parents:
diff changeset
   150