class MNifIfNotify |
Interface from the nif and the protocol layers to Nifman
Protected Member Functions | |
---|---|
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 *) |
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 *) |
Public Member Enumerations | |
---|---|
enum | TAction { EReconnect, ECallBack, EDisconnect, ENoAction } |
TInt | Authenticate | ( | TDes & | aUsername, |
TDes & | aPassword | |||
) | [pure virtual] |
The return values in aUsername and aPassword should not be considered valid until CNifIfLink::AuthenticateComplete() has been called
void | BinderLayerDown | ( | CNifIfBase * | aBinderIf, |
TInt | aReason, | |||
TAction | aAction | |||
) | [pure virtual] |
Notification from the nif that a binder layer has gone down v7.0s
CNifIfBase * aBinderIf | An identifier for the binder layer that went down |
TInt aReason | The reason for the binder layer failure |
TAction aAction | The action to be taken as a result, eg. disconnect, reconnect |
void | CancelAuthenticate | ( | ) | [pure virtual] |
Request to the agent to cancel a pending authentication
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 | for capability checking |
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 | for capability checking |
TInt | DoReadDes | ( | const TDesC & | aField, |
TDes16 & | 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 |
TDes16 & aValue | On return, contains the value of the field read |
const RMessagePtr2 * aMessage | for capability checking |
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 | for capability checking |
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 | for capability checking |
TInt | DoWriteDes | ( | const TDesC & | aField, |
const TDesC8 & | 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 |
const TDesC8 & aValue | The value to be written to the field |
const RMessagePtr2 * aMessage | for capability checking |
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 | for capability checking |
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 | for capability checking |
TInt | GetExcessData | ( | TDes8 & | aBuffer | ) | [pure virtual] |
Fetch any excess data from the agent that it 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 | IfProgress | ( | TInt | aStage, |
TInt | aError | |||
) | [pure virtual] |
Upcall from the nif indicating that a new progress state has been reached on this connection The stage value is within the range assigned to nifs i.e. KMinNifProgress <= aStage <= KMaxNifProgress
v5.0
void | IfProgress | ( | TSubConnectionUniqueId | aSubConnectionUniqueId, |
TInt | aStage, | |||
TInt | aError | |||
) | [pure virtual] |
Upcall from the nif indicating that a new progress state has been reached on this subconnection The stage value is within the range assigned to nifs i.e. KMinNifProgress <= aStage <= KMaxNifProgress
v7.0s
TSubConnectionUniqueId aSubConnectionUniqueId | The subconnection to which this notification refers |
TInt aStage | The progress stage that has been reached |
TInt aError | Any errors that have occured |
void | LinkLayerDown | ( | TInt | aReason, |
TAction | aAction | |||
) | [pure virtual] |
Notification from the nif that the link layer has gone down.
void | NegotiationFailed | ( | CNifIfBase * | aIf, |
TInt | aReason | |||
) | [pure virtual] |
Indicate that link negotiation failed on this nif to allow nifman to take appropriate action
CNifIfBase * aIf | The address of the CNifIfBase/Link object for which negotiation failed |
TInt aReason | An error code denoting the reason for failure |
void | NifEvent | ( | TNetworkAdaptorEventType | aEventType, |
TUint | aEvent, | |||
const TDesC8 & | aEventData, | |||
TAny * | aSource = 0 | |||
) | [pure virtual] |
Indication that some parameter relating to a subconnection has changed in the nif eg. subconnection closed, opened, QoS changed
v7.0s
TodoIn the future, migrate GUQoS event handler and agent/nif notifications to this generic event handler - Nifman can then act as an event distributorTNetworkAdaptorEventType aEventType | The type of event which has occured - used to direct the event notification to the appropriate component(s) |
TUint aEvent | The event which has occured |
const TDesC8 & aEventData | Any arguments or additional data to do with the event; the interpretation of this depends on the event |
TAny * aSource = 0 | An appropriate identifier of the source of the event - this will be used when one receiver is receiving events from many producers |
TInt | Notification | ( | TNifToAgentEventType | aEvent, |
void * | aInfo = NULL | |||
) | [pure virtual] |
Notification of an event from the nif KErrNone if successful, otherwise one of the system-wide error codes
SC with previous releases broken in v6.1 when first argument changed type
TNifToAgentEventType aEvent | The type of event that occured |
void * aInfo = NULL | Any data associated with the event |
void | NotifyDataReceived | ( | TSubConnectionUniqueId | aSubConnectionUniqueId, |
TUint | aDownlinkVolume | |||
) | [pure virtual] |
Indication that the received bytes threshold for a subconnection has been met or exceeded in the nif
v7.0s
TSubConnectionUniqueId aSubConnectionUniqueId | The subconnection to which this notification refers |
TUint aDownlinkVolume | The total number of bytes sent by this subconnection |
void | NotifyDataSent | ( | TSubConnectionUniqueId | aSubConnectionUniqueId, |
TUint | aUplinkVolume | |||
) | [pure virtual] |
Indication that the sent bytes threshold for a subconnection has been met or exceeded in the nif
v7.0s
TSubConnectionUniqueId aSubConnectionUniqueId | The subconnection to which this notification refers |
TUint aUplinkVolume | The total number of bytes sent by this subconnection |
TInt | PacketActivity | ( | TDataTransferDirection | aDirection, |
TUint | aBytes, | |||
TBool | aResetTimer | |||
) | [pure virtual] |
Indication from network layer that a packet has been transmitted or received
KErrNone if successful, otherwise one of the system-wide error codes
v7.0s
TDataTransferDirection aDirection | Whether the packet was transmitted or received |
TUint aBytes | The size of the packet |
TBool aResetTimer | Whether the idle timer should be reset |
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 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 | for capability checking |
IMPORT_C TInt | ReadDes | ( | const TDesC & | aField, |
TDes16 & | aValue, | |||
const RMessagePtr2 * | aMessage | |||
) |
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 |
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 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 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 |
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 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 | 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 |