CPort Class Reference

class CPort : public CObject

Base class for implementations of serial protocol module ports. Its functions are called by the comms server in response to client calls to RComm.

The class implements CObject to obtain reference counting behaviour. The reference count is incremented when a port is first created, and, for ports in shared mode, on every later opening.

CPort is an abstract class which defines many pure virtual functions which derived classes must implement. Most of these pure virtual functions correspond to the client interface of the RComm class.

Created when the first client does an Open request passing its name. Destroyed only when it deletes itself (following a call to Destruct).

Inherits from

CPort
- CObject
  - CBase

Nested Classes and Structures

CPort::CExtra

Public Member Functions
	CPort()
	~CPort()
TBool	AreAnyPending()
void	Break(TInt)
void	BreakCancel()
IMPORT_C void	BreakCompleted(TInt)
IMPORT_C void	BreakNotifyCompleted(TInt)
IMPORT_C void	Close()
void	CommBreak(const RMessage2 &, CCommSession *)
void	CommBreakCancel(TInt, CCommSession *)
void	CommCancel(TInt, CCommSession *)
void	CommCaps(const RMessage2 &, CCommSession &)
void	CommConfig(const RMessage2 &, CCommSession &)
void	CommDebugState(const RMessage2 &, CCommSession &)
void	CommGetFlowControlStatus(const RMessage2 &, CCommSession *)
void	CommGetRole(const RMessage2 &, CCommSession *)
void	CommGetServerConfig(const RMessage2 &, CCommSession &)
void	CommNotifyBreak(const RMessage2 &, CCommSession *)
void	CommNotifyBreakCancel(TInt, CCommSession *)
void	CommNotifyConfigChange(const RMessage2 &, CCommSession *)
void	CommNotifyConfigChangeCancel(TInt, CCommSession *)
void	CommNotifyDataAvailable(const RMessage2 &, CCommSession *)
void	CommNotifyDataAvailableCancel(TInt, CCommSession *)
void	CommNotifyFlowControlChange(const RMessage2 &, CCommSession *)
void	CommNotifyFlowControlChangeCancel(TInt, CCommSession *)
void	CommNotifyOutputEmpty(const RMessage2 &, CCommSession *)
void	CommNotifyOutputEmptyCancel(TInt, CCommSession *)
void	CommNotifySignalChange(const RMessage2 &, CCommSession *)
void	CommNotifySignalChangeCancel(TInt, CCommSession *)
void	CommQueryReceiveBuffer(const RMessage2 &, CCommSession &)
void	CommRead(const RMessage2 &, CCommSession *)
void	CommReadCancel(TInt, CCommSession *)
void	CommReceiveBufferLength(const RMessage2 &, CCommSession &)
void	CommResetBuffers(const RMessage2 &, CCommSession &)
void	CommSetAccess(const RMessage2 &, CCommSession &)
void	CommSetAccessCancel(TInt, CCommSession *)
void	CommSetConfig(const RMessage2 &, CCommSession &)
void	CommSetReceiveBufferLength(const RMessage2 &, CCommSession &)
void	CommSetServerConfig(const RMessage2 &, CCommSession &)
void	CommSetSignalsToMark(const RMessage2 &, CCommSession &)
void	CommSetSignalsToSpace(const RMessage2 &, CCommSession &)
void	CommSignals(const RMessage2 &, CCommSession &)
void	CommWrite(const RMessage2 &, CCommSession *)
void	CommWriteCancel(TInt, CCommSession *)
IMPORT_C void	ConfigChangeCompleted(const TDesC8 &, TInt)
void	Destruct()
IMPORT_C void	FlowControlChangeCompleted(const TFlowControl &, TInt)
void	FreeMemory()
void	FreeSession(CCommSession *)
TInt	GetCaps(TDes8 &)
TInt	GetConfig(TDes8 &)
TInt	GetFlowControlStatus(TFlowControl &)
TInt	GetReceiveBufferLength(TInt &)
TInt	GetRole(TCommRole &)
TInt	GetServerConfig(TDes8 &)
TInt	GetSignals(TUint &)
IMPORT_C TInt	IPCRead(const TAny *, TDes8 &, TInt)
IMPORT_C TInt	IPCWrite(const TAny *, const TDesC8 &, TInt)
void	InitL(TDesC8 &)
TBool	IsBlockedSetAccessWaiting(CCommSession &)
void	NotifyBreak()
void	NotifyBreakCancel()
void	NotifyConfigChange()
void	NotifyConfigChangeCancel()
void	NotifyDataAvailable()
void	NotifyDataAvailableCancel()
IMPORT_C void	NotifyDataAvailableCompleted(TInt)
void	NotifyFlowControlChange()
void	NotifyFlowControlChangeCancel()
void	NotifyOutputEmpty()
void	NotifyOutputEmptyCancel()
IMPORT_C void	NotifyOutputEmptyCompleted(TInt)
void	NotifySignalChange(TUint)
void	NotifySignalChangeCancel()
TInt	QueryReceiveBuffer(TInt &)
void	ReadCancel()
IMPORT_C void	ReadCompleted(TInt)
TInt	ReadTimerExpiredHandler(TAny *)
void	ResetBuffers(TUint)
TBool	SessionHasBeenPreempted(CCommSession *)
TBool	SessionIsAwaitingOpen(CCommSession *)
TInt	SetConfig(const TDesC8 &)
TInt	SetReceiveBufferLength(TInt)
TInt	SetRole(TCommRole)
TInt	SetServerConfig(const TDesC8 &)
TInt	SetSignalsToMark(TUint)
TInt	SetSignalsToSpace(TUint)
IMPORT_C void	SignalChangeCompleted(const TUint &, TInt)
void	StartRead(const TAny *, TInt)
void	StartWrite(const TAny *, TInt)
TBool	TakeOwnershipForBreak(const RMessage2 &, CCommSession *)
TBool	TakeOwnershipForBreaking(const RMessage2 &, CCommSession *)
TBool	TakeOwnershipForConfig(const RMessage2 &, CCommSession *)
TBool	TakeOwnershipForFlowControl(const RMessage2 &, CCommSession *)
TBool	TakeOwnershipForNotifyDataAvailable(const RMessage2 &, CCommSession *)
TBool	TakeOwnershipForNotifyOutputEmpty(const RMessage2 &, CCommSession *)
TBool	TakeOwnershipForReading(const RMessage2 &, CCommSession *)
TBool	TakeOwnershipForSignals(const RMessage2 &, CCommSession *)
TBool	TakeOwnershipForWriting(const RMessage2 &, CCommSession *)
void	WriteCancel()
IMPORT_C void	WriteCompleted(TInt)
TInt	WriteTimerExpiredHandler(TAny *)

