CPort Class Reference

AreAnyPending

(

)

Return true if there is an outstanding Read/Write/Break on the CSY.

Break ( TInt )

void

Break

(

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
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

(

anError

)

Tells the comms server that a break request initiated through Break() is complete.

The comms server will then notify the client that its break request is complete.

Called by C32 server or CSY.

Parameters
anError	Return code to be passed back to the client through its TRequestStatus argument.

BreakNotifyCompleted ( TInt )

IMPORT_C void

BreakNotifyCompleted

(

anError

)

Tells the comms server that a request initiated through NotifyBreak() is complete.

The comms server will then notify the client that its request is complete.

Called by the CSY module.

Parameters
anError	Error code

Close ( )

IMPORT_C void

(

)

[virtual]

Reimplemented from CObject::Close()

Closes the port.

The base class implements CObject::Close() to handle reference counting on the port. It decrements the reference count, and calls Destruct() if the count is 0.

CommBreak ( const RMessage2 &, CCommSession * )

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

Perform a break making sure of the port's owner

Parameters
aMessage	message from the client
aClient	handle to the client session.

CommBreakCancel ( TInt, CCommSession * )

void	CommBreakCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding break

Parameters
aHandle	handle to the client
aClient	handle to the client session.

CommCancel ( TInt, CCommSession * )

void	CommCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel any outstanding requests

Parameters
aHandle	handle to the client
aClient	handle to the client session.

CommCaps ( const RMessage2 &, CCommSession & )

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

Read capabilities

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommConfig ( const RMessage2 &, CCommSession & )

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

Get config

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommDebugState ( const RMessage2 &, CCommSession & )

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

CommGetFlowControlStatus ( const RMessage2 &, CCommSession * )

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

Get flow control state ON/OFF from CSY module

Parameters
aMessage	handle to the IPC message from the client
aClient	pointer to the Comm session

CommGetRole ( const RMessage2 &, CCommSession * )

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

Get role DCE/DTE from CSY module

Parameters
aMessage	handle to the IPC message from the client
aClient	pointer to the Comm session

CommGetServerConfig ( const RMessage2 &, CCommSession & )

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

Get server config

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommNotifyBreak ( const RMessage2 &, CCommSession * )

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

Set break signal notifying on

Parameters
aMessage	handle to the IPC message from the client
aClient	pointer to the Comm session

CommNotifyBreakCancel ( TInt, CCommSession * )

void	CommNotifyBreakCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding break notification

Parameters
aHandle	Handle to the session
aClient	pointer to the Comm session

CommNotifyConfigChange ( const RMessage2 &, CCommSession * )

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

Set configuration change (data format, speed, ...) notifying on

Parameters
aMessage	handle to the IPC message from the client
aClient	pointer to the Comm session

CommNotifyConfigChangeCancel ( TInt, CCommSession * )

void	CommNotifyConfigChangeCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding configuration change notification

Parameters
aHandle	Handle to the session
aClient	pointer to the Comm session

CommNotifyDataAvailable ( const RMessage2 &, CCommSession * )

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

Set input buffer data notifying on

Parameters
aMessage	handle to the IPC message from the client
aClient	pointer to the Comm session

CommNotifyDataAvailableCancel ( TInt, CCommSession * )

void	CommNotifyDataAvailableCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding input buffer data notification

Parameters
aHandle	Handle to the session
aClient	pointer to the Comm session

CommNotifyFlowControlChange ( const RMessage2 &, CCommSession * )

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

Set flow control notifying on

Parameters
aMessage	handle to the IPC message from the client
aClient	pointer to the Comm session

CommNotifyFlowControlChangeCancel ( TInt, CCommSession * )

void	CommNotifyFlowControlChangeCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding flow control notification

Parameters
aHandle	Handle to the session
aClient	pointer to the Comm session

CommNotifyOutputEmpty ( const RMessage2 &, CCommSession * )

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

Set output buffer empty notifying on

Parameters
aMessage	handle to the IPC message from the client
aClient	pointer to the Comm session

CommNotifyOutputEmptyCancel ( TInt, CCommSession * )

void	CommNotifyOutputEmptyCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding output buffer empty notification

Parameters
aHandle	Handle to the session
aClient	pointer to the Comm session

CommNotifySignalChange ( const RMessage2 &, CCommSession * )

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

Set DCE/DTE signal notifying on

Parameters
aMessage	handle to the IPC message from the client
aClient	pointer to the Comm session

CommNotifySignalChangeCancel ( TInt, CCommSession * )

void	CommNotifySignalChangeCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding signal notification

Parameters
aHandle	Handle to the session
aClient	pointer to the Comm session

CommQueryReceiveBuffer ( const RMessage2 &, CCommSession & )

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

Set the receive buffer length

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommRead ( const RMessage2 &, CCommSession * )

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

Perform a read making sure of the port's owner

Parameters
aMessage	message from the client
aClient	handle to the client session.

CommReadCancel ( TInt, CCommSession * )

void	CommReadCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding read

Parameters
aHandle	handle to the client
aClient	handle to the client session.

CommReceiveBufferLength ( const RMessage2 &, CCommSession & )

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

read the receive buffer length

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommResetBuffers ( const RMessage2 &, CCommSession & )

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

Set the receive buffer length

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommSetAccess ( const RMessage2 &, CCommSession & )

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

set the access mode

Parameters
aMessage	message from client with the new access mode
aSession	handle to the session.

CommSetAccessCancel ( TInt, CCommSession * )

void	CommSetAccessCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancels an outstanding set access request.

Parameters
aClient	pointer to the CCommSession client.

CommSetConfig ( const RMessage2 &, CCommSession & )

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

Set config

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommSetReceiveBufferLength ( const RMessage2 &, CCommSession & )

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

Set the receive buffer length

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommSetServerConfig ( const RMessage2 &, CCommSession & )

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

Set server config

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommSetSignalsToMark ( const RMessage2 &, CCommSession & )

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

Set signal lines

Parameters
aMessage	message from the client.

CommSetSignalsToSpace ( const RMessage2 &, CCommSession & )

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

Clear signal lines

Parameters
aMessage	message from the client.

CommSignals ( const RMessage2 &, CCommSession & )

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

Read signals

Parameters
aMessage	message from the client
aSession	handle to the client session.

CommWrite ( const RMessage2 &, CCommSession * )

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

Perform a write making sure of the port's owner

Parameters
aMessage	message from the client
aClient	handle to the client session.

CommWriteCancel ( TInt, CCommSession * )

void	CommWriteCancel	(	TInt	aHandle,
			CCommSession *	aClient
		)

Cancel outstanding write

Parameters
aHandle	handle to the client
aClient	handle to the client session.

ConfigChangeCompleted ( const TDesC8 &, TInt )

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

Tells the comms server that a request initiated through NotifyConfigChange() is complete.

The comms server will then notify the client that its request is complete.

Called by the CSY module.

Parameters
aNewConfig	Configuration value to pass to client
anError	Error code

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.

FlowControlChangeCompleted ( const TFlowControl &, TInt )

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

Tells the comms server that a request initiated through NotifyFlowControlChange() is complete.

The comms server will then notify the client that its request is complete.

Called by the CSY module.

Parameters
aFlowControl	Flow control to pass to client
anError	Error code

FreeMemory ( )

void

FreeMemory

(

)

[virtual]

Specifies a protocol by which the comms server can request the protocol to release memory. Typically, an implementation may be able to do this by reducing internal buffers.

The default behaviour is to do nothing.

FreeSession ( CCommSession * )

void

FreeSession

(

CCommSession *

aSession

)

Perform CPort based housekeeping before closing a session

Parameters
aSession	pointer to the session to free.

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.

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

Return Value: A system error code

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.

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

Return Value: A system wide error code

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.

Parameters
aFlowControl	Flow control status to return to the client

Return Value: A system-wide error code

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.

Parameters
aLength	The current size of the serial port buffers in bytes

Return Value: A system error code

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.

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

Return Value: A system-wide error code

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.

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

Return Value: A system error code

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.

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

Return Value: A system error code

IPCRead ( const TAny *, TDes8 &, TInt )

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

Reads data from the client's (the user of the port's) address space.

