1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/sipobserver.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,72 @@
     1.4 +/*
     1.5 +* Copyright (c) 2005-2009 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:
    1.18 +* Name        : sipobserver.h
    1.19 +* Part of     : SIP Client
    1.20 +* Interface   : SDK API, SIP Client API
    1.21 +* Version     : 1.0
    1.22 +*
    1.23 +*/
    1.24 +
    1.25 +
    1.26 +
    1.27 +#ifndef MSIPOBSERVER_H
    1.28 +#define MSIPOBSERVER_H
    1.29 +
    1.30 +// INCLUDES
    1.31 +#include <e32std.h>
    1.32 +
    1.33 +// FORWARD DECLARATIONS
    1.34 +class CSIPServerTransaction;
    1.35 +
    1.36 +// CLASS DECLARATION
    1.37 +
    1.38 +/**
    1.39 +*  @publishedAll
    1.40 +*  @released
    1.41 +*
    1.42 +*  An interface to be implemented by user of CSIP.
    1.43 +*  Interface allows to be able to receive SIP request from the SIP connection
    1.44 +*  that has not been initialized by the user.
    1.45 +*
    1.46 +*  @lib n/a
    1.47 +*/
    1.48 +class MSIPObserver
    1.49 +    {    
    1.50 +    public: // New functions
    1.51 +        /**
    1.52 +        * A SIP request has been received from the network.
    1.53 +        * This function is called when the SIP request was received using such
    1.54 +        * an IAP, for which the application has not created a CSIPConnection
    1.55 +        * object.
    1.56 +        * @pre aTransaction != 0
    1.57 +        * @param aIapId The IapId from which the SIP request was received.
    1.58 +        * @param aTransaction contains local address, remote address of a SIP
    1.59 +        *        message, as well as optional SIP message method, headers and
    1.60 +        *        body. The ownership is transferred.
    1.61 +        */
    1.62 +        virtual void IncomingRequest(TUint32 aIapId,
    1.63 +                                     CSIPServerTransaction* aTransaction) = 0;
    1.64 +
    1.65 +        /**
    1.66 +        * The received SIP request time-outed and it is invalid i.e. cannot be used
    1.67 +        * anymore.
    1.68 +        * This will be called if the user fails to create a SIP connection and
    1.69 +        * does not send an appropriate SIP response.
    1.70 +        * @param aTransaction The time-outed transaction.
    1.71 +        */
    1.72 +        virtual void TimedOut(CSIPServerTransaction& aTransaction) = 0;
    1.73 +    };
    1.74 +
    1.75 +#endif