epoc32/include/comms-infras/cs_api_ext.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000 (2010-03-16)
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
 @internalTechnology
williamr@2
    21
 @released
williamr@2
    22
*/
williamr@2
    23
williamr@2
    24
#ifndef CS_API_EXT_H
williamr@2
    25
#define CS_API_EXT_H
williamr@2
    26
williamr@2
    27
#include <es_sock.h>
williamr@2
    28
#include <comms-infras/api_ext_list.h>
williamr@2
    29
#include <comms-infras/trbuf.h>
williamr@2
    30
williamr@2
    31
class CCommsApiExtReqMsg;
williamr@2
    32
class CCommsApiExtRespMsg;
williamr@2
    33
williamr@2
    34
class RCommsApiExtensionBase
williamr@2
    35
/**
williamr@2
    36
Base class for Comms API extensions.
williamr@2
    37
williamr@2
    38
@internalTechnology
williamr@2
    39
@released
williamr@2
    40
*/
williamr@2
    41
	{
williamr@2
    42
protected:
williamr@2
    43
	IMPORT_C explicit RCommsApiExtensionBase();
williamr@2
    44
	IMPORT_C TInt Open(RCommsSubSession& aExtensionProvider, TSupportedCommsApiExt aInterfaceId);
williamr@2
    45
	IMPORT_C void Close();
williamr@2
    46
	IMPORT_C void SendRequest(CCommsApiExtReqMsg& aRequestMsg, TDes8& aResponseBuf, TRequestStatus& aStatus);
williamr@2
    47
	IMPORT_C void SendMessage(CCommsApiExtReqMsg& aRequestMsg);
williamr@2
    48
williamr@2
    49
protected:
williamr@2
    50
	RCommsSubSession iSubSession;
williamr@2
    51
	TSupportedCommsApiExt iInterfaceId;
williamr@2
    52
williamr@2
    53
private:
williamr@2
    54
	RPointerArray<Elements::TRBuf8> iBuffers;
williamr@2
    55
	};
williamr@2
    56
williamr@2
    57
template<TSupportedCommsApiExt T>
williamr@2
    58
class RCommsApiExtension : public RCommsApiExtensionBase
williamr@2
    59
/**
williamr@2
    60
Comms API extensions template. New extension APIs may derive from this template.
williamr@2
    61
williamr@2
    62
@internalTechnology
williamr@2
    63
@released
williamr@2
    64
*/
williamr@2
    65
	{
williamr@2
    66
public:
williamr@2
    67
	inline TInt Open(RCommsSubSession& aExtensionProvider);
williamr@2
    68
	};
williamr@2
    69
williamr@2
    70
template<TSupportedCommsApiExt T>
williamr@2
    71
TInt RCommsApiExtension<T>::Open(RCommsSubSession& aExtensionProvider)
williamr@2
    72
	{
williamr@2
    73
	return RCommsApiExtensionBase::Open(aExtensionProvider,T);
williamr@2
    74
	}
williamr@2
    75
williamr@2
    76
#endif // CS_API_EXT_H