// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

/**

 @file

 @publishedPartner

 @released

*/

#if !defined(__ETEL_H__)

/** @internalComponent */

#define __ETEL_H__

#if !defined(__E32BASE_H__)

#include <e32base.h>

#endif

#if !defined (__C32COMM_H__)

#include <c32comm.h>

#endif

#if !defined(__D32COMM_H__)

#include <d32comm.h>

#endif

#if !defined(__FAXDEFN_H)

#include <faxdefn.h>

#endif

/** Major version number.*/

const TUint KEtelMajorVersionNumber=1;

/** Minor version number. */

const TUint KEtelMinorVersionNumber=0;

/** Build number. */

const TUint KEtelBuildVersionNumber=606;

/**

@internalComponent

*/

IMPORT_C void PanicClient(TInt aFault);

//

// Etel Core Error Definitions

//

const TInt KErrEtelCoreBase = -2000;

/** The client is not the call owner and has attempted to perform an operation 

that requires ownership.*/

const TInt KErrEtelNotCallOwner=KErrEtelCoreBase;

/** An attempt has been made to load an ETel (TSY) module which contains a phone 

with the same name as one already loaded. */

const TInt KErrEtelDuplicatePhoneName=KErrEtelCoreBase-1;

/** An attempt has been made to acquire call ownership when the requesting client 

is already the call owner. */

const TInt KErrEtelAlreadyCallOwner=KErrEtelCoreBase-2;

/** A connection has been terminated because the carrier has been lost. */

const TInt KErrEtelNoCarrier=KErrEtelCoreBase-3;

/** An attempt to establish a connection with the RCall::Dial() function has failed 

because the remote party's line was busy. */

const TInt KErrEtelBusyDetected=KErrEtelCoreBase-4;

/** An attempt has been made to transfer call ownership, but no other clients are 

interested in acquiring ownership. */

const TInt KErrEtelNoClientInterestedInThisCall=KErrEtelCoreBase-5;

/** The TSY has failed to initialise the modem. This may be occur if the modem 

is disconnected during initialisation, or if an attempt is made to initialise 

an unsupported modem. */

const TInt KErrEtelInitialisationFailure=KErrEtelCoreBase-6;

/** An attempt has been made to perform an operation which requires the call to 

be connected - when the call is not connected. E.g. RCall:LoanDataPort(). */

const TInt KErrEtelCallNotActive=KErrEtelCoreBase-7;

/** A connection request has failed because there is no answer. */

const TInt KErrEtelNoAnswer=KErrEtelCoreBase-8;

/** A connection request has failed because there is no dial tone. For example, 

if there is no connection between the modem and the network. */

const TInt KErrEtelNoDialTone=KErrEtelCoreBase-9;

/** An attempt to configure the port has failed because the hardware cannot match 

the desired configuration. For example, if an attempt is made to configure 

the comms port to a baud rate it cannot support. */

const TInt KErrEtelConfigPortFailure=KErrEtelCoreBase-10;

/** Out of memory error - global chunk cannot be created. */

const TInt KErrEtelFaxChunkNotCreated=KErrEtelCoreBase-11;

/** The client is not the fax owner and has attempted to perform an operation that 

requires fax ownership.

The fax client should be used to access fax functionality. Consequently, client 

code should not return this error. */

const TInt KErrEtelNotFaxOwner=KErrEtelCoreBase-12;

/** An attempt has been made to perform an operation which requires port ownership. 

However, the client does not own the port. */

const TInt KErrEtelPortNotLoanedToClient=KErrEtelCoreBase-13;

/** An operation has failed because the modem has been incorrectly configured. */

const TInt KErrEtelWrongModemType=KErrEtelCoreBase-14;

/** An operation has failed because the modem does not understand the request - 

possible bug in modem. */

const TInt KErrEtelUnknownModemCapability=KErrEtelCoreBase-15;

/** The call has already placed an 'answer incoming call' request. Only 1 request 

of a type (e.g. fax, voice, data) can be outstanding on the server at a time. */

const TInt KErrEtelAnswerAlreadyOutstanding=KErrEtelCoreBase-16;

/** An attempt to establish a connection with the modem has failed because the 

modem cannot be detected. */

const TInt KErrEtelModemNotDetected=KErrEtelCoreBase-17;

/** Operation failed because the modem settings are corrupt. */

const TInt KErrEtelModemSettingsCorrupt=KErrEtelCoreBase-18;

/** The Data port is in use by another call or application. */

const TInt KErrEtelPortAlreadyLoaned=KErrEtelCoreBase-19;

/** Another call active. Close it before opening a new one. */

const TInt KErrEtelCallAlreadyActive=KErrEtelCoreBase-20;

//

//

// RTelSubSessionBase

//

//

class CPtrHolder;

class RFile;