The client address space pointer is obtained from the aClientBuffer argument to StartRead().

Note:

This function is normally called by the CSY

Note:

Used as part of RComm::Write

See also: RThread::ReadL() for more information on reading data in other address spaces.

Parameters
aPtr	Not Used. The client data is now obtained from iBlockedWrite.
aDes	A descriptor (8 bit variant) into which the result of the client address space read operation will be stored
aOffset	The read offset from the start of the client's descriptor data.

Return Value: TInt KErrNone: success KErrNotReady: there is no read or write request outstanding KErrBadDescriptor: the client's descriptor is not valid.

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

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

Writes into the client's (the user of the port's) address space.

The client address space pointer is obtained from the aClientBuffer argument to StartWrite().

Note:

This function is normally called by the CSY

Note:

Used as part of RComm::Read

See also: RThread::WriteL() for more information on writing data to other address spaces.

Parameters
aPtr	Client address space pointer
aDes	A descriptor (8 bit variant) into which the result of the client address space read will be stored
aOffset	The offset from aPtr at which to start reading

Return Value: TInt KErrNone: success KErrNotReady: there is no read or write request outstanding KErrBadDescriptor: the client's descriptor is not valid.

InitL ( TDesC8 & )

void

InitL

(

TDesC8 &

aName

)

IsBlockedSetAccessWaiting ( CCommSession & )

IsBlockedSetAccessWaiting

(

CCommSession &

aClient

)

Checks if a CommSetAccess() request is waiting for the port.

Parameters
aClient	The CCommSession client to check against.

Return Value: True if a request is pending, false otherwise.

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

(

anError

)

Tells the comms server that a request initiated through NotifyDataAvailable() is complete.

The comms server will then notify the client that its request is complete.

Called by the CSY module.

Parameters
anError	Error code

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

(

anError

)

Tells the comms server that a request initiated through NotifyOutputEmpty() is complete.

