epoc32/include/mw/lbtserver.h
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/lbtserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,87 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  location triggering server client library
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +#ifndef LBTSERVER_H
    1.24 +#define LBTSERVER_H
    1.25 +
    1.26 +
    1.27 +#include <e32base.h>
    1.28 +
    1.29 +/**
    1.30 + * A handle to Location Triggering Server session. 
    1.31 + *
    1.32 + * This is generally the first interface class used by all client applications.
    1.33 + * It is used to make the primary connection to the Location Triggering Server. 
    1.34 + * After the primary connection has been established, its handle is passed as a 
    1.35 + * parameter of the Open methods of @p RLbt to create a subsession.
    1.36 + *
    1.37 + *  @lib lbt.lib
    1.38 + *
    1.39 + *  @since S60 5.1
    1.40 + */
    1.41 +class RLbtServer : public RSessionBase
    1.42 +    {
    1.43 +public:
    1.44 +    /**
    1.45 +     * Constructor for RLbtServer
    1.46 +     */
    1.47 +    IMPORT_C RLbtServer();
    1.48 +
    1.49 +    /**
    1.50 +     * Creates a session with the Location Triggering Server. 
    1.51 +     * This method must be called before any subsession can be opened. 
    1.52 +     * @see RLbt.
    1.53 +     *
    1.54 +     * @panic ELbtServerHandleNotClosed Try to connect using an already opened handle. 
    1.55 +     *
    1.56 +     * @return KErrNone, if successful. KErrNotSupported if Location Triggers
    1.57 +     * Server is not present in the system. Otherwise one of the other standard
    1.58 +     * Symbian error code (for example KErrNoMemory, KErrServerBusy, etc. ) 
    1.59 +     * is returned.
    1.60 +     */
    1.61 +    IMPORT_C TInt Connect();
    1.62 +
    1.63 +    /**
    1.64 +     * Closes a session with the Location Triggering Server.
    1.65 +     * Before the connection to Location Triggering Server is closed, the 
    1.66 +     * client application must ensure that all subsessions is closed. 
    1.67 +     */
    1.68 +    IMPORT_C void Close();
    1.69 +
    1.70 +    /**
    1.71 +     * Obtains the client side version number of Location Triggering Server.
    1.72 +     *
    1.73 +     * @return The client side version number.
    1.74 +     */
    1.75 +    IMPORT_C TVersion Version() const;
    1.76 +    
    1.77 +    /**
    1.78 +     * Symbian 2nd phase constructor.
    1.79 +     */    
    1.80 +    void ConstructL();
    1.81 +
    1.82 +private: // data
    1.83 +    /**
    1.84 +     * Unused variable for future expansion. 
    1.85 +     */
    1.86 +    TAny* iReserved;
    1.87 +    };
    1.88 +
    1.89 +
    1.90 +#endif //LBTSERVER_H