epoc32/include/d32comm.inl
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) 1995-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
// e32\include\d32comm.inl
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
/**
williamr@2
    21
 @file
williamr@2
    22
 @publishedPartner
williamr@2
    23
 @released
williamr@2
    24
*/
williamr@2
    25
williamr@2
    26
#ifndef __KERNEL_MODE__
williamr@2
    27
_LIT(KRBusDevComm,"Comm");
williamr@2
    28
/**
williamr@2
    29
@capability CommDD
williamr@2
    30
*/
williamr@2
    31
inline TInt RBusDevComm::Open(TInt aUnit)
williamr@2
    32
	{return(DoCreate(KRBusDevComm,VersionRequired(),aUnit,NULL,NULL));}
williamr@2
    33
inline TVersion RBusDevComm::VersionRequired() const
williamr@2
    34
	{return(TVersion(EMajorVersionNumber,EMinorVersionNumber,EBuildVersionNumber));}
williamr@2
    35
inline void RBusDevComm::Read(TRequestStatus &aStatus,TDes8 &aDes)
williamr@2
    36
	{TInt len=aDes.MaxLength();DoRequest(ERequestRead,aStatus,&aDes,&len);}
williamr@2
    37
inline void RBusDevComm::Read(TRequestStatus &aStatus,TDes8 &aDes,TInt aLength)
williamr@2
    38
	{DoRequest(ERequestRead,aStatus,&aDes,&aLength);}
williamr@2
    39
inline void RBusDevComm::ReadOneOrMore(TRequestStatus &aStatus,TDes8 &aDes)
williamr@2
    40
	{TInt len=(-aDes.MaxLength());DoRequest(ERequestRead,aStatus,&aDes,&len);}
williamr@2
    41
inline void RBusDevComm::ReadCancel()
williamr@2
    42
	{DoCancel(ERequestReadCancel);}
williamr@2
    43
inline void RBusDevComm::Write(TRequestStatus &aStatus,const TDesC8 &aDes)
williamr@2
    44
	{TInt len=aDes.Length();DoRequest(ERequestWrite,aStatus,(TAny *)&aDes,&len);}
williamr@2
    45
inline void RBusDevComm::Write(TRequestStatus &aStatus,const TDesC8 &aDes,TInt aLength)
williamr@2
    46
	{DoRequest(ERequestWrite,aStatus,(TAny *)&aDes,&aLength);}
williamr@2
    47
inline void RBusDevComm::WriteCancel()
williamr@2
    48
	{DoCancel(ERequestWriteCancel);}
williamr@2
    49
inline void RBusDevComm::Break(TRequestStatus &aStatus,TInt aTime)
williamr@2
    50
	{DoRequest(ERequestBreak,aStatus,&aTime);}
williamr@2
    51
inline void RBusDevComm::BreakCancel()
williamr@2
    52
	{DoCancel(ERequestBreakCancel);}
williamr@2
    53
inline void RBusDevComm::Config(TDes8 &aConfig)
williamr@2
    54
	{DoControl(EControlConfig,&aConfig);}
williamr@2
    55
inline TInt RBusDevComm::SetConfig(const TDesC8 &aConfig)
williamr@2
    56
	{return(DoControl(EControlSetConfig,(TAny *)&aConfig));}
williamr@2
    57
inline void RBusDevComm::Caps(TDes8 &aCaps)
williamr@2
    58
	{DoControl(EControlCaps,&aCaps);}
williamr@2
    59
inline TUint RBusDevComm::Signals()
williamr@2
    60
	{return(DoControl(EControlSignals));}
williamr@2
    61
inline void RBusDevComm::SetSignals(TUint aSetMask,TUint aClearMask)
williamr@2
    62
	{DoControl(EControlSetSignals,(TAny *)aSetMask,(TAny *)aClearMask);}
williamr@2
    63
inline TInt RBusDevComm::QueryReceiveBuffer()
williamr@2
    64
	{return(DoControl(EControlQueryReceiveBuffer));}
williamr@2
    65
inline void RBusDevComm::ResetBuffers()
williamr@2
    66
	{DoControl(EControlResetBuffers);}
williamr@2
    67
inline TInt RBusDevComm::ReceiveBufferLength()
williamr@2
    68
	{return(DoControl(EControlReceiveBufferLength));}
