epoc32/include/comms-infras/api_ext_msg.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // 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
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 
    18 /**
    19  @file
    20  @publishedPartner
    21  @prototype
    22 */
    23 
    24 #ifndef API_EXT_MSG_H
    25 #define API_EXT_MSG_H
    26 
    27 #include <comms-infras/metadata.h>
    28 #include <comms-infras/netmessages.h>
    29 #include <es_prot.h>
    30 
    31 class CCommsApiExtensionMsg : public NetMessages::CMessage
    32 /**
    33 Comms API extension message.
    34 
    35 @publishedPartner
    36 @prototype
    37 */
    38 	{
    39 public:
    40 	/** Creates a new api extension message using ECOM.
    41 
    42     @param aTypeId Id of the class (Composed of Uid of the implementation and an integer sub-type).
    43     @return a generic pointer to a specific message if successful, otherwise leaves with system error code.
    44     */
    45 	IMPORT_C static CCommsApiExtensionMsg* NewL(const Meta::STypeId& aTypeId);
    46 
    47 	/** Creates a new api extension message using ECOM.
    48 
    49     @param aMsgBuffer a buffer containing the serialised form of the message object.
    50     @return a generic pointer to a specific event if successful, otherwise leaves with system error code.
    51     */
    52 	IMPORT_C static CCommsApiExtensionMsg* NewL(const TDesC8& aMsgBuffer);
    53 	};
    54 
    55 namespace NetInterfaces
    56 	{
    57 	class TInterfaceControl;
    58 	}
    59 namespace Elements
    60 {
    61 	class CResponseMsg;
    62 }
    63 
    64 class CCommsApiExtReqMsg : public CCommsApiExtensionMsg
    65 /**
    66 Comms API extension request message.
    67 
    68 @publishedPartner
    69 @prototype
    70 */
    71 	{
    72 public:
    73 	virtual void DispatchL(NetInterfaces::TInterfaceControl& aIntfCtl, const TSubSessionUniqueId& aSubSessionUniqueId, Elements::CResponseMsg* aResponseMsg) = 0;
    74 	};
    75 
    76 class CCommsApiExtRespMsg : public CCommsApiExtensionMsg
    77 /**
    78 Comms API extension response message.
    79 
    80 @publishedPartner
    81 @prototype
    82 */
    83 	{
    84 	};
    85 
    86 #endif // API_EXT_MSG_H