Private Member Functions
IMPORT_C void	CPort_Reserved1()
void	DoOpenL(CCommSession *, TInternalCommAccess, TCommRole, TBool)
void	DoPreemption()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CObject::AccessCount()const
	CObject::CObject()
	CObject::Dec()
	CObject::Extension_(TUint,TAny &,TAny )
	CObject::FullName()const
	CObject::Inc()
	CObject::Name()const
	CObject::Open()
	CObject::Owner()const
	CObject::SetName(const TDesC *)
	CObject::SetNameL(const TDesC *)
	CObject::SetOwner(CObject *)
	CObject::UniqueID()const
	CObject::~CObject()

Public Member Type Definitions
typedef	TCommAccess TAccess

Private Attributes
RMessagePtr2	iBlockedBreak
RMessagePtr2	iBlockedBreakNotify
RMessagePtr2	iBlockedConfigChange
TInt	iBlockedConfigChangeDummyPadding
RMessagePtr2	iBlockedFlowControlChange
TInt	iBlockedFlowControlChangeDummyPadding
RMessagePtr2	iBlockedNotifyDataAvailable
RMessagePtr2	iBlockedNotifyOutputEmpty
RMessagePtr2	iBlockedRead
RMessagePtr2	iBlockedSignalChange
TInt	iBlockedSignalChangeDummyPadding
RMessagePtr2	iBlockedWrite
CCommSession *	iBreakNotifyOwner
TInt	iBreakNotifyOwnerHandle
TInt	iBreakOwnerHandle
TAny *	iCPort_Reserved
CCommSession *	iConfigOwner
TInt	iConfigOwnerHandle
CExtra *	iExtra
CCommSession *	iFlowControlOwner
TInt	iFlowControlOwnerHandle
TInternalCommAccess	iMode
CCommSession *	iNotifyDataAvailableOwner
TInt	iNotifyDataAvailableOwnerHandle
CCommSession *	iNotifyOutputEmptyOwner
TInt	iNotifyOutputEmptyOwnerHandle
CPortManager *	iPortManager
CCommSession *	iReadOwner
TInt	iReadOwnerHandle
TDeltaTimerEntry	iReadTimer
TBool	iReadTimerPending
CCommSession *	iSignalOwner
TInt	iSignalOwnerHandle
CCommSession *	iWriteOwner
TInt	iWriteOwnerHandle
TDeltaTimerEntry	iWriteTimer
TBool	iWriteTimerPending

