locationtriggering/ltserver/ltserverlogic/inc/lbtglobal.h
author hgs
Wed, 03 Nov 2010 23:28:39 +0530
changeset 56 4e949f03ecc5
permissions -rw-r--r--
201044
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2005 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:  Global services for LBT server
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef LBTGLOBAL_H
hgs
parents:
diff changeset
    20
#define LBTGLOBAL_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
//  INCLUDES
hgs
parents:
diff changeset
    23
#include <e32std.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
// CLASS DECLARATION
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/**
hgs
parents:
diff changeset
    28
*  Global functions for the server
hgs
parents:
diff changeset
    29
*  
hgs
parents:
diff changeset
    30
*/
hgs
parents:
diff changeset
    31
class LbtGlobal
hgs
parents:
diff changeset
    32
	{
hgs
parents:
diff changeset
    33
	public:
hgs
parents:
diff changeset
    34
	
hgs
parents:
diff changeset
    35
	   /**
hgs
parents:
diff changeset
    36
        * Writes to the message and panics the client if any error
hgs
parents:
diff changeset
    37
        * If the returned error code is negative, the RMessage must 
hgs
parents:
diff changeset
    38
        * not be completed.
hgs
parents:
diff changeset
    39
        *
hgs
parents:
diff changeset
    40
        * @param aMessage Message instance
hgs
parents:
diff changeset
    41
        * @param aPtr Pointer to write to
hgs
parents:
diff changeset
    42
        * @param aDes Descriptor to write from
hgs
parents:
diff changeset
    43
        * @param aOffset offset to start write
hgs
parents:
diff changeset
    44
        * @return Error code
hgs
parents:
diff changeset
    45
        */
hgs
parents:
diff changeset
    46
        
hgs
parents:
diff changeset
    47
        static TInt Write(
hgs
parents:
diff changeset
    48
        /* IN  */		const RMessage2& aMessage,
hgs
parents:
diff changeset
    49
        /* IN  */		const TInt aParam,
hgs
parents:
diff changeset
    50
        /* IN  */		const TDesC8& aDes,
hgs
parents:
diff changeset
    51
        /* IN  */		TInt aOffset=0
hgs
parents:
diff changeset
    52
            );
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
		/**
hgs
parents:
diff changeset
    55
         * Read and kill the client if it leaves. If the returned error code 
hgs
parents:
diff changeset
    56
         * is negative, the RMessage must not be completed. Complete after 
hgs
parents:
diff changeset
    57
         * client is paniced crashes the server with USER 70.
hgs
parents:
diff changeset
    58
         *
hgs
parents:
diff changeset
    59
         * @param aMessage Message instance
hgs
parents:
diff changeset
    60
         * @param aPtr Pointer to read from
hgs
parents:
diff changeset
    61
         * @param aDes Descriptor to read to
hgs
parents:
diff changeset
    62
         * @param aOffset offset to start read
hgs
parents:
diff changeset
    63
         * @return Error code
hgs
parents:
diff changeset
    64
         */
hgs
parents:
diff changeset
    65
        static TInt Read(
hgs
parents:
diff changeset
    66
        /* IN  */       const RMessage2& aMessage,
hgs
parents:
diff changeset
    67
        /* IN  */		const TInt aParam,
hgs
parents:
diff changeset
    68
        /* OUT */       TDes8& aDes,
hgs
parents:
diff changeset
    69
        /* IN  */       TInt aOffset=0
hgs
parents:
diff changeset
    70
            );
hgs
parents:
diff changeset
    71
        
hgs
parents:
diff changeset
    72
        /**
hgs
parents:
diff changeset
    73
        * Copies an 8-bit buffer from the address space of the client and puts 
hgs
parents:
diff changeset
    74
        * the result in the returned argument. If the method leaves it the 
hgs
parents:
diff changeset
    75
        * client may have been paniced and in that case it is forbidden to
hgs
parents:
diff changeset
    76
        * complete the RMessage. If a client is paniced can be verified by the
hgs
parents:
diff changeset
    77
        * call chain:
hgs
parents:
diff changeset
    78
        * aMessage.Client().ExitType()
hgs
parents:
diff changeset
    79
        *
hgs
parents:
diff changeset
    80
        * @param aMessage the message from the client.
hgs
parents:
diff changeset
    81
        * @param aClientBuffer a pointer to an 8-bit descriptor located in the 
hgs
parents:
diff changeset
    82
        *        address space of the client.
hgs
parents:
diff changeset
    83
        * @return a copy of the client buffer.
hgs
parents:
diff changeset
    84
        */
hgs
parents:
diff changeset
    85
        static HBufC8* CopyClientBuffer8LC(
hgs
parents:
diff changeset
    86
        /* IN  */   					  const RMessage2& aMessage,
hgs
parents:
diff changeset
    87
        /* IN  */   					  const TInt aClientBufferParam
hgs
parents:
diff changeset
    88
            							  );
hgs
parents:
diff changeset
    89
            							  
hgs
parents:
diff changeset
    90
		static void RequestComplete(
hgs
parents:
diff changeset
    91
		/* IN  */   				const RMessage2& aMessage,
hgs
parents:
diff changeset
    92
        /* IN  */   				const TInt aError
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
#endif // LBTGLOBAL_H
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
// end of file