class CNifAgentBase : public CBase |
Base class for agents. All agents derive from this base class; either directly or via another class that offers additional functionality. CAgentBase; CStateMachineAgentBase (for v6.1 agx porting)
since v9.5. Use MCPRs/CPRs/SCPRs instead of agents.
Protected Member Functions | |
---|---|
IMPORT_C TInt | DoCheckReadCapability(const TDesC &, const RMessagePtr2 *) |
IMPORT_C TInt | DoCheckWriteCapability(const TDesC &, const RMessagePtr2 *) |
TInt | DoReadBool(const TDesC &, TBool &, const RMessagePtr2 *) |
TInt | DoReadDes(const TDesC &, TDes8 &, const RMessagePtr2 *) |
TInt | DoReadDes(const TDesC &, TDes16 &, const RMessagePtr2 *) |
TInt | DoReadInt(const TDesC &, TUint32 &, const RMessagePtr2 *) |
HBufC * | DoReadLongDesLC(const TDesC &, const RMessagePtr2 *) |
TInt | DoWriteBool(const TDesC &, TBool, const RMessagePtr2 *) |
TInt | DoWriteDes(const TDesC &, const TDesC8 &, const RMessagePtr2 *) |
TInt | DoWriteDes(const TDesC &, const TDesC16 &, const RMessagePtr2 *) |
TInt | DoWriteInt(const TDesC &, TUint32, const RMessagePtr2 *) |
Private Member Functions | |
---|---|
TBool | CheckControlPolicy(TUint, TUint, const RProcess &) |
Protected Attributes | |
---|---|
MNifAgentNotify * | iNotify |
void | CancelRequestNotificationOfServiceChange | ( | MAgentSessionNotify * | aSession | ) | [pure virtual] |
MAgentSessionNotify * aSession |
TBool | CheckControlPolicy | ( | TUint | aLevel, |
TUint | aOption, | |||
const RProcess & | aProcess | |||
) | [private] |
Check that a client has the required capabilties KErrNone, if the client has the required capabilites, otherwise one of the standard Symbian OS error codes
IMPORT_C TInt | CheckReadCapability | ( | const TDesC & | aField, |
const RMessagePtr2 * | aMessage | |||
) |
Check that a client has the required capabilities to read a field one of the system-wide error codes
const TDesC & aField | The field to check |
const RMessagePtr2 * aMessage | Message containing client capabilites |
IMPORT_C TInt | CheckWriteCapability | ( | const TDesC & | aField, |
const RMessagePtr2 * | aMessage | |||
) |
Check that a client has the required capabilities to write a field one of the system-wide error codes
const TDesC & aField | The field to check |
const RMessagePtr2 * aMessage | Message containing client capabilites |
void | Connect | ( | TAgentConnectType | aType | ) | [pure virtual] |
TAgentConnectType aType |
void | Connect | ( | TAgentConnectType | aType, |
CStoreableOverrideSettings * | aOverrideSettings | |||
) | [pure virtual] |
TAgentConnectType aType | |
CStoreableOverrideSettings * aOverrideSettings |
IMPORT_C TInt | Control | ( | TUint | aOptionLevel, |
TUint | aOptionName, | |||
TDes8 & | aOption | |||
) | [virtual] |
This version of the Control(TUint, TUint, TDes8&) function is now deprecated. DO NOT Override Use the version of CNifAgentBase::Control(TUint, TUint, TDes8&, RProcess) that takes four parameters
IMPORT_C TInt | Control | ( | TUint | aOptionLevel, |
TUint | aOptionName, | |||
TDes8 & | aOption, | |||
const RProcess & | aProcess | |||
) | [virtual] |
IMPORT_C TInt | DoCheckReadCapability | ( | const TDesC & | aField, |
const RMessagePtr2 * | aMessage | |||
) | [protected, virtual] |
Check that a client has the required capabilties to read a field KErrNone, if the client has the required capabilites, otherwise one of the standard Symbian OS error codes
const TDesC & aField | the name of the field to read |
const RMessagePtr2 * aMessage | Message containing the capabilities of the client |
IMPORT_C TInt | DoCheckWriteCapability | ( | const TDesC & | aField, |
const RMessagePtr2 * | aMessage | |||
) | [protected, virtual] |
Check that a client has the required capabilties to write a field KErrNone, if the client has the required capabilites, otherwise one of the standard Symbian OS error codes
const TDesC & aField | the name of the field to write |
const RMessagePtr2 * aMessage | Message containing the capabilities of the client |
TInt | DoReadBool | ( | const TDesC & | aField, |
TBool & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Read an boolean field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to read |
TBool & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage |
TInt | DoReadDes | ( | const TDesC & | aField, |
TDes8 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Read a 8-bit descriptor field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to read |
TDes8 & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage |
TInt | DoReadDes | ( | const TDesC & | aField, |
TDes16 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Write an 8-bit descriptor field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to which to write |
TDes16 & aValue | The value to be written to the field |
const RMessagePtr2 * aMessage |
TInt | DoReadInt | ( | const TDesC & | aField, |
TUint32 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Read an integer field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to read |
TUint32 & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage |
HBufC * | DoReadLongDesLC | ( | const TDesC & | aField, |
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Read a 16-bit descriptor field of unknown size from the connection settings provider The value of the field read
v7.0s
const TDesC & aField | The name of the field to read |
const RMessagePtr2 * aMessage |
TInt | DoWriteBool | ( | const TDesC & | aField, |
TBool | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Write an boolean field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to which to write |
TBool aValue | The value to be written to the field |
const RMessagePtr2 * aMessage |
TInt | DoWriteDes | ( | const TDesC & | aField, |
const TDesC8 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Read a 16-bit descriptor field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to read |
const TDesC8 & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage |
TInt | DoWriteDes | ( | const TDesC & | aField, |
const TDesC16 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Write an 16-bit descriptor field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to which to write |
const TDesC16 & aValue | The value to be written to the field |
const RMessagePtr2 * aMessage |
TInt | DoWriteInt | ( | const TDesC & | aField, |
TUint32 | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) | [protected, pure virtual] |
Write an integer field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to which to write |
TUint32 aValue | The value to be written to the field |
const RMessagePtr2 * aMessage |
TInt | GetExcessData | ( | TDes8 & | aBuffer | ) | [pure virtual] |
Return any excess data was received during connection setup KErrNone, if successful; otherwise, one of the standard Symbian OS error codes
TDes8 & aBuffer | On return, the buffer contains the excess data from the agent |
void | Info | ( | TNifAgentInfo & | aInfo | ) | const [pure virtual] |
TNifAgentInfo & aInfo |
TInt | Notification | ( | TNifToAgentEventType | aEvent, |
TAny * | aInfo | |||
) | [pure virtual] |
Notification of an event from the nif KErrNone if successful, otherwise one of the system-wide error codes
v6.1
TNifToAgentEventType aEvent | The type of event that occured |
TAny * aInfo | Any data associated with the event |
IMPORT_C TInt | ReadBool | ( | const TDesC & | aField, |
TBool & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
Read an boolean field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to read |
TBool & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage | For capability checking |
IMPORT_C TInt | ReadDes | ( | const TDesC & | aField, |
TDes8 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
Read a descriptor field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to read |
TDes8 & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage | For capability checking |
IMPORT_C TInt | ReadDes | ( | const TDesC & | aField, |
TDes16 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
Read a descriptor field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to read |
TDes16 & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage | For capability checking |
IMPORT_C TInt | ReadInt | ( | const TDesC & | aField, |
TUint32 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
Read an integer field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to read |
TUint32 & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage | For capability checking |
IMPORT_C HBufC * | ReadLongDesLC | ( | const TDesC & | aField, |
const RMessagePtr2 * | aMessage | |||
) |
Read a descriptor field of unknown size from the connection settings provider The value of the field read
v7.0s
const TDesC & aField | The name of the field to read |
const RMessagePtr2 * aMessage | For capability checking |
IMPORT_C HBufC * | ReadLongDesLC | ( | const TDesC & | aField | ) |
const TDesC & aField |
void | RequestNotificationOfServiceChangeL | ( | MAgentSessionNotify * | aSession | ) | [pure virtual] |
MAgentSessionNotify * aSession |
void | SetConnectionSettingsL | ( | const TConnectionSettings & | aSettings | ) | [pure virtual] |
const TConnectionSettings & aSettings |
void | SetOverridesL | ( | CStoreableOverrideSettings * | aOverrideSettings | ) | [pure virtual] |
CStoreableOverrideSettings * aOverrideSettings |
IMPORT_C TInt | WriteBool | ( | const TDesC & | aField, |
TBool | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
Write an boolean field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to which to write |
TBool aValue | The value to be written to the field |
const RMessagePtr2 * aMessage | For capability checking |
IMPORT_C TInt | WriteDes | ( | const TDesC & | aField, |
const TDesC8 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
Write a descriptor field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to which to write |
const TDesC8 & aValue | The value to be written to the field |
const RMessagePtr2 * aMessage | For capability checking |
IMPORT_C TInt | WriteDes | ( | const TDesC & | aField, |
const TDesC8 & | aValue | |||
) |
IMPORT_C TInt | WriteDes | ( | const TDesC & | aField, |
const TDesC16 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
Write a descriptor field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to which to write |
const TDesC16 & aValue | The value to be written to the field |
const RMessagePtr2 * aMessage | For capability checking |
IMPORT_C TInt | WriteDes | ( | const TDesC & | aField, |
const TDesC16 & | aValue | |||
) |
IMPORT_C TInt | WriteInt | ( | const TDesC & | aField, |
TUint32 | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
Write an integer field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes
const TDesC & aField | The name of the field to which to write |
TUint32 aValue | The value to be written to the field |
const RMessagePtr2 * aMessage | For capability checking |