realtimenetprots/sipfw/SIP/Server/inc/MSIPCSReceiverOwner.h
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 /*
       
     2 * Copyright (c) 2006-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          : MSIPCSReceiverOwner.h
       
    16 * Part of       : SIP / SIP Server Core
       
    17 * Version       : SIP/5.0 
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 /**
       
    25  @internalComponent
       
    26 */
       
    27 
       
    28 #ifndef MSIPCSRECEIVEROWNER_H
       
    29 #define MSIPCSRECEIVEROWNER_H
       
    30 
       
    31 //  INCLUDES
       
    32 #include <e32std.h>
       
    33 #include "SipStackServerDefs.h"
       
    34 #include "TSIPTransportParams.h"
       
    35 
       
    36 // FORWARD DECLARATIONS
       
    37 class MSIPSecUser;
       
    38 
       
    39 // CLASS DECLARATION
       
    40 /**
       
    41 * A callback for a client/server receiver to fetch information from its owner.
       
    42 *
       
    43 *  @lib sipserver.exe
       
    44 */
       
    45 class MSIPCSReceiverOwner
       
    46     {
       
    47 	public:
       
    48 
       
    49 		/**
       
    50      	* Gets the transport parameters
       
    51      	*
       
    52      	* @returns the transport parameters
       
    53 	 	*/
       
    54     	virtual const TSIPTransportParams& TransportParams() const = 0;
       
    55 
       
    56 		/**
       
    57      	* Gets the transport parameters related to the registration.
       
    58      	*
       
    59      	* @param aRegistrationId a registration ID. Can be zero.
       
    60      	*
       
    61      	* @returns the transport parameters
       
    62 	 	*/
       
    63     	virtual TSIPTransportParams TransportParams(
       
    64     	    const TRegistrationId& aRegistrationId) = 0;
       
    65     	    
       
    66 	    /**
       
    67 	    * Gets the MSIPSecUser related to the given registration id.
       
    68         *
       
    69         * @param aRegistrationId the registration id
       
    70         *
       
    71         * @returns the user related to the given registration id if found,
       
    72         *          otherwise NULL.
       
    73 	    */    
       
    74         virtual const MSIPSecUser* SIPSecUser(
       
    75             const TRegistrationId& aRegistrationId) = 0; 
       
    76     };
       
    77 
       
    78 #endif // MSIPCSRECEIVEROWNER_H
       
    79 
       
    80 // End of File