Constructor & Destructor Documentation

CPort()

IMPORT_C

CPort

(

)

~CPort()

IMPORT_C

~CPort

(

)

[virtual]

Member Functions Documentation

AreAnyPending()

TBool

AreAnyPending

(

)

Break(TInt)

void

Break

(

TInt

aTime

)

[pure virtual]

Specifies the protocol for setting a break condition at the port. It is called by the comms server in response to a RComm::Break() request from the client.

When the break is complete, the function should call BreakCompleted().

Parameters

TInt aTime

Time period to break for in microseconds

BreakCancel()

void

BreakCancel

(

)

[pure virtual]

Specifies the protocol for cancelling a break request. It is called by the comms server in response to a RComm::BreakCancel() request from the client.

The implementation should abort any processing which was taking place as a result of the break request. Do not call BreakCompleted().

BreakCompleted(TInt)

IMPORT_C void

BreakCompleted

(

TInt

anError

)

Parameters

TInt anError

BreakNotifyCompleted(TInt)

IMPORT_C void

BreakNotifyCompleted

(

TInt

anError

)

Parameters

TInt anError

CPort_Reserved1()

IMPORT_C void

CPort_Reserved1

(

)

[private, virtual]

Close()

IMPORT_C void

(

)

[virtual]

CommBreak(const RMessage2 &, CCommSession *)

void	CommBreak	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommBreakCancel(TInt, CCommSession *)

void	CommBreakCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommCancel(TInt, CCommSession *)

void	CommCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommCaps(const RMessage2 &, CCommSession &)

void	CommCaps	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommConfig(const RMessage2 &, CCommSession &)

void	CommConfig	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)	const

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommDebugState(const RMessage2 &, CCommSession &)

void	CommDebugState	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommGetFlowControlStatus(const RMessage2 &, CCommSession *)

void	CommGetFlowControlStatus	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommGetRole(const RMessage2 &, CCommSession *)

void	CommGetRole	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommGetServerConfig(const RMessage2 &, CCommSession &)

void	CommGetServerConfig	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommNotifyBreak(const RMessage2 &, CCommSession *)

void	CommNotifyBreak	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommNotifyBreakCancel(TInt, CCommSession *)

void	CommNotifyBreakCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommNotifyConfigChange(const RMessage2 &, CCommSession *)

void	CommNotifyConfigChange	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommNotifyConfigChangeCancel(TInt, CCommSession *)

void	CommNotifyConfigChangeCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommNotifyDataAvailable(const RMessage2 &, CCommSession *)

void	CommNotifyDataAvailable	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommNotifyDataAvailableCancel(TInt, CCommSession *)

void	CommNotifyDataAvailableCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommNotifyFlowControlChange(const RMessage2 &, CCommSession *)

void	CommNotifyFlowControlChange	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommNotifyFlowControlChangeCancel(TInt, CCommSession *)

void	CommNotifyFlowControlChangeCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommNotifyOutputEmpty(const RMessage2 &, CCommSession *)

void	CommNotifyOutputEmpty	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommNotifyOutputEmptyCancel(TInt, CCommSession *)

void	CommNotifyOutputEmptyCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommNotifySignalChange(const RMessage2 &, CCommSession *)

