epoc32/include/mw/sipobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
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) 2005-2009 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:
    15 * Name        : sipobserver.h
    16 * Part of     : SIP Client
    17 * Interface   : SDK API, SIP Client API
    18 * Version     : 1.0
    19 *
    20 */
    21 
    22 
    23 
    24 #ifndef MSIPOBSERVER_H
    25 #define MSIPOBSERVER_H
    26 
    27 // INCLUDES
    28 #include <e32std.h>
    29 
    30 // FORWARD DECLARATIONS
    31 class CSIPServerTransaction;
    32 
    33 // CLASS DECLARATION
    34 
    35 /**
    36 *  @publishedAll
    37 *  @released
    38 *
    39 *  An interface to be implemented by user of CSIP.
    40 *  Interface allows to be able to receive SIP request from the SIP connection
    41 *  that has not been initialized by the user.
    42 *
    43 *  @lib n/a
    44 */
    45 class MSIPObserver
    46     {    
    47     public: // New functions
    48         /**
    49         * A SIP request has been received from the network.
    50         * This function is called when the SIP request was received using such
    51         * an IAP, for which the application has not created a CSIPConnection
    52         * object.
    53         * @pre aTransaction != 0
    54         * @param aIapId The IapId from which the SIP request was received.
    55         * @param aTransaction contains local address, remote address of a SIP
    56         *        message, as well as optional SIP message method, headers and
    57         *        body. The ownership is transferred.
    58         */
    59         virtual void IncomingRequest(TUint32 aIapId,
    60                                      CSIPServerTransaction* aTransaction) = 0;
    61 
    62         /**
    63         * The received SIP request time-outed and it is invalid i.e. cannot be used
    64         * anymore.
    65         * This will be called if the user fails to create a SIP connection and
    66         * does not send an appropriate SIP response.
    67         * @param aTransaction The time-outed transaction.
    68         */
    69         virtual void TimedOut(CSIPServerTransaction& aTransaction) = 0;
    70     };
    71 
    72 #endif