epoc32/include/mw/lbtserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  location triggering server client library
    15 *
    16 */
    17 
    18 
    19 
    20 #ifndef LBTSERVER_H
    21 #define LBTSERVER_H
    22 
    23 
    24 #include <e32base.h>
    25 
    26 /**
    27  * A handle to Location Triggering Server session. 
    28  *
    29  * This is generally the first interface class used by all client applications.
    30  * It is used to make the primary connection to the Location Triggering Server. 
    31  * After the primary connection has been established, its handle is passed as a 
    32  * parameter of the Open methods of @p RLbt to create a subsession.
    33  *
    34  *  @lib lbt.lib
    35  *
    36  *  @since S60 5.1
    37  */
    38 class RLbtServer : public RSessionBase
    39     {
    40 public:
    41     /**
    42      * Constructor for RLbtServer
    43      */
    44     IMPORT_C RLbtServer();
    45 
    46     /**
    47      * Creates a session with the Location Triggering Server. 
    48      * This method must be called before any subsession can be opened. 
    49      * @see RLbt.
    50      *
    51      * @panic ELbtServerHandleNotClosed Try to connect using an already opened handle. 
    52      *
    53      * @return KErrNone, if successful. KErrNotSupported if Location Triggers
    54      * Server is not present in the system. Otherwise one of the other standard
    55      * Symbian error code (for example KErrNoMemory, KErrServerBusy, etc. ) 
    56      * is returned.
    57      */
    58     IMPORT_C TInt Connect();
    59 
    60     /**
    61      * Closes a session with the Location Triggering Server.
    62      * Before the connection to Location Triggering Server is closed, the 
    63      * client application must ensure that all subsessions is closed. 
    64      */
    65     IMPORT_C void Close();
    66 
    67     /**
    68      * Obtains the client side version number of Location Triggering Server.
    69      *
    70      * @return The client side version number.
    71      */
    72     IMPORT_C TVersion Version() const;
    73     
    74     /**
    75      * Symbian 2nd phase constructor.
    76      */    
    77     void ConstructL();
    78 
    79 private: // data
    80     /**
    81      * Unused variable for future expansion. 
    82      */
    83     TAny* iReserved;
    84     };
    85 
    86 
    87 #endif //LBTSERVER_H