tracesrv/tracecore/btrace_handler/inc/TraceCoreSendReceive.h
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
// Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     2
// All rights reserved.
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     7
//
hgs
parents:
diff changeset
     8
// Initial Contributors:
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    10
//
hgs
parents:
diff changeset
    11
// Contributors:
hgs
parents:
diff changeset
    12
//
hgs
parents:
diff changeset
    13
// Description:
hgs
parents:
diff changeset
    14
// Send-receive class abstracts the media used by subscribers to send / receive messages
hgs
parents:
diff changeset
    15
//
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
#ifndef __TRACECORESENDRECEIVE_H__
hgs
parents:
diff changeset
    18
#define __TRACECORESENDRECEIVE_H__
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
// Include files
hgs
parents:
diff changeset
    22
#include <kernel/kernel.h>
hgs
parents:
diff changeset
    23
#include "TraceCoreMediaIfCallback.h"
hgs
parents:
diff changeset
    24
#include "TraceCoreMessageSender.h"
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
// Forward declarations
hgs
parents:
diff changeset
    28
class DTraceCoreMediaIf;
hgs
parents:
diff changeset
    29
class DTraceCorePluginIf;
hgs
parents:
diff changeset
    30
class MTraceCoreMessageReceiver;
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/**
hgs
parents:
diff changeset
    34
 * Send-receive class abstracts the media used by subscribers to send / receive messages
hgs
parents:
diff changeset
    35
 */
hgs
parents:
diff changeset
    36
NONSHARABLE_CLASS( DTraceCoreSendReceive ) : public DBase, public MTraceCoreMediaIfCallback, public MTraceCoreMessageSender
hgs
parents:
diff changeset
    37
    {
hgs
parents:
diff changeset
    38
public:
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
    /**
hgs
parents:
diff changeset
    41
     * Constructor
hgs
parents:
diff changeset
    42
     */
hgs
parents:
diff changeset
    43
    DTraceCoreSendReceive();
hgs
parents:
diff changeset
    44
    
hgs
parents:
diff changeset
    45
    /**
hgs
parents:
diff changeset
    46
     * Destructor
hgs
parents:
diff changeset
    47
     */
hgs
parents:
diff changeset
    48
    ~DTraceCoreSendReceive();
hgs
parents:
diff changeset
    49
    
hgs
parents:
diff changeset
    50
    /**
hgs
parents:
diff changeset
    51
     * Initializes this sender / receiver
hgs
parents:
diff changeset
    52
     * 
hgs
parents:
diff changeset
    53
     * @param aReceiver Interface where incoming messages are routed
hgs
parents:
diff changeset
    54
     */
hgs
parents:
diff changeset
    55
    TInt Init( MTraceCoreMessageReceiver& aReceiver );
hgs
parents:
diff changeset
    56
    
hgs
parents:
diff changeset
    57
    /**
hgs
parents:
diff changeset
    58
     * Gets the media interface that is used by media writer
hgs
parents:
diff changeset
    59
     */
hgs
parents:
diff changeset
    60
    inline DTraceCoreMediaIf* GetMediaWriterIf();
hgs
parents:
diff changeset
    61
    
hgs
parents:
diff changeset
    62
    /**
hgs
parents:
diff changeset
    63
     * Gets the media plug-in interface or NULL if it does not exist
hgs
parents:
diff changeset
    64
     */
hgs
parents:
diff changeset
    65
    inline DTraceCorePluginIf* GetPluginIf();
hgs
parents:
diff changeset
    66
    
hgs
parents:
diff changeset
    67
private:
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
    /**
hgs
parents:
diff changeset
    70
     * MTraceCoreMediaIfCallback implementation for incoming messages
hgs
parents:
diff changeset
    71
     * 
hgs
parents:
diff changeset
    72
     * @param aMsg The message that was received
hgs
parents:
diff changeset
    73
     * @return KErrNotFound if the message id was not found (not subscribed), KErrNone if found
hgs
parents:
diff changeset
    74
     */
hgs
parents:
diff changeset
    75
    TInt MessageReceived( TTraceMessage &aMsg );
hgs
parents:
diff changeset
    76
    
hgs
parents:
diff changeset
    77
    /**
hgs
parents:
diff changeset
    78
     * Set Sender Media
hgs
parents:
diff changeset
    79
     *
hgs
parents:
diff changeset
    80
     * @param Sender media
hgs
parents:
diff changeset
    81
     */
hgs
parents:
diff changeset
    82
    TInt SetSenderMedia( DTraceCoreMediaIf* aSenderMedia );
hgs
parents:
diff changeset
    83
    
hgs
parents:
diff changeset
    84
    /**
hgs
parents:
diff changeset
    85
     * MTraceCoreMessageSender implementation for outgoing messages
hgs
parents:
diff changeset
    86
     * 
hgs
parents:
diff changeset
    87
     * @param aMessage The message to be sent
hgs
parents:
diff changeset
    88
     */
hgs
parents:
diff changeset
    89
    TInt SendMessage( TTraceMessage &aMessage );
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
    /**
hgs
parents:
diff changeset
    92
     * Initializes a media interface
hgs
parents:
diff changeset
    93
     */
hgs
parents:
diff changeset
    94
    TInt InitMediaInterface( DTraceCoreMediaIf* aMediaIf );
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    /**
hgs
parents:
diff changeset
    97
     * Creates the media interfaces
hgs
parents:
diff changeset
    98
     */
hgs
parents:
diff changeset
    99
    TInt CreateInterfaces();
hgs
parents:
diff changeset
   100
    
hgs
parents:
diff changeset
   101
    /**
hgs
parents:
diff changeset
   102
     * Deletes the media interfaces
hgs
parents:
diff changeset
   103
     */
hgs
parents:
diff changeset
   104
    void DeleteInterfaces();
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
private:
hgs
parents:
diff changeset
   107
    
hgs
parents:
diff changeset
   108
    /**
hgs
parents:
diff changeset
   109
     * Media interfaces that receive data.
hgs
parents:
diff changeset
   110
     */
hgs
parents:
diff changeset
   111
    RPointerArray< DTraceCoreMediaIf > iMediaInterfaces;
hgs
parents:
diff changeset
   112
    
hgs
parents:
diff changeset
   113
    /**
hgs
parents:
diff changeset
   114
     * Plug-in interface
hgs
parents:
diff changeset
   115
     */
hgs
parents:
diff changeset
   116
    DTraceCorePluginIf* iPluginInterface;
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
    /**
hgs
parents:
diff changeset
   119
     * Media interface for sending data
hgs
parents:
diff changeset
   120
     */
hgs
parents:
diff changeset
   121
    DTraceCoreMediaIf* iSendInterface;
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
    /**
hgs
parents:
diff changeset
   124
     * Media interface used by the media writer
hgs
parents:
diff changeset
   125
     */
hgs
parents:
diff changeset
   126
    DTraceCoreMediaIf* iMediaWriterInterface;
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
    /**
hgs
parents:
diff changeset
   129
     * Target for incoming messages
hgs
parents:
diff changeset
   130
     */
hgs
parents:
diff changeset
   131
    MTraceCoreMessageReceiver* iReceiver;
hgs
parents:
diff changeset
   132
    };
hgs
parents:
diff changeset
   133
hgs
parents:
diff changeset
   134
#endif
hgs
parents:
diff changeset
   135
hgs
parents:
diff changeset
   136
#include "TraceCoreSendReceive.inl"
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
// End of File