![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
| |
|
| |
Location:
cs_port.h
Link against: c32.lib
CPort
Supported from 5.0
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.
Writing derived classes:
CPort is an abstract class which defines many pure
virtual functions which derived classes must implements. Most of these pure
virtual functions correspond to the client interface of the RComm
class.
|
Defined in CPort:
Break(), BreakCancel(), BreakCompleted(), BreakNotifyCompleted(), CPort(), Close(), ConfigChangeCompleted(), Destruct(), FlowControlChangeCompleted(), FreeMemory(), GetCaps(), GetConfig(), GetFlowControlStatus(), GetReceiveBufferLength(), GetRole(), GetServerConfig(), GetSignals(), IPCRead(), IPCWrite(), NotifyBreak(), NotifyBreakCancel(), NotifyConfigChange(), NotifyConfigChangeCancel(), NotifyDataAvailable(), NotifyDataAvailableCancel(), NotifyDataAvailableCompleted(), NotifyFlowControlChange(), NotifyFlowControlChangeCancel(), NotifyOutputEmpty(), NotifyOutputEmptyCancel(), NotifyOutputEmptyCompleted(), NotifySignalChange(), NotifySignalChangeCancel(), QueryReceiveBuffer(), ReadCancel(), ReadCompleted(), ResetBuffers(), SetConfig(), SetReceiveBufferLength(), SetRole(), SetServerConfig(), SetSignalsToMark(), SetSignalsToSpace(), SignalChangeCompleted(), StartRead(), StartWrite(), WriteCancel(), WriteCompleted(), ~CPort()
Inherited from CBase:
operator new()
Inherited from CObject:
AccessCount(),
Dec(),
FullName(),
Inc(),
Name(),
Open(),
Owner(),
SetName(),
SetNameL(),
SetOwner(),
UniqueID()
CPort();
Default constructor. Derived classes should implement a
NewL() function to perform their two-phase construction.
~CPort();
Destructor. This function is used to destroy a
CPort. Derived classes can implement a destructor, but must only
call synchronous functions within it. Any cleanup requiring asynchronous
operations must be done in Destruct().
virtual void Destruct()=0;
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.
|
void Close();
Closes 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.
|
TInt IPCRead(const TAny *aPtr,TDes8 &aDes,TInt anOffset=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().
See RThread::ReadL() for more information on reading data
in other address spaces.
|
|
TInt IPCWrite(const TAny* aPtr,const TDesC8& aDes,TInt anOffset=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().
See RThread::WriteL() for more information on writing data
to other address spaces.
|
|
|
virtual void ReadCancel()=0;
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.
The implementation should abort any processing which was taking place as
a result of the read request. Do not call ReadCompleted().
void ReadCompleted(TInt anError);
Tells the comms server that a read request initiated
throughStartRead() is complete. The comms server will then notify
the client that its read request is complete.
|
virtual void StartRead(const TAny* aClientBuffer,TInt aLength)=0;
Specifies the protocol for reading from the port. It is called by the
comms server in response to a
RComm::Read()orRComm::ReadOneOrMore() request from
the client.
A negative value for aLength is used to flag that the read
request was from RComm::ReadOneOrMore() rather than
fromRComm::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().
|
|
virtual void WriteCancel()=0;
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
callWriteCompleted().
void WriteCompleted(TInt anError);
Tells the comms server that a write request initiated
throughStartWrite() is complete. The comms server will then notify
the client that its write request is complete.
|
virtual void StartWrite(const TAny* aClientBuffer,TInt aLength)=0;
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().
|
|
virtual void Break(TInt aTime)=0;
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
callBreakCompleted().
|
virtual void BreakCancel()=0;
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
callBreakCompleted().
void BreakCompleted(TInt anError);
Tells the comms server that a break request initiated
throughBreak() is complete. The comms server will then notify the
client that its break request is complete.
|
|
virtual void NotifySignalChange(TUint aSignalMask)=0;
Specifies the protocol for setting a signal change notification. It is
called by the comms server in response to
aRComm::NotifySignalChange() request from the client.
|
virtual void NotifySignalChangeCancel()=0;
Specifies the protocol for cancelling a signal change notification. It is
called by the comms server in response to
aRComm::NotifySignalChangeCancel() request from the
client.
virtual void NotifyConfigChange()=0;
Specifies the protocol for setting a configuration change notification.
It is called by the comms server in response to
aRComm::NotifyConfigChange() request from the client.
virtual void NotifyConfigChangeCancel()=0;
Specifies the protocol for cancelling a configuration change
notification. It is called by the comms server in response to
aRComm::NotifyConfigChangeCancel() request from the
client.
virtual void NotifyFlowControlChange()=0;
Specifies the protocol for setting a flow control change notification. It
is called by the comms server in response to
aRComm::NotifyFlowControlChange() request from the client.
virtual void NotifyFlowControlChangeCancel()=0;
Specifies the protocol for cancelling a flow control change notification.
It is called by the comms server in response to
aRComm::NotifyFlowControlChangeCancel() request from the
client.
virtual void NotifyBreak()=0;
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.
virtual void NotifyBreakCancel()=0;
Specifies the protocol for cancelling a break notification. It is called
by the comms server in response to
aRComm::NotifyBreakCancel()request from the client.
virtual void NotifyDataAvailable()=0;
Specifies the protocol for setting a data available notification. It is
called by the comms server in response to
aRComm::NotifyDataAvailable() request from the client.
virtual void NotifyDataAvailableCancel()=0;
Specifies the protocol for cancelling a data available notification. It
is called by the comms server in response to
aRComm::NotifyDataAvailableCancel() request from the
client.
virtual void NotifyOutputEmpty()=0;
Specifies the protocol for setting a transmit buffer empty notification.
It is called by the comms server in response to
aRComm::NotifyOutputEmpty() request from the client.
virtual void NotifyOutputEmptyCancel()=0;
Specifies the protocol for cancelling a transmit buffer empty
notification. It is called by the comms server in response to
aRComm::NotifyOutputEmptyCancel() request from the client.
|
void SignalChangeCompleted(const TUint& aSignals, TInt anError);
Supported from 6.0
Tells the comms server that a request initiated
throughNotifySignalChange() is complete. The comms server will
then notify the client that its request is complete.
|
void ConfigChangeCompleted(const TDesC8& aNewConfig, TInt anError);
Supported from 6.0
Tells the comms server that a request initiated
throughNotifyConfigChange() is complete. The comms server will
then notify the client that its request is complete.
|
void FlowControlChangeCompleted(const TFlowControl& aFlowControl, TInt anError);
Supported from 6.0
Tells the comms server that a request initiated
throughNotifyFlowControlChange() is complete. The comms server
will then notify the client that its request is complete.
|
void BreakNotifyCompleted(TInt anError);
Supported from 6.0
Tells the comms server that a request initiated
throughBreakNotifyCompleted() is complete. The comms server will
then notify the client that its request is complete.
|
void NotifyDataAvailableCompleted(TInt anError);
Supported from 6.0
Tells the comms server that a request initiated
throughNotifyDataAvailable() is complete. The comms server will
then notify the client that its request is complete.
|
void NotifyOutputEmptyCompleted(TInt anError);
Supported from 6.0
Tells the comms server that a request initiated
throughNotifyOutputEmpty() is complete. The comms server will then
notify the client that its request is complete.
|
|
virtual void FreeMemory();
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.
virtual TInt GetReceiveBufferLength(TInt& aLength) const=0;
Specifies a protocol for requesting the size of the serial port buffers.
It is called by the comms server in response to
aRComm::ReceiveBufferLength() request from the client.
|
|
virtual TInt QueryReceiveBuffer(TInt& aLength) const=0;
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.
|
|
virtual void ResetBuffers(TUint aFlags)=0;
Specifies a protocol for resetting the receive and/or transmit buffers to
zero length. It is called by the comms server in response to
aRComm::ResetBuffers() request from the client.
|
virtual TInt SetReceiveBufferLength(TInt aLength)=0;
Specifies a protocol for setting the size of the serial port buffers. It
is called by the comms server in response to
aRComm::SetReceiveBufferLength() request from the client.
|
|
|
virtual TInt GetConfig(TDes8& aPackage) const=0;
Specifies a protocol for getting the current configuration of the serial
port. It is called by the comms server in response to
aRComm::GetConfig() request from the client.
|
|
virtual TInt GetServerConfig(TDes8& aPackage)=0;
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.
|
|
virtual TInt SetConfig(const TDesC8& aPackage)=0;
Specifies a protocol for setting the configuration of the port. It is
called by the comms server in response to
aRComm::SetConfig()request from the client.
|
|
virtual TInt SetServerConfig(const TDesC8& aPackage)=0;
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.
|
|
virtual TInt GetFlowControlStatus(TFlowControl& aFlowControl)=0;
Gets flow control status. It is called by the comms server in response to
a RComm::SetMode() request from the client.
|
|
virtual TInt GetRole(TCommRole& aRole)=0;
Gets DCE/DTE role. It is called by the comms server in response to
aRComm::GetRole() request from the client.
|
|
virtual TInt SetRole(TCommRole aRole)=0;
Sets DCE/DTE role. It is called by the comms server in response to
aRComm::Open() request from the client.
|
|
|
virtual TInt GetCaps(TDes8& aPackage)=0;
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.
|
|
|
virtual TInt GetSignals(TUint& aSignals)=0;
Specifies a protocol for getting the status of the serial port control
lines. It is called by the comms server in response to
aRComm::GetSignals() request from the client.
|
|
virtual TInt SetSignalsToMark(TUint aSignals)=0;
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.
|
|
virtual TInt SetSignalsToSpace(TUint aSignals)=0;
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.
|
|
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
![[Top]](../../../stock/arrow_up.gif){kind=icon}