void	CommNotifySignalChange	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommNotifySignalChangeCancel(TInt, CCommSession *)

void	CommNotifySignalChangeCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommQueryReceiveBuffer(const RMessage2 &, CCommSession &)

void	CommQueryReceiveBuffer	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)	const

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommRead(const RMessage2 &, CCommSession *)

void	CommRead	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommReadCancel(TInt, CCommSession *)

void	CommReadCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommReceiveBufferLength(const RMessage2 &, CCommSession &)

void	CommReceiveBufferLength	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)	const

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommResetBuffers(const RMessage2 &, CCommSession &)

void	CommResetBuffers	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommSetAccess(const RMessage2 &, CCommSession &)

void	CommSetAccess	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommSetAccessCancel(TInt, CCommSession *)

void	CommSetAccessCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

CommSetConfig(const RMessage2 &, CCommSession &)

void	CommSetConfig	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommSetReceiveBufferLength(const RMessage2 &, CCommSession &)

void	CommSetReceiveBufferLength	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommSetServerConfig(const RMessage2 &, CCommSession &)

void	CommSetServerConfig	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommSetSignalsToMark(const RMessage2 &, CCommSession &)

void	CommSetSignalsToMark	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommSetSignalsToSpace(const RMessage2 &, CCommSession &)

void	CommSetSignalsToSpace	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommSignals(const RMessage2 &, CCommSession &)

void	CommSignals	(	const RMessage2 &	aMessage,
			CCommSession &	aSession
		)

Parameters

const RMessage2 & aMessage
CCommSession & aSession

CommWrite(const RMessage2 &, CCommSession *)

void	CommWrite	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

CommWriteCancel(TInt, CCommSession *)

void	CommWriteCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Parameters

TInt aHandle
CCommSession * aClient

ConfigChangeCompleted(const TDesC8 &, TInt)

IMPORT_C void	ConfigChangeCompleted	(	const TDesC8 &	aNewConfig,
			TInt	anError
		)

Parameters

const TDesC8 & aNewConfig
TInt anError

Destruct()

void

Destruct

(

)

[pure virtual]

Specifies the protocol for port destruction. It is called by the comms server when the last client-side reference to a CPort object has been closed and the CPort must be deleted. The comms server will not delete a CPort other than by calling Destruct().

The implementation should perform any asynchronous shutdown operations on its own resources and, when these operations have completed, should delete this.

DoOpenL(CCommSession *, TInternalCommAccess, TCommRole, TBool)

void	DoOpenL	(	CCommSession *	aSession,
			TInternalCommAccess	aMode,
			TCommRole	aRole,
			TBool	aIsNew
		)	[private]

Parameters

CCommSession * aSession
TInternalCommAccess aMode
TCommRole aRole
TBool aIsNew

DoPreemption()

void

DoPreemption

(

)

[private]

FlowControlChangeCompleted(const TFlowControl &, TInt)

IMPORT_C void	FlowControlChangeCompleted	(	const TFlowControl &	aFlowControl,
			TInt	anError
		)

Parameters

const TFlowControl & aFlowControl
TInt anError

FreeMemory()

void

FreeMemory

(

)

[virtual]

FreeSession(CCommSession *)

void

FreeSession

(

CCommSession *

aSession

)

Parameters

CCommSession * aSession

GetCaps(TDes8 &)

TInt

GetCaps

(

TDes8 &

aPackage

)

[pure virtual]

Specifies a protocol for getting the port capabilities. It is called by the comms server in response to a RComm::Caps() request from the client.

A system error code

Parameters

TDes8 & aPackage

A TCommCaps package buffer that, on return, holds the port capabilities

GetConfig(TDes8 &)

TInt

GetConfig

(

TDes8 &

aPackage

)

const [pure virtual]

Specifies a protocol for getting the current configuration of the serial port. It is called by the comms server in response to a RComm::GetConfig() request from the client.

A system wide error code

Parameters

TDes8 & aPackage

A packaged TCommConfig buffer, set on return to the current configuration of the serial port

GetFlowControlStatus(TFlowControl &)

TInt

GetFlowControlStatus