williamr@2
    69
inline TInt RBusDevComm::SetReceiveBufferLength(TInt aLength)
williamr@2
    70
	{return(DoControl(EControlSetReceiveBufferLength,(TAny *)aLength));}
williamr@2
    71
inline void RBusDevComm::NotifySignalChange(TRequestStatus& aStatus, TUint& aSignals, TUint aSignalMask)
williamr@2
    72
	{DoRequest(ERequestNotifySignalChange,aStatus,&aSignals,&aSignalMask);}
williamr@2
    73
inline void RBusDevComm::NotifySignalChangeCancel()
williamr@2
    74
	{DoCancel(ERequestNotifySignalChangeCancel);}
williamr@2
    75
inline void RBusDevComm::NotifyReceiveDataAvailable(TRequestStatus& aStatus)
williamr@2
    76
	{DoRequest(ERequestRead,aStatus,NULL,NULL);}
williamr@2
    77
inline void RBusDevComm::NotifyReceiveDataAvailableCancel()
williamr@2
    78
	{DoCancel(ERequestReadCancel);}
williamr@2
    79
inline TUint RBusDevComm::MinTurnaroundTime()
williamr@2
    80
	{return(DoControl(EControlMinTurnaroundTime));}
williamr@2
    81
inline TInt RBusDevComm::SetMinTurnaroundTime(TUint aMicroSeconds)
williamr@2
    82
	{return(DoControl(EControlSetMinTurnaroundTime,(TAny *)aMicroSeconds));}
williamr@2
    83
#ifdef _DEBUG_DEVCOMM
williamr@2
    84
inline void RBusDevComm::DebugInfo(TDes8 &aInfo)
williamr@2
    85
	{DoControl(EControlDebugInfo,&aInfo);}
williamr@2
    86
#endif
williamr@2
    87
//
williamr@2
    88
_LIT(KRBusDevCommDCE,"CommDCE");
williamr@2
    89
/**
williamr@2
    90
@capability CommDD
williamr@2
    91
*/
williamr@2
    92
inline TInt RBusDevCommDCE::Open(TInt aUnit)
williamr@2
    93
	{return(DoCreate(KRBusDevCommDCE,VersionRequired(),aUnit,NULL,NULL));}
williamr@2
    94
inline TVersion RBusDevCommDCE::VersionRequired() const
williamr@2
    95
	{return(TVersion(EMajorVersionNumber,EMinorVersionNumber,EBuildVersionNumber));}
williamr@2
    96
inline void RBusDevCommDCE::Read(TRequestStatus &aStatus,TDes8 &aDes)
williamr@2
    97
	{TInt len=aDes.MaxLength();DoRequest(ERequestRead,aStatus,&aDes,&len);}
williamr@2
    98
inline void RBusDevCommDCE::Read(TRequestStatus &aStatus,TDes8 &aDes,TInt aLength)
williamr@2
    99
	{DoRequest(ERequestRead,aStatus,&aDes,&aLength);}
williamr@2
   100
inline void RBusDevCommDCE::ReadOneOrMore(TRequestStatus &aStatus,TDes8 &aDes)
williamr@2
   101
	{TInt len=(-aDes.MaxLength());DoRequest(ERequestRead,aStatus,&aDes,&len);}
williamr@2
   102
inline void RBusDevCommDCE::ReadCancel()
williamr@2
   103
	{DoCancel(ERequestReadCancel);}
williamr@2
   104
inline void RBusDevCommDCE::Write(TRequestStatus &aStatus,const TDesC8 &aDes)
williamr@2
   105
	{TInt len=aDes.Length();DoRequest(ERequestWrite,aStatus,(TAny *)&aDes,&len);}
williamr@2
   106
inline void RBusDevCommDCE::Write(TRequestStatus &aStatus,const TDesC8 &aDes,TInt aLength)
williamr@2
   107
	{DoRequest(ERequestWrite,aStatus,(TAny *)&aDes,&aLength);}
williamr@2
   108
inline void RBusDevCommDCE::WriteCancel()
williamr@2
   109
	{DoCancel(ERequestWriteCancel);}
williamr@2
   110
inline void RBusDevCommDCE::Break(TRequestStatus &aStatus,TInt aTime)
williamr@2
   111
	{DoRequest(ERequestBreak,aStatus,&aTime);}
