cbsref/telephonyrefplugins/atltsy/atcommand/generic/inc/atmanager.h
author hgs
Tue, 22 Jun 2010 11:02:32 +0100
changeset 44 8b72faa1200f
permissions -rw-r--r--
201024_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
44
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     1
// Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     2
// All rights reserved.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     7
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     8
// Initial Contributors:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    10
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    11
// Contributors:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    12
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    13
// Description:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    14
// @file atmanager.h
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    15
// This contains CAtManager which manage AT commands
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    16
//
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    17
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    18
#ifndef ATMANAGER_H_
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    19
#define ATMANAGER_H_
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    20
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    21
// system include
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    22
#include <e32base.h>
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    23
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    24
// user include
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    25
#include "mcommobserver.h"
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    26
#include "atcommandbase.h"
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    27
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    28
//class forward
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    29
class CActiveCommandStore;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    30
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    31
/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    32
 * This class is acting an interface between Comms Engine and AT commands, which manage to find active
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    33
 * AT command and send the Event to it.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    34
 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    35
 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    36
class CAtManager : public CBase, 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    37
				   public MCommReadLineNotifier, 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    38
				   public MCommEngineObserver
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    39
	{
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    40
public:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    41
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    42
	 * Factory function
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    43
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    44
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    45
	static CAtManager* NewL();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    46
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    47
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    48
	 * Factory function
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    49
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    50
	static CAtManager* NewLC();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    51
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    52
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    53
	 * Destructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    54
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    55
	virtual ~CAtManager();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    56
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    57
public:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    58
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    59
	 * Set current active solicited AT Command.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    60
	 * By default, one one solicited AT command should be currently Active
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    61
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    62
	 * @param aSolicitedCommand The solicited AT command
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    63
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    64
	void SetSolicitedAtCommand(CAtCommandBase* aSolicitedCommand);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    65
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    66
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    67
	 * Get the Active Commands store: only one solicited and number of unsoclited AT Commands
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    68
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    69
	 * CActiveCommandStore The active commands store
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    70
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    71
	CActiveCommandStore* GetActiveCommandStore() const;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    72
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    73
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    74
	 * From MCommEngineObserver
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    75
	 * This function would be called when the event @see TAtEventSource happened.
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    76
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    77
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    78
	virtual void ReadOrWriteComplete(TAtEventSource aEvent, TInt aStatus);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    79
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    80
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    81
	 * From MCommReadLineNotifier
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    82
	 * This function would be called when one line string were found 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    83
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    84
	virtual TBool NotifyOneLineFoundL(TInt aStatus, const TDesC8& aLineBuf);
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    85
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    86
protected:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    87
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    88
	 * Constructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    89
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    90
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    91
	CAtManager();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    92
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    93
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    94
	 * 2nd constructor
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    95
	 * 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    96
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    97
	void ConstructL();
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    98
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
    99
private:
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   100
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   101
	 * The active solicited AT command
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   102
	 * Not Own
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   103
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   104
	CAtCommandBase* iSolicitedCommand; 
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   105
	
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   106
	/**
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   107
	 * The active command store
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   108
	 * Own
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   109
	 */
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   110
	CActiveCommandStore* iActiveCommandStore;
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   111
	};
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   112
8b72faa1200f 201024_02
hgs
parents:
diff changeset
   113
#endif /*ATMANAGER_H_*/