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