/*

* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* 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

* which accompanies this distribution, and is available

* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:        CSenHostletConnection offers public API for

*                applications to to provide locally, invocable

                 services (identified by unique endpoint URI)

                 to service consumers.

*

*/

#ifndef SEN_HOSTLET_CONNECTION_H

#define SEN_HOSTLET_CONNECTION_H

//  INCLUDES

#include <e32base.h> // for CActive

#include <MSenHostlet.h>

#include <MSenServiceDescription.h>

#include <SenServiceConnection.h>

#include <SenSoapEnvelope.h>

#include <SenFragment.h>

// CONSTANTS

const TInt KErrSenEndpointReserved                   =  -30317;

// FORWARD DECLARATIONS

class CSenServicePattern;

// CLASS DECLARATION

class CSenHostletConnection : public CActive

    {

    public: // Constructors and destructor

        /**

        * Constructs a new hostlet connection, utilizing the service description

        * provided by MSenHostlet::ServiceDescriptionL() callback implementation.

        * Leave codes:

        * - KErrSenEndpointReserved if the endpoint specified in hostlet 

        *   implementation already exists and is reserved for some other

        *   use (hostlet).

        * @return a pointer to a newly created hostlet connection

        */

        IMPORT_C static CSenHostletConnection* NewL(MSenHostlet& aProvider);

        /**

        * Constructs a new hostlet connection, utilizing the service description

        * provided by MSenHostlet::ServiceDescriptionL() callback implementation.

        * Leave codes:

        * - KErrSenEndpointReserved if the endpoint specified in hostlet 

        *   implementation already exists and is reserved for some other

        *   use (hostlet).

        * @return a pointer to a newly created hostlet connection, which is also

        *  left on the cleanup stack.

        */

        IMPORT_C static CSenHostletConnection* NewLC(MSenHostlet& aProvider);

        /**

        * Method for responding to incoming message. This asynchronous method

        * will send a response for the request that was received by the hostlet

        * implementation in the ServiceL callback. After the response has been

        * delivered to service consumer who made the request, the following

        * callback will be invoked:

        *       MSenHostlet::OnServiceCompleteL

        * @return KErrNone, if response was successfully pre-processed by

        * the hostlet connection - it does not mean, that it was yet 

        * received by the consumer, as this method is asynchronous.

        * If the response cannot be processed, some system-wide error

        * code is returned.    

        *         KErrAlreadyExists, if response was already provided 

        *         for this request

        */

        virtual TInt RespondL(MSenHostletResponse& aResponse) = 0;

       /* Getter for full, (live) service desctiption for this hostlet connection */

//       virtual TInt ServiceDescriptionL(CSenXmlServiceDescription*& apSessionDescription) = 0;

        /**

        * Getter for the identifier  of this connection.

        * @return the identifier as integer.

        */        

        virtual TInt Identifier() = 0;

    protected:

        /**

        * C++ default constructor.

        */

        CSenHostletConnection();

    };

#endif //SEN_HOSTLET_CONNECTION_H

// End of File