sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Abstraction representing a UNIX file descriptor
sl@0: // CFileDescBase maintains the simple semantics of
sl@0: // Dup() and Close(), so the final Close() will
sl@0: // delete the object and hence call the destructor.
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef _FDESC_H
sl@0: #define _FDESC_H
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32cons.h>
sl@0: #include <f32file.h>
sl@0: #include <es_sock.h>
sl@0: #include <c32comm.h>
sl@0: 
sl@0: 
sl@0: #include <stddef.h>
sl@0: #include <redircli.h>
sl@0: #include <redircliinternal.h>
sl@0: 
sl@0: // Queuing support for asynchronous requests
sl@0: //
sl@0: class CPosixRequest;
sl@0: class TPosixRequestQueue : public TSglQue<CPosixRequest>
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	inline TPosixRequestQueue();
sl@0: 	};
sl@0: 
sl@0: //  The base class for all flavours of FileDescriptor
sl@0: //
sl@0: class CSerialTimer;
sl@0: class CPosixRequest;
sl@0: class CSocketDesc;
sl@0: NONSHARABLE_CLASS(CFileDescBase) : public CBase
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 
sl@0: 	static CFileDescBase* Open(RSessionBase& aSession, const wchar_t* name, int mode, int perms, TInt& err);
sl@0: 	static CFileDescBase* Socket(RSocketServ& aSs, int family, int style, int protocol, TInt& err);
sl@0: 
sl@0: 	virtual void Read(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	virtual TInt ReadCompletion(TDes8& aDesc, TInt aStatus);
sl@0: 	virtual void ReadCancel();
sl@0: 
sl@0: 	virtual void Write(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	virtual TInt WriteCompletion(TDes8& aDesc, TInt aStatus);
sl@0: 	virtual void WriteCancel();
sl@0: 
sl@0: 	virtual void Ioctl(int aCmd, void* aParam, TRequestStatus& aStatus);
sl@0: 	virtual TInt IoctlCompletion(int aCmd, void* aParam, TInt aStatus);
sl@0: 	virtual void IoctlCancel();
sl@0: 
sl@0: 	virtual void RecvFrom(TDes8& aDesc, TSockAddr& from, int flags, TRequestStatus& aStatus);
sl@0: 	virtual TInt RecvFromCompletion(TInt& aLength, TInt aStatus);
sl@0: 	virtual void RecvFromCancel();
sl@0: 
sl@0: 	virtual void SendTo(TDes8& aDesc, TSockAddr& to, int flags, TRequestStatus& aStatus);
sl@0: 	virtual TInt SendToCompletion(TDes8& aDesc, TInt aStatus);
sl@0: 	virtual void SendToCancel();
sl@0: 
sl@0: 	virtual void Sync(TRequestStatus& aStatus);
sl@0: 	virtual void SyncCancel();
sl@0: 
sl@0: 	virtual void Accept(CSocketDesc*& aNewSocket, TRequestStatus& aStatus, RSocketServ& aSs);
sl@0: 	virtual void AcceptCancel();
sl@0: 
sl@0: 	virtual void Connect(TSockAddr& anAddr,TRequestStatus& aStatus);
sl@0: 	virtual void ConnectCancel();
sl@0: 
sl@0: 	virtual void Shutdown(TUint aHow,TRequestStatus& aStatus);
sl@0: 	virtual void ShutdownCancel();
sl@0: 
sl@0: 	virtual TBool TimedRead() {return EFalse;}	//default implementation
sl@0: 	TInt TimeoutValue() const {return iReadTimeout;}
sl@0: 
sl@0: 	virtual TInt LSeek(int& offset, int whence);
sl@0: 	virtual TInt FStat(struct stat* st);
sl@0: 	virtual TInt Bind(TSockAddr& anAddr);
sl@0: 	virtual TInt Listen(TUint qSize);
sl@0: 	virtual TInt SockName(int anEnd, TSockAddr& anAddr);
sl@0: 	virtual TInt GetSockOpt(TUint anOptionName,TUint anOptionLevel,TDes8& anOption);
sl@0: 	virtual TInt SetSockOpt(TUint anOptionName,TUint anOptionLevel,TDesC8& anOption);
sl@0: 
sl@0: 	static void Cleanup(TAny *aPtr);
sl@0: 	void PushLC();
sl@0: 
sl@0: 	TInt Close();
sl@0: 	virtual void UserClose() {return;}
sl@0: 	inline CFileDescBase* Dup();
sl@0: 	
sl@0: 	enum IOQueues 
sl@0: 		{ 
sl@0: 		IOreadQ=0, IOwriteQ=1, IOioctlQ=2,IOioctlNQ=3,
sl@0: 		IOmaxQ=IOioctlNQ 
sl@0: 		};
sl@0: 
sl@0: 	void AddLast(CPosixRequest& aRequest, IOQueues aQueue);
sl@0: 	void Remove(CPosixRequest& aRequest, IOQueues aQueue);
sl@0: 
sl@0: 	TBool ReadIsTimed;
sl@0: 	TBool ReadWasCancelled;
sl@0: 	CSerialTimer * TimedMessage;
sl@0: 
sl@0: protected:
sl@0: 	CFileDescBase();
sl@0: 	virtual TInt FinalClose();
sl@0: 	static void Complete(TRequestStatus& aStatus, TInt aResult);
sl@0: 	TInt iReadTimeout;
sl@0: 
sl@0: private:
sl@0: 	TInt iDupCount;
sl@0: 	TFixedArray<TPosixRequestQueue,IOmaxQ+1> iQueues;
sl@0: 	};
sl@0: 
sl@0: inline CFileDescBase* CFileDescBase::Dup () 
sl@0: 	{ iDupCount += 1; return this; }
sl@0: 
sl@0: 
sl@0: NONSHARABLE_CLASS(CTtyDesc) : public CFileDescBase
sl@0: /**
sl@0: Abstraction of a teletype device, which will be used for
sl@0: the console.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	inline CTtyDesc(CConsoleBase *c);
sl@0: 	inline CTtyDesc();
sl@0: 	~CTtyDesc();
sl@0: 
sl@0: 	void Read(TDes8& aDesc, TRequestStatus &aStatus);
sl@0: 	void ReadCancel();
sl@0: 	TInt ReadCompletion(TDes8& aDesc, TInt aStatus);
sl@0: 	void Write(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	void Ioctl(int aCmd, void* aParam, TRequestStatus& aStatus);
sl@0: 	TInt IoctlCompletion(int aCmd, void* aParam, TInt aStatus);
sl@0: 
sl@0: protected:
sl@0: 	virtual TInt FinalClose();
sl@0: private:
sl@0: 	void MapCodeAndEcho(TDes8& aDesc, TKeyCode aCode);
sl@0: 	void CheckConsoleCreated();
sl@0: 	void Write(TDes8& aDesc);
sl@0: 	CConsoleBase *iConsole;
sl@0: 	};
sl@0: 
sl@0: inline CTtyDesc::CTtyDesc(CConsoleBase *c) : CFileDescBase(), iConsole(c) {}
sl@0: inline CTtyDesc::CTtyDesc() : CFileDescBase() {}
sl@0: 
sl@0: NONSHARABLE_CLASS(CRedirDesc) : public CFileDescBase
sl@0: /**
sl@0: client-side connection to the redirection server
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	CRedirDesc();
sl@0: 	virtual TInt Connect();
sl@0: 	virtual void Read(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	virtual void Write(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	virtual void Sync(TRequestStatus& aStatus);
sl@0: 	TInt FinalClose();
sl@0: private:
sl@0: 	RRedirSession2 iRedirSession;
sl@0: 	TBool iAttemptedConnection;
sl@0: 	};
sl@0: 
sl@0: NONSHARABLE_CLASS(CFileDesc) : public CFileDescBase
sl@0: /**
sl@0: Abstractions for a plain file and a temporary file
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	CFileDesc();
sl@0: 	~CFileDesc();
sl@0: 
sl@0: 	TInt Open(RFs& aSession, const TDesC& aName, int mode, int perms);
sl@0: 	TInt LSeek(int& offset, int whence);
sl@0: 	void Read(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	void Write(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	TInt FStat(struct stat *st);
sl@0: 	void Sync(TRequestStatus &aStatus);
sl@0: 	TInt IoctlCompletion(int aCmd, void* aParam, TInt aStatus);
sl@0: 
sl@0: 	static void MapStat(struct stat& st, const TTime& aModTime, TUint& aAttr);
sl@0: 
sl@0: protected:
sl@0: 	virtual TInt FinalClose();
sl@0: private:
sl@0: 	TInt FileRead(TUint8* aPtr,TInt aLength);
sl@0: 	TInt FileWrite(TUint8* aPtr,TInt aLength);
sl@0: 	TInt Flush();
sl@0: 	TInt DoSync();
sl@0: 	TInt DoRead(TDes8& aDesc);
sl@0: 	TInt DoWrite(TDes8& aDesc);
sl@0: 	TInt Pos();
sl@0: 	TInt Ext();
sl@0: 	TInt Alloc();
sl@0: private:
sl@0: 	enum {EAlloc,EReading,EWriting};
sl@0: 	enum {EBufferSize = 0x600,EReadAhead = 0x200};
sl@0: protected:
sl@0: 	RFile	iFile;
sl@0: 	TInt16	iDrive;	// for use with stat()
sl@0: private:
sl@0: 	TUint8 iState;
sl@0: 	TUint8* iBuffer;
sl@0: 	TUint8* iPtr;
sl@0: 	TUint8* iEnd;
sl@0: 	TInt iSize;
sl@0: 	TInt iPos;
sl@0: 	TInt iExt;
sl@0: 	};
sl@0: 
sl@0: NONSHARABLE_CLASS(CTempFileDesc) : public CFileDesc
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TInt Open(RFs& aSession, const TDesC& aPath);
sl@0: protected:
sl@0: 	virtual TInt FinalClose();
sl@0: private:
sl@0: 	RFs iSession;
sl@0: 	TFileName iName;
sl@0: 	};
sl@0: 
sl@0: NONSHARABLE_CLASS(CSocketDesc) : public CFileDescBase
sl@0: /**
sl@0: Abstraction for a socket
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	CSocketDesc() : CFileDescBase(), iIoctlBuf(0,0) {}
sl@0: 
sl@0: 	TInt Socket(RSocketServ& aSs, int family, int style, int protocol);
sl@0: 
sl@0: 	TInt LSeek(int& offset, int whence);
sl@0: 	void Read(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	void ReadCancel();
sl@0: 	void Write(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	void WriteCancel();
sl@0: 	TInt FStat(struct stat* st);
sl@0: 	void Sync(TRequestStatus& aStatus);
sl@0: 	void Ioctl(int aCmd, void* aParam, TRequestStatus& aStatus);
sl@0: 	TInt IoctlCompletion(int aCmd, void* aParam, TInt aStatus);
sl@0: 	void IoctlCancel();
sl@0: 
sl@0: 	void RecvFrom(TDes8& aDesc, TSockAddr& from, int flags, TRequestStatus& aStatus);
sl@0: 	TInt RecvFromCompletion(TInt& aLength, TInt aStatus);
sl@0: 	void RecvFromCancel();
sl@0: 	void SendTo(TDes8& aDesc, TSockAddr& to, int flags, TRequestStatus& aStatus);
sl@0: 	void SendToCancel();
sl@0: 
sl@0: 	void Shutdown(TUint aHow,TRequestStatus& aStatus);
sl@0: 	void Accept(CSocketDesc*& aNewSocket, TRequestStatus& aStatus, RSocketServ& aSs);
sl@0: 	void AcceptCancel();
sl@0: 	void Connect(TSockAddr& anAddr,TRequestStatus& aStatus);
sl@0: 	void ConnectCancel();
sl@0: 
sl@0: 	TInt Bind(TSockAddr& anAddr);
sl@0: 	TInt Listen(TUint qSize);
sl@0: 	TInt SockName(int anEnd, TSockAddr& anAddr);
sl@0: 	TInt GetSockOpt(TUint anOptionName,TUint anOptionLevel,TDes8& anOption);
sl@0: 	TInt SetSockOpt(TUint anOptionName,TUint anOptionLevel,TDesC8& anOption);
sl@0: 
sl@0: protected:
sl@0: 	TInt FinalClose();
sl@0: private:
sl@0: 	inline TInt isStream() const;
sl@0: 
sl@0: 	RSocket iSocket;
sl@0: 	TInt iStyle;
sl@0: 	TSockXfrLength iLength;
sl@0: 	TPtr8 iIoctlBuf;
sl@0: 	};
sl@0: 
sl@0: class TUSockAddr : public TSockAddr
sl@0: /**
sl@0: Utility class for converting struct sockaddr to and from EPOC32 TSockAddr
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TUSockAddr() : TSockAddr() {}
sl@0: 
sl@0: 	TUSockAddr(TAny* addr);			// constructor form of Prepare
sl@0: 	TUSockAddr(TAny* addr, TUint len);	// constructor form of Set
sl@0: 
sl@0: 	void Prepare(TAny* addr);
sl@0: 	void Set(TAny* addr, TUint len);
sl@0: 	void Get(TAny* addr, unsigned long* len);
sl@0: 	};
sl@0: 
sl@0: NONSHARABLE_CLASS(CSerialTimer) : public CTimer
sl@0: /**
sl@0: the serial timer class
sl@0: @internalComponent
sl@0: */
sl@0:   	{
sl@0: public:
sl@0: 	CSerialTimer();
sl@0: 	~CSerialTimer();
sl@0: 
sl@0: public:
sl@0: 	static CSerialTimer* NewLC(CFileDescBase*);
sl@0: 	static CSerialTimer* NewL(CFileDescBase*);
sl@0: 
sl@0: public:
sl@0: 	void ConstructL(CFileDescBase*);
sl@0: 	void IssueRequest(); 
sl@0: 	void DoCancel();
sl@0: 	void RunL();
sl@0: 
sl@0: private:
sl@0: 	CFileDescBase* iFile;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class CNotifier;
sl@0: 
sl@0: NONSHARABLE_CLASS(CSerialDesc) : public CFileDescBase
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	friend class CNotifier;
sl@0: 
sl@0: 	public:
sl@0: 	CSerialDesc() : CFileDescBase(), iReadThreshold(-1), iRequestedSignals(0),
sl@0: 					iNotifyStatus(NULL), iNotifyParamPtr(NULL) {}
sl@0: 
sl@0: 	TInt Open(RCommServ& aSession, const wchar_t* name, int mode, int perms);
sl@0: 	TInt FinalClose();
sl@0: 
sl@0: 	void Read(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	void ReadCancel();
sl@0: 	
sl@0: 	TInt& TimeoutValue() const;
sl@0: 	void Write(TDes8& aDesc, TRequestStatus& aStatus);
sl@0: 	
sl@0: 	void Ioctl(int aCmd, void* aParam, TRequestStatus& aStatus);
sl@0: 	TInt IoctlCompletion(int aCmd, void* aParam, TInt aStatus);
sl@0: 	void IoctlCancel();
sl@0: 
sl@0: 	TBool TimedRead();
sl@0: 	void UserClose();
sl@0: 
sl@0: protected:
sl@0: 
sl@0: private:
sl@0: 
sl@0: 	void NotifyDataAvailable(TRequestStatus& aStatus);
sl@0: 	void NotifyOutputEmpty(TRequestStatus& aStatus);
sl@0: 	void NotifyBreak(TRequestStatus& aStatus);
sl@0: 	void NotifyWriteErrors(TRequestStatus& aStatus, TUint* aRequestParams, TUint aSignalsMask);
sl@0: 	void NotifySignalChange(TRequestStatus& iStatus, TUint& aRequestParam, TUint aSignalsMask);
sl@0: 	void NotifyDataAvailableCancel();
sl@0: 	void NotifyOutputEmptyCancel();
sl@0: 	void NotifyBreakCancel();
sl@0: 	void NotifyWriteErrorsCancel();
sl@0: 	void NotifySignalChangeCancel();
sl@0: 	void Notify(TInt aVal);		//complete the notify request
sl@0: 	TInt NotifiesSupported();	//return the notifies supported at the moment
sl@0: 	TBool RequestedNotifiesSupported(TInt aRequested);	//see if the notifies requested are supported
sl@0: 	void CancelNotifiers(const CNotifier* aCompletedNotifier);	//cancel them all apart from the passed one
sl@0: 	TUint Signals();
sl@0: 
sl@0: 	TInt ReadCompletion (TDes8& aBuf, TInt aStatus);	
sl@0: 
sl@0: 	TInt iReadThreshold;
sl@0: 	RComm iCommPort;
sl@0: 
sl@0: 	TInt iRequestedSignals;
sl@0: 	TRequestStatus* iNotifyStatus;
sl@0: 	TUint* iNotifyParamPtr;
sl@0: 	TUint* iRequestDataPtr;
sl@0: 
sl@0: 	CNotifier* iDataAvailableNotifier;
sl@0: 	CNotifier* iOutputEmptyNotifier;
sl@0: 	CNotifier* iBreakNotifier;
sl@0: 	CNotifier* iErrorsNotifier;
sl@0: 	CNotifier* iSignalsNotifier;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: 
sl@0: #endif // !_FDESC_H