(

TFlowControl &

aFlowControl

)

[pure virtual]

Gets flow control status. It is called by the comms server in response to a RComm::SetMode() request from the client.

A system-wide error code

Parameters

TFlowControl & aFlowControl

Flow control status to return to the client

GetReceiveBufferLength(TInt &)

TInt

GetReceiveBufferLength

(

TInt &

aLength

)

const [pure virtual]

Specifies a protocol for requesting the size of the serial port buffers. It is called by the comms server in response to a RComm::ReceiveBufferLength() request from the client.

A system error code

Parameters

TInt & aLength

The current size of the serial port buffers in bytes

GetRole(TCommRole &)

TInt

GetRole

(

TCommRole &

aRole

)

[pure virtual]

Gets DCE/DTE role. It is called by the comms server in response to a RComm::GetRole() request from the client.

A system-wide error code

Parameters

TCommRole & aRole

On return, DCE/DTE role to return to the client

GetServerConfig(TDes8 &)

TInt

GetServerConfig

(

TDes8 &

aPackage

)

[pure virtual]

Specifies a protocol for getting the buffer mode. It is called by the comms server in response to a RComm::Mode() request from the client.

A system error code

Parameters

TDes8 & aPackage

A TCommServerConfig package buffer that, on return, holds the current buffer mode settings

GetSignals(TUint &)

TInt

GetSignals

(

TUint &

aSignals

)

[pure virtual]

Specifies a protocol for getting the status of the serial port control lines. It is called by the comms server in response to a RComm::GetSignals() request from the client.

A system error code

Parameters

TUint & aSignals

An integer with the bits set to reflect the status of the handshaking lines.

IPCRead(const TAny *, TDes8 &, TInt)

IMPORT_C TInt	IPCRead	(	const TAny *	aPtr,
			TDes8 &	aDes,
			TInt	aOffset = 0
		)	const

Parameters

const TAny * aPtr
TDes8 & aDes
TInt aOffset = 0

IPCWrite(const TAny *, const TDesC8 &, TInt)

IMPORT_C TInt	IPCWrite	(	const TAny *	aPtr,
			const TDesC8 &	aDes,
			TInt	aOffset = 0
		)	const

Parameters

const TAny * aPtr
const TDesC8 & aDes
TInt aOffset = 0

InitL(TDesC8 &)

void

InitL

(

TDesC8 &

aName

)

Parameters

TDesC8 & aName

IsBlockedSetAccessWaiting(CCommSession &)

TBool

IsBlockedSetAccessWaiting

(

CCommSession &

aClient

)

Parameters

CCommSession & aClient

NotifyBreak()

void

NotifyBreak

(

)

[pure virtual]

Specifies the protocol for setting a "break" notification. It is called by the comms server in response to a RComm::NotifyBreak() request from the client.

NotifyBreakCancel()

void

NotifyBreakCancel

(

)

[pure virtual]

Specifies the protocol for cancelling a "break" notification. It is called by the comms server in response to a RComm::NotifyBreakCancel() request from the client.

NotifyConfigChange()

void

NotifyConfigChange

(

)

[pure virtual]

Specifies the protocol for setting a "configuration change" notification. It is called by the comms server in response to a RComm::NotifyConfigChange() request from the client.

NotifyConfigChangeCancel()

void

NotifyConfigChangeCancel

(

)

[pure virtual]

Specifies the protocol for cancelling a "configuration change" notification. It is called by the comms server in response to a RComm::NotifyConfigChangeCancel() request from the client.

NotifyDataAvailable()

void

NotifyDataAvailable

(

)

[pure virtual]

Specifies the protocol for setting a "data available" notification. It is called

by the comms server in response to a RComm::NotifyDataAvailable() request from the client.

NotifyDataAvailableCancel()

void

NotifyDataAvailableCancel

(

)

[pure virtual]

Specifies the protocol for cancelling a "data available" notification. It is called by the comms server in response to a RComm::NotifyDataAvailableCancel() request from the client.

NotifyDataAvailableCompleted(TInt)

IMPORT_C void

NotifyDataAvailableCompleted

(

TInt

anError

)

Parameters

TInt anError

NotifyFlowControlChange()