/**

A base class used in the derivation of RCall, RLine, and RPhone. It has no user

accessible functions. 

@publishedPartner

@released

*/

class RTelSubSessionBase : public RSubSessionBase

	{

public:

	inline RSessionBase& SessionHandle() const;

	inline void SetSessionHandle(RSessionBase& aSession);

	inline void ResetSessionHandle();

	inline TInt SubSessionHandle();

	IMPORT_C void CancelAsyncRequest(TInt aReqToCancel) const;

	enum TReqPriorityType

		{

		EIsNotaPriorityRequest,

		EIsaPriorityRequest,

		EIsaEmergencyRequest

		};

protected:

	IMPORT_C RTelSubSessionBase();

	IMPORT_C TInt Blank(const TInt aIpc,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Blank(const TInt aIpc,TRequestStatus& aStatus,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Set(const TInt aIpc,const TDesC8& aDes,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Set(const TInt aIpc,TRequestStatus& aStatus,const TDesC8& aDes,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Get(const TInt aIpc,TDes8& aDes,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Get(const TInt aIpc,TRequestStatus& aStatus,TDes8& aDes,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Set(const TInt aIpc,const TDesC8& aDes1,const TDesC8& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Set(const TInt aIpc,TRequestStatus& aStatus,const TDesC8& aDes1,const TDesC8& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Get(const TInt aIpc,TDes8& aDes1,TDes8& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Get(const TInt aIpc,TRequestStatus& aStatus,TDes8& aDes1,TDes8& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Set(const TInt aIpc,const TDesC16& aDes,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Set(const TInt aIpc,TRequestStatus& aStatus,const TDesC16& aDes,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Get(const TInt aIpc,TDes16& aDes,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Get(const TInt aIpc,TRequestStatus& aStatus,TDes16& aDes,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Set(const TInt aIpc,const TDesC16& aDes1,const TDesC16& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Set(const TInt aIpc,TRequestStatus& aStatus,const TDesC16& aDes1,const TDesC16& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Set(const TInt aIpc,const TDesC8& aDes1,const TDesC16& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Set(const TInt aIpc,TRequestStatus& aStatus,const TDesC8& aDes1,const TDesC16& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Get(const TInt aIpc,TDes16& aDes1,TDes16& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Get(const TInt aIpc,TRequestStatus& aStatus,TDes16& aDes1,TDes16& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Get(const TInt aIpc,TDes8& aDes1,TDes16& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void Get(const TInt aIpc,TRequestStatus& aStatus,TDes8& aDes1,TDes16& aDes2,TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void SetAndGet(const TInt aIpc, TRequestStatus& aStatus, const TDesC8& aDes1, TDes8& aDes2, TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void SetAndGet(const TInt aIpc, TRequestStatus& aStatus, TDes8& aDes1, const TDesC16& aDes2, TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void SetAndGet(const TInt aIpc, TRequestStatus& aStatus, const TDesC8&, TDes16& aDes2, TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C void SetAndGet(const TInt aIpc, TRequestStatus& aStatus, const TDesC16& aDes1, TDes16& aDes2, TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt Set(const TInt aIpc, const RFile& aFile, TReqPriorityType aType = EIsNotaPriorityRequest) const;

	IMPORT_C TInt CancelReq(const TInt aIpc,const TInt aIpcToCancel) const;

	IMPORT_C TInt CancelSubSession() const;

private:

	RTelSubSessionBase(const RTelSubSessionBase& aTelSubSessionBase);

	RSessionBase* iTelSession;

protected:	

	CPtrHolder* iPtrHolder;

	};

//

//

// RFax

//

//

class RCall;

/**

ETel fax subsession.

Contains the fax client progress information structure.

ETel does include server-side RFax objects, however the 

associated APIs are intended solely for use by ETel's own 

fax client. Consequently, only the TProgress structure is 

considered part of the public API.

@publishedPartner

@released

*/

class RFax : public RTelSubSessionBase

	{

public:

	IMPORT_C RFax();

	IMPORT_C TInt Open(RCall& aCall);

	IMPORT_C void Close();

//

// Read,Write and Wait for Page End

//

	IMPORT_C void Read(TRequestStatus& aStatus,TDes8& aDes);

	IMPORT_C void Write(TRequestStatus& aStatus,const TDesC8& aDes);

	IMPORT_C void WaitForEndOfPage(TRequestStatus& aStatus) const;

	IMPORT_C TInt TerminateFaxSession() const;

//

// Progress Information

//

	struct TProgress

	/** Contains fax progress information.*/

		{

		/** Time of last progress update.*/

		TTime iLastUpdateTime;

		/** ID of remote fax - filled in after connection.*/

		TBuf<20> iAnswerback;

		/** Phase of session.*/

		TFaxPhase iPhase;

		/** Resolution of document.*/

		TFaxResolution iResolution;

		/** Compression method in use.*/

		TFaxCompression iCompression;

		/** Error correction mode. Reserved for future releases.*/

		TInt iECM;

		/** Last or current page being transferred.*/

		TInt iPage;

		/** Last or current line on page.*/

		TInt iLines;

		/** Speed of fax session.*/

		TInt iSpeed;

		};

	IMPORT_C TInt GetProgress(TProgress& aProgress);

private:

	TProgress* iProgressPtr;

	RChunk iChunk;

protected:

	IMPORT_C virtual void ConstructL();

	IMPORT_C virtual void Destruct();

	};

//

//

// RCall

//

//

class RTelServer;

class RPhone;

class RLine;

/**

Call sub-session.

Provides access to the functionality associated with a specific call.

This class is not intended for user derivation. 

@publishedPartner

@released

*/

class RCall : public RTelSubSessionBase

	{

public:

	IMPORT_C RCall();

	IMPORT_C TInt OpenNewCall(RTelServer& aServer,const TDesC& aName,TDes& aNewName);

	IMPORT_C TInt OpenNewCall(RTelServer& aServer,const TDesC& aName);

	IMPORT_C TInt OpenNewCall(RPhone& aPhone,const TDesC& aName,TDes& aNewName);

	IMPORT_C TInt OpenNewCall(RPhone& aPhone,const TDesC& aName);

	IMPORT_C TInt OpenNewCall(RLine& aLine,TDes& aNewName);

	IMPORT_C TInt OpenNewCall(RLine& aLine);

	IMPORT_C TInt OpenExistingCall(RTelServer& aServer,const TDesC& aName);

	IMPORT_C TInt OpenExistingCall(RPhone& aPhone,const TDesC& aName);

	IMPORT_C TInt OpenExistingCall(RLine& aLine,const TDesC& aName);

	IMPORT_C void Close();

//

// Call Status

//

/** Call status flags. */

	enum TStatus

		{

	/** The call status is not known. */

		EStatusUnknown,

	/** The call is idle. */

		EStatusIdle,

	/** The call is dialling. */

		EStatusDialling,

	/** The call is ringing (an incoming, unanswered call). */

		EStatusRinging,

	/** The call is being answered. */

		EStatusAnswering,

	/** The call is connecting (immediate call establishment, without dialling). */

		EStatusConnecting,

	/** The call is connected and active. */

		EStatusConnected,

	/** The call is being terminated. */

		EStatusHangingUp

		};

	IMPORT_C TInt GetStatus(TStatus& aStatus) const;

//

// Call Caps

//

/** Call capability flags. */

	enum TCapsEnum

		{

	/** The call supports data calls. */

		KCapsData=0x00000001,

	/** The call supports fax calls. */

		KCapsFax=0x00000002,

	/** The call supports voice calls. */

		KCapsVoice=0x00000004,

	/** The Dial request is currently a valid action. */

		KCapsDial=0x00000008,

	/** The Connect request is currently a valid action. */

		KCapsConnect=0x00000010,

	/** The Hang Up request is currently a valid action. */

		KCapsHangUp=0x00000020,

	/** The Answer request is currently a valid action. */

		KCapsAnswer=0x00000040,

	/** The Loan Data Port request is currently a valid action. */

		KCapsLoanDataPort=0x00000080,

	/** The Recover Data Port request is currently a valid action. */

		KCapsRecoverDataPort=0x00000100

		};

	struct TCaps

/** Call capability information. */

		{

	/** Call capability flag. Contains a bitmask of values defined in the TCapsEnum 

	enumeration.*/

		TUint iFlags;

		};

	IMPORT_C TInt GetCaps(TCaps& aCaps) const;

	IMPORT_C void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);

	IMPORT_C void NotifyCapsChangeCancel() const;

//

// Bearer Service Information

//

/** Bearer capability flags. */

	enum TBearerCaps

		{

	/** V42bis modem compression protocol. */

		KBearerCapsCompressionV42bis=0x00000001,

	/** MNP5 modem compression protocol. */

		KBearerCapsCompressionMNP5=0x00000002,

	/** No compression supported. */

		KBearerCapsCompressionNone=0x00000004,

	/** LAPM error correction protocol. */

		KBearerCapsProtocolLAPM=0x00000008,

	/** MNP10 mode. */

		KBearerCapsProtocolALT_CELLULAR=0x00000010,

	/** MNP error correction. */

		KBearerCapsProtocolALT=0x00000020,

	/** No protocol information provided. */

		KBearerCapsProtocolNone=0x00000040,

	/** Compression protocol unknown. */

		KBearerCapsCompressionUnknown=0x00000080,

	/** Unable to establish protocol. */

		KBearerCapsProtocolUnknown=0x00000100

		};

/** Bearer speed flags. */

	enum TCallBearerSpeed

		{

	/** Transfer rate of 57600 bps. */

		EBearerData57600,

	/** Transfer rate of 33600 bps. */

		EBearerData33600,

	/** Transfer rate of 31200 bps. */

		EBearerData31200,

	/** Transfer rate of 9200 bps. */

		EBearerData19200,

	/** Transfer rate of 4400 bps. */

		EBearerData14400,

	/** Transfer rate of 12000 bps. */

		EBearerData12000,

	/** Transfer rate of 9600 bps. */

		EBearerData9600,

	/** Transfer rate of 7200 bps. */

		EBearerData7200,

	/** Transfer rate of 4800 bps. */

		EBearerData4800,

	/** Transfer rate of 2400 bps. */

		EBearerData2400,

	/** Transfer rate of 200 bps. */

		EBearerData1200,

	/** V.23 75 bps forward, 1200 bps back */

		EBearerData75_1200,

	/** V.23 1200 bps forward, 75 bps back */

		EBearerData1200_75,

	/** Transfer rate of 300 bps. */

		EBearerData300,

	/** Transfer rate is unknown. */

		EBearerDataUnknown

		};

	struct TBearerService

/** Call bearer information.

@see TCallBearerSpeed */

		{

	/** The bearer capabilities. */

		TUint32 iBearerCaps;

	/** The bearer's speed.

	@see TCallBearerSpeed */

		TCallBearerSpeed iBearerSpeed;

		};

 	IMPORT_C TInt GetBearerServiceInfo(TBearerService& aBearerService) const;

//

// Notifications

//

/** Hook status flags. */

	enum THookStatus

		{

	/** The line is currently off hook. */

		EHookStatusOff,

	/** The line is currently on hook. */

		EHookStatusOn,

	/** The status of the line's hook is currently unknown */

		EHookStatusUnknown

		};

	class TCallInfo

/** Line call capability information.

@see TName 

@publishedPartner

@released

*/

		{

	public:

		IMPORT_C TCallInfo();

	/** The name of a call.

	@see TName */

		TName iCallName;

		TName iLineName;

		THookStatus iHookStatus;

	/** The call status.

	@see RCall::TStatus */

		TStatus iStatus;

		TTimeIntervalSeconds iDuration;

		};

	IMPORT_C TInt GetInfo(TCallInfo& aCallInfo) const;

	IMPORT_C void NotifyHookChange(TRequestStatus& aStatus,THookStatus& aHookStatus);

	IMPORT_C void NotifyHookChangeCancel() const;

	IMPORT_C void NotifyStatusChange(TRequestStatus& aStatus,TStatus& aCallStatus);

	IMPORT_C void NotifyStatusChangeCancel() const;

	IMPORT_C void NotifyCallDurationChange(TRequestStatus& aStatus,TTimeIntervalSeconds& aTime);

	IMPORT_C void NotifyCallDurationChangeCancel() const;

//

// Duration of call

//

	IMPORT_C TInt GetCallDuration(TTimeIntervalSeconds& aTime) const;

//

// Connecting and Disconnecting

//

/** Passes telephone numbers into Dial functions. */

	typedef TDesC TTelNumberC;

	IMPORT_C TInt Dial(const TTelNumberC& aTelNumber) const;

	IMPORT_C TInt Dial(const TDesC8& aCallParams,const TTelNumberC& aTelNumber) const;

	IMPORT_C void Dial(TRequestStatus& aStatus,const TTelNumberC& aTelNumber);

	IMPORT_C void Dial(TRequestStatus& aStatus,const TDesC8& aCallParams,const TTelNumberC& aTelNumber);

	IMPORT_C void DialCancel() const;

	IMPORT_C TInt Connect() const;

	IMPORT_C TInt Connect(const TDesC8& aCallParams) const;

	IMPORT_C void Connect(TRequestStatus& aStatus);

	IMPORT_C void Connect(TRequestStatus& aStatus,const TDesC8& aCallParams);

	IMPORT_C void ConnectCancel() const;

	IMPORT_C TInt AnswerIncomingCall() const;

	IMPORT_C TInt AnswerIncomingCall(const TDesC8& aCallParams) const;

	IMPORT_C void AnswerIncomingCall(TRequestStatus& aStatus);

	IMPORT_C void AnswerIncomingCall(TRequestStatus& aStatus,const TDesC8& aCallParams);

	IMPORT_C void AnswerIncomingCallCancel() const;

	IMPORT_C TInt HangUp() const;

	IMPORT_C void HangUp(TRequestStatus& aStatus) const;

	IMPORT_C void HangUpCancel() const;

//

// Call Data Access

//

	struct  TCommPort

/** Communications port information.

@see TFileName */

		{

	/** The CSY module used by the C32 Communications Server to talk to the serial 

	device.

	@deprecated This has been deprecated as all the information that is needed by the 

	lower layers is now being passed in iPort. 

	@see TFileName */