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