williamr@2
   112
inline void RBusDevCommDCE::BreakCancel()
williamr@2
   113
	{DoCancel(ERequestBreakCancel);}
williamr@2
   114
inline void RBusDevCommDCE::Config(TDes8 &aConfig)
williamr@2
   115
	{DoControl(EControlConfig,&aConfig);}
williamr@2
   116
inline TInt RBusDevCommDCE::SetConfig(const TDesC8 &aConfig)
williamr@2
   117
	{return(DoControl(EControlSetConfig,(TAny *)&aConfig));}
williamr@2
   118
inline void RBusDevCommDCE::Caps(TDes8 &aCaps)
williamr@2
   119
	{DoControl(EControlCaps,&aCaps);}
williamr@2
   120
inline TUint RBusDevCommDCE::Signals()
williamr@2
   121
	{return(DoControl(EControlSignals));}
williamr@2
   122
inline void RBusDevCommDCE::SetSignals(TUint aSetMask,TUint aClearMask)
williamr@2
   123
	{DoControl(EControlSetSignals,(TAny *)aSetMask,(TAny *)aClearMask);}
williamr@2
   124
inline TInt RBusDevCommDCE::QueryReceiveBuffer()
williamr@2
   125
	{return(DoControl(EControlQueryReceiveBuffer));}
williamr@2
   126
inline void RBusDevCommDCE::ResetBuffers()
williamr@2
   127
	{DoControl(EControlResetBuffers);}
williamr@2
   128
inline TInt RBusDevCommDCE::ReceiveBufferLength()
williamr@2
   129
	{return(DoControl(EControlReceiveBufferLength));}
williamr@2
   130
inline TInt RBusDevCommDCE::SetReceiveBufferLength(TInt aLength)
williamr@2
   131
	{return(DoControl(EControlSetReceiveBufferLength,(TAny *)aLength));}
williamr@2
   132
inline void RBusDevCommDCE::NotifySignalChange(TRequestStatus& aStatus,TUint& aSignals,TUint aSignalMask)
williamr@2
   133
	{DoRequest(ERequestNotifySignalChange,aStatus,&aSignals,&aSignalMask);}
williamr@2
   134
inline void RBusDevCommDCE::NotifySignalChangeCancel()
williamr@2
   135
	{DoCancel(ERequestNotifySignalChangeCancel);}
williamr@2
   136
inline void RBusDevCommDCE::NotifyReceiveDataAvailable(TRequestStatus& aStatus)
williamr@2
   137
	{DoRequest(ERequestRead,aStatus,NULL,NULL);}
williamr@2
   138
inline void RBusDevCommDCE::NotifyReceiveDataAvailableCancel()
williamr@2
   139
	{DoCancel(ERequestReadCancel);}
williamr@2
   140
inline void RBusDevCommDCE::NotifyFlowControlChange(TRequestStatus& aStatus)
williamr@2
   141
	{DoRequest(ERequestNotifyFlowControlChange,aStatus);}
williamr@2
   142
inline void RBusDevCommDCE::NotifyFlowControlChangeCancel()
williamr@2
   143
	{DoCancel(ERequestNotifyFlowControlChangeCancel);}
williamr@2
   144
inline void RBusDevCommDCE::GetFlowControlStatus(TFlowControl& aFlowControl)
williamr@2
   145
	{DoControl(EControlFlowControlStatus,(TAny*)&aFlowControl);}
williamr@2
   146
inline void RBusDevCommDCE::NotifyConfigChange(TRequestStatus& aStatus, TDes8& aNewConfig)
williamr@2
   147
	{DoRequest(ERequestNotifyConfigChange,aStatus,(TAny*)&aNewConfig);}
williamr@2
   148
inline void RBusDevCommDCE::NotifyConfigChangeCancel()
williamr@2
   149
	{DoCancel(ERequestNotifyConfigChangeCancel);}
williamr@2
   150
#ifdef _DEBUG_DEVCOMM
williamr@2
   151
inline void RBusDevCommDCE::DebugInfo(TDes8 &aInfo)
williamr@2
   152
	{DoControl(EControlDebugInfo,&aInfo);}
williamr@2
   153
#endif
williamr@2
   154
#endif