class RComm : public RSubSessionBase |
A sub-session to the C32 Serial Server used for addressing a serial port.
All the necessary functions are provided by this class for communicating via a port, including functions for opening, closing, reading, writing, port configuration and capability checking. An RComm session represents a single serial port and once opened cannot be altered to represent another port.
Ports are referenced by a character string whose format is referred to as Port Prefix format. This format is also known as the CSY internal name, and the ports "short" name in older releases.
Private Attributes | |
---|---|
TPtr8 | iFlowNotification |
TPtr8 | iSignalsNotification |
IMPORT_C void | Break | ( | TRequestStatus & | aStatus, |
TTimeIntervalMicroSeconds32 | aTime | |||
) |
TRequestStatus & aStatus | |
TTimeIntervalMicroSeconds32 aTime |
IMPORT_C TInt | GetFlowControlStatus | ( | TFlowControl & | aFlowControl | ) | const |
TFlowControl & aFlowControl |
IMPORT_C TInt | Mode | ( | TCommServerConfig & | aConfig | ) | const |
TCommServerConfig & aConfig |
IMPORT_C void | NotifyBreak | ( | TRequestStatus & | aStatus | ) | const |
TRequestStatus & aStatus |
IMPORT_C void | NotifyConfigChange | ( | TRequestStatus & | aStatus, |
TDes8 & | aNewConfig | |||
) | const |
TRequestStatus & aStatus | |
TDes8 & aNewConfig |
IMPORT_C void | NotifyDataAvailable | ( | TRequestStatus & | aStatus | ) | const |
TRequestStatus & aStatus |
IMPORT_C void | NotifyFlowControlChange | ( | TRequestStatus & | aStatus, |
TFlowControl & | aFlowControl | |||
) |
TRequestStatus & aStatus | |
TFlowControl & aFlowControl |
IMPORT_C void | NotifyOutputEmpty | ( | TRequestStatus & | aStatus | ) | const |
TRequestStatus & aStatus |
IMPORT_C void | NotifySignalChange | ( | TRequestStatus & | aStatus, |
TUint & | aSignals, | |||
TUint | aSignalMask = 0x3F | |||
) |
TRequestStatus & aStatus | |
TUint & aSignals | |
TUint aSignalMask = 0x3F |
IMPORT_C TInt | Open | ( | RCommServ & | aServer, |
const TDesC & | aName, | |||
TCommAccess | aMode | |||
) |
RCommServ & aServer | |
const TDesC & aName | |
TCommAccess aMode |
IMPORT_C TInt | Open | ( | RCommServ & | aServer, |
const TDesC & | aName, | |||
TCommAccess | aMode, | |||
TCommRole | aRole | |||
) |
RCommServ & aServer | |
const TDesC & aName | |
TCommAccess aMode | |
TCommRole aRole |
IMPORT_C void | OpenWhenAvailable | ( | TRequestStatus & | aStatus, |
RCommServ & | aServer, | |||
const TDesC & | aName | |||
) |
TRequestStatus & aStatus | |
RCommServ & aServer | |
const TDesC & aName |
IMPORT_C void | OpenWhenAvailable | ( | TRequestStatus & | aStatus, |
RCommServ & | aServer, | |||
const TDesC & | aName, | |||
TCommRole | aRole | |||
) |
TRequestStatus & aStatus | |
RCommServ & aServer | |
const TDesC & aName | |
TCommRole aRole |
IMPORT_C void | Read | ( | TRequestStatus & | aStatus, |
TDes8 & | aDes | |||
) |
TRequestStatus & aStatus | |
TDes8 & aDes |
IMPORT_C void | Read | ( | TRequestStatus & | aStatus, |
TDes8 & | aDes, | |||
TInt | aLength | |||
) |
TRequestStatus & aStatus | |
TDes8 & aDes | |
TInt aLength |
IMPORT_C void | Read | ( | TRequestStatus & | aStatus, |
TTimeIntervalMicroSeconds32 | aTimeOut, | |||
TDes8 & | aDes | |||
) |
TRequestStatus & aStatus | |
TTimeIntervalMicroSeconds32 aTimeOut | |
TDes8 & aDes |
IMPORT_C void | Read | ( | TRequestStatus & | aStatus, |
TTimeIntervalMicroSeconds32 | aTimeOut, | |||
TDes8 & | aDes, | |||
TInt | aLength | |||
) |
TRequestStatus & aStatus | |
TTimeIntervalMicroSeconds32 aTimeOut | |
TDes8 & aDes | |
TInt aLength |
IMPORT_C void | ReadOneOrMore | ( | TRequestStatus & | aStatus, |
TDes8 & | aDes | |||
) |
TRequestStatus & aStatus | |
TDes8 & aDes |
IMPORT_C TInt | ResetBuffers | ( | TUint | aFlags = (KCommResetRx|KCommResetTx) | ) |
TUint aFlags = (KCommResetRx|KCommResetTx) |
IMPORT_C TInt | SetAccessMode | ( | TCommAccess | aNewMode | ) |
TCommAccess aNewMode |
IMPORT_C TInt | SetConfig | ( | const TDesC8 & | aConfig | ) |
const TDesC8 & aConfig |
IMPORT_C TInt | SetMode | ( | const TCommServerConfig & | aConfig | ) |
const TCommServerConfig & aConfig |
IMPORT_C TInt | SetReceiveBufferLength | ( | TInt | aLength | ) |
TInt aLength |
void | SetSignals | ( | TUint | aSetMask, |
TUint | aClearMask | |||
) | [inline] |
Sets or clears RS232 output lines (DTR and RTS).
For many applications, these lines will be read and set under driver control as determined by the handshaking options selected.
IMPORT_C TInt | SetSignalsToSpace | ( | TUint | aSignalMask | ) |
TUint aSignalMask |
IMPORT_C TUint | Signals | ( | TUint | aSignalMask = 0x3F | ) | const |
TUint aSignalMask = 0x3F |
IMPORT_C void | Write | ( | TRequestStatus & | aStatus, |
const TDesC8 & | aDes | |||
) |
TRequestStatus & aStatus | |
const TDesC8 & aDes |
IMPORT_C void | Write | ( | TRequestStatus & | aStatus, |
const TDesC8 & | aDes, | |||
TInt | aLength | |||
) |
TRequestStatus & aStatus | |
const TDesC8 & aDes | |
TInt aLength |
IMPORT_C void | Write | ( | TRequestStatus & | aStatus, |
TTimeIntervalMicroSeconds32 | aTimeOut, | |||
const TDesC8 & | aDes | |||
) |
TRequestStatus & aStatus | |
TTimeIntervalMicroSeconds32 aTimeOut | |
const TDesC8 & aDes |
IMPORT_C void | Write | ( | TRequestStatus & | aStatus, |
TTimeIntervalMicroSeconds32 | aTimeOut, | |||
const TDesC8 & | aDes, | |||
TInt | aLength | |||
) |
TRequestStatus & aStatus | |
TTimeIntervalMicroSeconds32 aTimeOut | |
const TDesC8 & aDes | |
TInt aLength |