epoc32/include/plpsess.inl
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/plpsess.inl	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,153 @@
     1.4 +/**
     1.5 +* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* 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
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +* TRemoteLinkStatus
    1.19 +* 
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +
    1.27 +/**
    1.28 + @file
    1.29 + @deprecated Obselete
    1.30 +*/
    1.31 +
    1.32 +inline TRemoteLinkStatus::TRemoteLinkStatus()
    1.33 +/**
    1.34 +C++ constructor
    1.35 +*/
    1.36 +    { iStatus=EDisabled; iRemoteVersion=0; }
    1.37 +
    1.38 +//////////////////////////////////////////////////////////////////////////////
    1.39 +//
    1.40 +// RRemoteLink Deprecated methods
    1.41 +//
    1.42 +//////////////////////////////////////////////////////////////////////////////
    1.43 +
    1.44 +inline TInt RRemoteLink::Enable(TBps aBaud, const TDesC& aPort, const TDesC& aModule, TBool /*aLowPowerMode*/)
    1.45 +/**
    1.46 +Set up the RRemoteLink configuration parameters and initiate a connection
    1.47 +
    1.48 +@param aBaud  The baud rate
    1.49 +@param aPort  The port number
    1.50 +@param aModule  The module name
    1.51 +@param aLowPowerMode  Boolean representing low power mode
    1.52 +@return  KErrNone on success, standard error code on failure
    1.53 +*/
    1.54 +	{
    1.55 +
    1.56 +	TPlpConfigPkgSerial pkg(aBaud,aPort,aModule);
    1.57 +	TInt ret = SetConfig(pkg);
    1.58 +	return ret;
    1.59 +	}
    1.60 +
    1.61 +inline TInt RRemoteLink::Disable()
    1.62 +/**
    1.63 +Disable the remote link
    1.64 +
    1.65 +@return  KErrNone on success, standard error code on failure
    1.66 +*/
    1.67 +	{
    1.68 +
    1.69 +	TInt ret = Disconnect();
    1.70 +	return ret;
    1.71 +	}
    1.72 +
    1.73 +inline TInt RRemoteLink::Config(TBps* aBaud /*=NULL*/, TDesC* aPort /*=NULL*/, TDesC* aModule /*=NULL*/, TBool* /*aLowPowerMode*/)
    1.74 +/**
    1.75 +Read the current RRemoteLink configuration
    1.76 +
    1.77 +@param aBaud  The bard rate
    1.78 +@param aPort  The port number
    1.79 +@param aModule  The module name
    1.80 +@param aLowPowerMode  Boolean representing if low power mode is enabled
    1.81 +@return  KErrNone on success, standard error code on failure
    1.82 +*/
    1.83 +	{
    1.84 +
    1.85 +	TPlpConfigPkgSerial pkg;
    1.86 +	TInt ret = Config(pkg);
    1.87 +	if (ret!=KErrNone)
    1.88 +		return ret;
    1.89 +
    1.90 +	if (aBaud)
    1.91 +		*aBaud = pkg.Baud();
    1.92 +	if (aPort)
    1.93 +		*(TDes*)aPort = pkg.PortName();
    1.94 +	if (aModule)
    1.95 +		*(TDes*)aModule = pkg.ModuleName();
    1.96 +	return KErrNone;
    1.97 +	}
    1.98 +
    1.99 +inline TInt RRemoteLink::LoadLocalServer(TPlpServiceName& aResult, const TDesC& aFileName, const TDesC& aArgs /*=TPtrC()*/, TInt aReserved /*=0*/)
   1.100 +/**
   1.101 +Load a local server
   1.102 +
   1.103 +@param aResult  The service name
   1.104 +@param aFileName  The file name
   1.105 +@param aArgs  Arguments 
   1.106 +@param aReserved  The reserved flag
   1.107 +@return  KErrNone on success, standard error code on failure
   1.108 +*///
   1.109 +// 
   1.110 +//
   1.111 +	{
   1.112 +
   1.113 +	TRequestStatus status;
   1.114 +	LoadLocalServer(status,aResult,aFileName,aArgs,aReserved);
   1.115 +	User::WaitForRequest(status);
   1.116 +	return status.Int();
   1.117 +	}
   1.118 +
   1.119 +inline TInt RRemoteLink::UnloadLocalServer(const TDesC& aFileName)
   1.120 +/**
   1.121 +Unload the local server
   1.122 +
   1.123 +@param aFileName  The local server file name
   1.124 +@return  KErrNone on success, standard error code on failure
   1.125 +*/
   1.126 +	{
   1.127 +
   1.128 +	TRequestStatus status;
   1.129 +	UnloadLocalServer(status,aFileName);
   1.130 +	User::WaitForRequest(status);
   1.131 +	return status.Int();
   1.132 +	}
   1.133 +
   1.134 +inline TInt RRemoteLink::EnableFileAccess(TBool /*aEnable=ETrue*/)
   1.135 +/**
   1.136 +Dummy implementation
   1.137 +
   1.138 +@param aEnable  Enable file access boolean flag
   1.139 +@return  KErrNone on success, standard error code on failure
   1.140 +*/
   1.141 +	{
   1.142 +
   1.143 +	return KErrNone;
   1.144 +	}
   1.145 +
   1.146 +inline void RRemoteLink::WaitForConnect(TRequestStatus& aStatus, TRemoteLinkStatusBuf& aBuf)
   1.147 +/**
   1.148 +Wait for connection to complete
   1.149 +
   1.150 +@param aStatus  The request status
   1.151 +@param aBuf  The remote link status buffer
   1.152 +*/
   1.153 +	{
   1.154 +
   1.155 +	Connect(aStatus,aBuf);
   1.156 +	}