void

NotifyFlowControlChange

(

)

[pure virtual]

Specifies the protocol for setting a "flow control change" notification. It is called by the comms server in response to a RComm::NotifyFlowControlChange() request from the client.

NotifyFlowControlChangeCancel()

void

NotifyFlowControlChangeCancel

(

)

[pure virtual]

Specifies the protocol for cancelling a "flow control change" notification. It is called by the comms server in response to a RComm::NotifyFlowControlChangeCancel() request from the client.

NotifyOutputEmpty()

void

NotifyOutputEmpty

(

)

[pure virtual]

Specifies the protocol for setting a transmit buffer empty notification. It is called by the comms server in response to a RComm::NotifyOutputEmpty() request from the client.

NotifyOutputEmptyCancel()

void

NotifyOutputEmptyCancel

(

)

[pure virtual]

Specifies the protocol for cancelling a transmit buffer empty notification. It is called by the comms server in response to a RComm::NotifyOutputEmptyCancel() request from the client.

NotifyOutputEmptyCompleted(TInt)

IMPORT_C void

NotifyOutputEmptyCompleted

(

TInt

anError

)

Parameters

TInt anError

NotifySignalChange(TUint)

void

NotifySignalChange

(

TUint

aSignalMask

)

[pure virtual]

Specifies the protocol for setting a "signal change" notification. It is called by the comms server in response to a RComm::NotifySignalChange() request from the client.

Parameters

TUint aSignalMask

Signal mask passed by client

NotifySignalChangeCancel()

void

NotifySignalChangeCancel

(

)

[pure virtual]

Specifies the protocol for cancelling a "signal change" notification. It is called by the comms server in response to a RComm::NotifySignalChangeCancel() request from the client.

QueryReceiveBuffer(TInt &)

TInt

QueryReceiveBuffer

(

TInt &

aLength

)

const [pure virtual]

Specifies a protocol for requesting the number of bytes that are currently waiting in the port's receive buffer. It is called by the comms server in response to a RComm::QueryReceiveBuffer() request from the client.

A system wide error code.

Parameters

TInt & aLength

On return, the number of bytes currently waiting to be read from the receive buffer.

ReadCancel()

void

ReadCancel

(

)

[pure virtual]

Specifies the protocol for cancelling reading from the port. It is called by the comms server in response to a RComm::ReadCancel() request from the client or when the iReadTimer timer expires.

The implementation should abort any processing which was taking place as a result of the read request. Do not call ReadCompleted().

ReadCompleted(TInt)

IMPORT_C void

ReadCompleted

(

TInt

anError

)

Parameters

TInt anError

ReadTimerExpiredHandler(TAny *)

TInt

ReadTimerExpiredHandler

(

TAny *

aPtr

)

[static]

Parameters

TAny * aPtr

ResetBuffers(TUint)

void

ResetBuffers

(

TUint

aFlags

)

[pure virtual]

Specifies a protocol for resetting the receive and/or transmit buffers to zero length. It is called by the comms server in response to a RComm::ResetBuffers() request from the client.

Parameters

TUint aFlags

Bitmask of the following flags: KCommResetRx to reset the receive buffer; KCommResetTx to reset the transmit buffer

SessionHasBeenPreempted(CCommSession *)

TBool

SessionHasBeenPreempted

(

CCommSession *

aSession

)

Parameters

CCommSession * aSession

SessionIsAwaitingOpen(CCommSession *)

TBool

SessionIsAwaitingOpen

(

CCommSession *

aSession

)

Parameters

CCommSession * aSession

SetConfig(const TDesC8 &)

TInt

SetConfig

(

const TDesC8 &

aPackage

)

[pure virtual]

Specifies a protocol for setting the configuration of the port. It is called by the comms server in response to a RComm::SetConfig() request from the client.

A system error code

Parameters

const TDesC8 & aPackage

A packaged TCommConfig buffer holding the new configuration values

SetReceiveBufferLength(TInt)

TInt

SetReceiveBufferLength

(

TInt

aLength

)

[pure virtual]

Specifies a protocol for setting the size of the serial port buffers. It is called by the comms server in response to a RComm::SetReceiveBufferLength() request from the client.

