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