The comms server will then notify the client that its request is complete.

Called by the CSY module.

Parameters
anError	Error code

NotifySignalChange ( TUint )

void

NotifySignalChange

(

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
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.

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

Return Value: A system wide error code.

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

(

anError

)

Tells the comms server that a read request initiated through StartRead() is complete.

The comms server will then notify the client that its read request is complete.

Called by C32 server or CSY.

Parameters
anError	Return code to be passed back to the client through its TRequestStatus argument.

ReadTimerExpiredHandler ( TAny * )

TInt

ReadTimerExpiredHandler

(

TAny *

aPtr

)

[static]

This static function is called when the read timer expires. installed by CPort::CommRead as TCallBack

Parameters
aPtr	pointer to the CPort with the timedout read

Return Value: KErrNone always.

ResetBuffers ( TUint )

void

ResetBuffers

(

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
aFlags	Bitmask of the following flags: KCommResetRx to reset the receive buffer; KCommResetTx to reset the transmit buffer

SessionHasBeenPreempted ( CCommSession * )

SessionHasBeenPreempted

(

CCommSession *

aSession

)

returns true if session has been pre-empted

Parameters
aSession	session to be questioned

Return Value: TBool pre-empted status of this session. ETrue if session has been pre-empted, EFalse otherwise.

SessionIsAwaitingOpen ( CCommSession * )

SessionIsAwaitingOpen

(

CCommSession *

aSession

)

returns true if session is waiting for open

Parameters
aSession	session to be questioned

Return Value: TBool ETrue if session is awaiting open, EFalse otherwise.

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.

Parameters
aPackage	A packaged TCommConfig buffer holding the new configuration values

Return Value: A system error code

SetReceiveBufferLength ( TInt )

TInt

SetReceiveBufferLength

(

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.

Parameters
aLength	Requested size of the serial port buffers in bytes

Return Value: A system error code

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.

Parameters
aRole	DCE/DTE role

Return Value: A system-wide error code

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.

Parameters
aPackage	A TCommServerConfig package buffer holding the mode settings

Return Value: A system-wide error code

SetSignalsToMark ( TUint )

TInt

SetSignalsToMark

(

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.

Parameters
aSignals	A bitmask of the handshaking lines to set

Return Value: A system error code

SetSignalsToSpace ( TUint )

TInt

SetSignalsToSpace

(

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.

Parameters
aSignals	A bitmask of the handshaking lines to clear

Return Value: A system error code

SignalChangeCompleted ( const TUint &, TInt )

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

Tells the comms server that a request initiated through NotifySignalChange() is complete.

The comms server will then notify the client that its request is complete.

Called by the CSY module.

Parameters
aSignals	The new signals value to pass to the client.
anError	An error code.

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
aClientBuffer	Pointer into client address space to the descriptor containing the client's buffer
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
aClientBuffer	Pointer into client address space to the descriptor containing the client's buffer
aLength	The amount of data to be written

TakeOwnershipForBreak ( const RMessage2 &, CCommSession * )

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

We check that break notifying is not called twice at the same time

Parameters
aClient	pointer to the Comm session

Return Value: ETrue if not owner, EFalse if owner

TakeOwnershipForBreaking ( const RMessage2 &, CCommSession * )

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

Check if a Break request is valid and take ownership of port

Parameters
aClient	handle to the client session

Return Value: TBool ETrue if ownership granted, EFalse otherwise.

TakeOwnershipForConfig ( const RMessage2 &, CCommSession * )

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

We check that config change notifying is not called twice at the same time

Parameters
aClient	pointer to the Comm session

Return Value: ETrue if not owner, EFalse if owner

TakeOwnershipForFlowControl ( const RMessage2 &, CCommSession * )

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

We check that flowcontrol notifying is not called twice at the same time

Parameters
aClient	pointer to the Comm session

Return Value: ETrue if not owner, EFalse if owner

TakeOwnershipForNotifyDataAvailable ( const RMessage2 &, CCommSession * )

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

We check that input buffer data notifying is not called twice at the same time

Parameters
aClient	pointer to the Comm session

Return Value: ETrue if not owner, EFalse if owner

TakeOwnershipForNotifyOutputEmpty ( const RMessage2 &, CCommSession * )

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

We check that output buffer empty notifying is not called twice at the same time

Parameters
aClient	pointer to the Comm session

Return Value: ETrue if not owner, EFalse if owner

TakeOwnershipForReading ( const RMessage2 &, CCommSession * )

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

Check if a Read request is valid and take ownership of port

Parameters
aClient	handle to the client session

Return Value: TBool ETrue if ownership granted, EFalse otherwise.

TakeOwnershipForSignals ( const RMessage2 &, CCommSession * )

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

We check that signal notifying is not called twice at the same time

Parameters
aClient	pointer to the Comm session

Return Value: ETrue if not owner, EFalse if owner

TakeOwnershipForWriting ( const RMessage2 &, CCommSession * )

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

Check if a Write request is valid and take ownership of port

Parameters
aClient	handle to the client session

Return Value: TBool ETrue if ownership granted, EFalse otherwise.

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

(