A system error code

Parameters

TInt aLength

Requested size of the serial port buffers in bytes

SetRole(TCommRole)

TInt

SetRole

(

TCommRole

aRole

)

[pure virtual]

Sets DCE/DTE role. It is called by the comms server in response to a RComm::Open() request from the client.

A system-wide error code

Parameters

TCommRole aRole

DCE/DTE role

SetServerConfig(const TDesC8 &)

TInt

SetServerConfig

(

const TDesC8 &

aPackage

)

[pure virtual]

Specifies a protocol for setting the buffer mode. It is called by the comms server in response to a RComm::SetMode() request from the client.

A system-wide error code

Parameters

const TDesC8 & aPackage

A TCommServerConfig package buffer holding the mode settings

SetSignalsToMark(TUint)

TInt

SetSignalsToMark

(

TUint

aSignals

)

[pure virtual]

Specifies a protocol for setting serial port control lines. It is called by the comms server in response to a RComm::SetSignals() request from the client.

A system error code

Parameters

TUint aSignals

A bitmask of the handshaking lines to set

SetSignalsToSpace(TUint)

TInt

SetSignalsToSpace

(

TUint

aSignals

)

[pure virtual]

Specifies a protocol for clearing serial port control lines. It is called by the comms server in response to a RComm::SetSignals() request from the client.

A system error code

Parameters

TUint aSignals

A bitmask of the handshaking lines to clear

SignalChangeCompleted(const TUint &, TInt)

IMPORT_C void	SignalChangeCompleted	(	const TUint &	aSignals,
			TInt	anError
		)

Parameters

const TUint & aSignals
TInt anError

StartRead(const TAny *, TInt)

void	StartRead	(	const TAny *	aClientBuffer,
			TInt	aLength
		)	[pure virtual]

Specifies the protocol for reading from the port. It is called by the comms server in response to a RComm::Read() or RComm::ReadOneOrMore() request from the client.

A negative value for aLength is used to flag that the read request was from RComm::ReadOneOrMore() rather than from RComm::Read(). The maximum length of data to be read is the absolute value of aLength.

The implementation should use IPCWrite() to write the data to the client's buffer. When all the data has been read, the function should call ReadCompleted().

Parameters

const TAny * aClientBuffer	Pointer into client address space to the descriptor containing the client's buffer
TInt aLength	The amount of data to be read

StartWrite(const TAny *, TInt)

void	StartWrite	(	const TAny *	aClientBuffer,
			TInt	aLength
		)	[pure virtual]

Specifies the protocol for writing to the port. It is called by the comms server in response to a RComm::Write() request from the client.

The implementation should use IPCRead() to get the data to write from the client's buffer. When all the data has been written, the function should call WriteCompleted().

Parameters

const TAny * aClientBuffer	Pointer into client address space to the descriptor containing the client's buffer
TInt aLength	The amount of data to be written

TakeOwnershipForBreak(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForBreak	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

TakeOwnershipForBreaking(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForBreaking	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

TakeOwnershipForConfig(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForConfig	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

TakeOwnershipForFlowControl(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForFlowControl	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

TakeOwnershipForNotifyDataAvailable(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForNotifyDataAvailable	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

TakeOwnershipForNotifyOutputEmpty(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForNotifyOutputEmpty	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

TakeOwnershipForReading(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForReading	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

TakeOwnershipForSignals(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForSignals	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

TakeOwnershipForWriting(const RMessage2 &, CCommSession *)

TBool	TakeOwnershipForWriting	(	const RMessage2 &	aMessage,
			CCommSession *	aClient
		)

Parameters

const RMessage2 & aMessage
CCommSession * aClient

WriteCancel()

void

WriteCancel

(

)

[pure virtual]

Specifies the protocol for cancelling writing to the port. It is called by the comms server in response to a RComm::WriteCancel() request from the client.

The implementation should abort any processing which was taking place as a result of the write request. Do not call WriteCompleted().

WriteCompleted(TInt)

IMPORT_C void

WriteCompleted

(

TInt

anError

)

Parameters

TInt anError

WriteTimerExpiredHandler(TAny *)

TInt

WriteTimerExpiredHandler

(

TAny *

aPtr

)

[static]

Parameters

TAny * aPtr

Member Type Definitions Documentation

Typedef TAccess

typedef TCommAccess

TAccess

Member Data Documentation

RMessagePtr2 iBlockedBreak

RMessagePtr2

iBlockedBreak

[private]

RMessagePtr2 iBlockedBreakNotify

RMessagePtr2

iBlockedBreakNotify

[private]

RMessagePtr2 iBlockedConfigChange

RMessagePtr2

iBlockedConfigChange

[private]

The encapsulated message

TInt iBlockedConfigChangeDummyPadding

TInt

iBlockedConfigChangeDummyPadding

[private]

Private padding to preserve BC with earlier versions

RMessagePtr2 iBlockedFlowControlChange

RMessagePtr2

iBlockedFlowControlChange

[private]

The encapsulated message

TInt iBlockedFlowControlChangeDummyPadding

TInt

iBlockedFlowControlChangeDummyPadding

[private]

Private padding to preserve BC with earlier versions

RMessagePtr2 iBlockedNotifyDataAvailable

RMessagePtr2

iBlockedNotifyDataAvailable

[private]

RMessagePtr2 iBlockedNotifyOutputEmpty

RMessagePtr2

iBlockedNotifyOutputEmpty

[private]

RMessagePtr2 iBlockedRead

RMessagePtr2

iBlockedRead

[private]

RMessagePtr2 iBlockedSignalChange

RMessagePtr2

iBlockedSignalChange

[private]

The encapsulated message

TInt iBlockedSignalChangeDummyPadding

TInt

iBlockedSignalChangeDummyPadding

[private]

Private padding to preserve BC with earlier versions

RMessagePtr2 iBlockedWrite

RMessagePtr2

iBlockedWrite

[private]

CCommSession * iBreakNotifyOwner

CCommSession *

iBreakNotifyOwner

[private]

TInt iBreakNotifyOwnerHandle

TInt

iBreakNotifyOwnerHandle

[private]

TInt iBreakOwnerHandle

TInt

iBreakOwnerHandle

[private]

TAny * iCPort_Reserved

TAny *

iCPort_Reserved

[private]

CCommSession * iConfigOwner

CCommSession *

iConfigOwner

[private]

TInt iConfigOwnerHandle

TInt

iConfigOwnerHandle

[private]

CExtra * iExtra

CExtra *

iExtra

[private]

CCommSession * iFlowControlOwner

CCommSession *

iFlowControlOwner

[private]

TInt iFlowControlOwnerHandle

TInt

iFlowControlOwnerHandle

[private]

TInternalCommAccess iMode

TInternalCommAccess

iMode

[private]

CCommSession * iNotifyDataAvailableOwner

CCommSession *

iNotifyDataAvailableOwner

[private]

TInt iNotifyDataAvailableOwnerHandle

TInt

iNotifyDataAvailableOwnerHandle

[private]

CCommSession * iNotifyOutputEmptyOwner

CCommSession *

iNotifyOutputEmptyOwner

[private]

TInt iNotifyOutputEmptyOwnerHandle

TInt

iNotifyOutputEmptyOwnerHandle

[private]

CPortManager * iPortManager

CPortManager *

iPortManager

[private]

CCommSession * iReadOwner

CCommSession *

iReadOwner

[private]

TInt iReadOwnerHandle

TInt

iReadOwnerHandle

[private]

TDeltaTimerEntry iReadTimer

TDeltaTimerEntry

iReadTimer

[private]

TBool iReadTimerPending

TBool

iReadTimerPending

[private]

CCommSession * iSignalOwner

CCommSession *

iSignalOwner

[private]

TInt iSignalOwnerHandle

TInt

iSignalOwnerHandle

[private]

CCommSession * iWriteOwner

CCommSession *

iWriteOwner

[private]

TInt iWriteOwnerHandle

TInt

iWriteOwnerHandle

[private]

TDeltaTimerEntry iWriteTimer

TDeltaTimerEntry

iWriteTimer

[private]

TBool iWriteTimerPending

TBool

iWriteTimerPending

[private]