RPacketContext::TPacketFilterV3 Class Reference
| class RPacketContext::TPacketFilterV3 : public RPacketContext::TPacketFilterV2 |
Packet filter that supports packet filter types. Contains member data compatible with parameters required for configuring a packet filter on a Rel99/R4/R5 packet network. .
Inherits from the TPacketFilterV2 class.
Supported from 9.1
Inherits from
- RPacketContext::TPacketFilterV3
Constructor & Destructor Documentation
TPacketFilterV3(TPacketFilterType)
Standard Constructor: Version 3 of the API
iType is set to aType which is passed as parameter and can be of the type EPacketFilterTypeOne, EPacketFilterTypeTwo or EPacketFilterTypeThree. iPresentDataBitmap is initialised to zero. iAllowedDataBitmap is set to a valid combination of TPacketFilterV3DataBitmapPos according to aType.
Parameters
| TPacketFilterType aType | TPacketFilterType - Can take any of the following values: EPacketFilterTypeOne, EPacketFilterTypeTwo or EPacketFilterTypeThree. |
TPacketFilterV3()
| IMPORT_C | TPacketFilterV3 | ( | ) | |
Default Constructor
iType is set to EPacketFilterTypeUnknown
Member Functions Documentation
DestPortMax()
|
TInt
| DestPortMax | ( | ) | [inline] |
This method may be called by the client application. Gets the iDestPortMax value which has been set by the SetDestPortMax method.
DestPortMin()
|
TInt
| DestPortMin | ( | ) | [inline] |
This method may be called by the client application. Gets the iDestPortMin value which has been set by the SetDestPortMin method.
FlowLabel()
This method may be called by the client application. Gets the iFlowLabel value which has been set by the SetFlowLabel method.
IsPresent(TPacketFilterDataBitmapPos)
This method may be called by the client application. Checks if the bitmap of a certain attribute is set or not.
ProtocolNumberOrNextHeader()
|
TInt
| ProtocolNumberOrNextHeader | ( | ) | [inline] |
This method may be called by the client application. Gets the iProtocolNumberOrNextHeader value which has been set by the SetProtocolNumberOrNextHeader method.
Reset(TPacketFilterDataBitmapPos)
This method may be called by the client application. Resets the iPresentDataBitmap of an attribute accordign to its Bitmap value.
Reset()
This method may be called by the client application. Sets the iPresentDataBitmap to 0.
SPI()
This method may be called by the client application. Gets the iIPSecSPI value which has been set by the SetSPI method.
SetDestPortMax(TInt)
| IMPORT_C TBool | SetDestPortMax | ( | TInt | aDestPortMax | ) | |
This method may be called by the client application. Sets the iDestPortMax to aDestPortMax only if a valid combination of bitmap is present.
Parameters
| TInt aDestPortMax | TInt value to be set. |
SetDestPortMin(TInt)
| IMPORT_C TBool | SetDestPortMin | ( | TInt | aDestPortMin | ) | |
This method may be called by the client application. Sets the iDestPortMin to aDestPortMin only if a valid combination of bitmap is present.
Parameters
| TInt aDestPortMin | TInt value to be set. |
SetFlowLabel(TUint32)
This method may be called by the client application. Sets the iFlowLabel to aFlowLabel only if a valid combination of bitmap is present.
Parameters
| TUint32 aFlowLabel | TUint32 value to be set. |
SetProtocolNumberOrNextHeader(TInt)
| IMPORT_C TBool | SetProtocolNumberOrNextHeader | ( | TInt | aProtocolNumberOrNextHeader | ) | |
This method may be called by the client application. Sets the iProtocolNumberOrNextHeader to aProtocolNumberOrNextHeader only if a valid combination of bitmap is present.
Parameters
| TInt aProtocolNumberOrNextHeader | TInt value to be set. |
SetSPI(TUint32)
This method may be called by the client application. Sets the iIPSecSPI to aIPSecSPI only if a valid combination of bitmap is present.
Parameters
| TUint32 aIPSecSPI | TUint32 value to be set. |
SetSrcAddr(TIPAddress &)
This method may be called by the client application. Sets the iSrcAddr to a SrcAddr only if a valid combination of bitmap is present.
SetSrcAddrSubnetMask(TIPAddress &)
This method may be called by the client application. Sets the iSrcAddrSubnetMask to aSrcAddrSubnetMask only if a valid combination of bitmap is present.
Parameters
| TIPAddress & aSrcAddrSubnetMask | TIPAddress value to be set. |
SetSrcPortMax(TInt)
This method may be called by the client application. Sets the iSrcPortMax to aSrcPortMax only if a valid combination of bitmap is present.
Parameters
| TInt aSrcPortMax | TInt value to be set. |
SetSrcPortMin(TInt)
This method may be called by the client application. Sets the iSrcPortMin to aSrcPortMin only if a valid combination of bitmap is present.
Parameters
| TInt aSrcPortMin | TInt value to be set. |
SetTOSorTrafficClass(TUint16)
| IMPORT_C TBool | SetTOSorTrafficClass | ( | TUint16 | aTOSorTrafficClass | ) | |
This method may be called by the client application. Sets the iTOSorTrafficClass to aTOSorTrafficClass only if a valid combination of bitmap is present.
Parameters
| TUint16 aTOSorTrafficClass | TUint16 value to be set. |
SrcAddr()
Return the Domain Source address.
SrcAddrSubnetMask()
Return the Domain Subnet mask.
SrcPortMax()
|
TInt
| SrcPortMax | ( | ) | [inline] |
This method may be called by the client application. Gets the iSrcPortMax value which has been set by the SetSrcPortMax method.
SrcPortMin()
|
TInt
| SrcPortMin | ( | ) | [inline] |
This method may be called by the client application. Gets the iSrcPortMin value which has been set by the SetSrcPortMin method.
TOSorTrafficClass()
|
TUint16
| TOSorTrafficClass | ( | ) | [inline] |
This method may be called by the client application. Gets the iTOSorTrafficClass value which has been set by the SetTOSorTrafficClass method.
Member Enumerations Documentation
Enum TPacketFilterDataBitmapPos
Enumerators
| EPacketFilterSrcAddr = 0x001 |
Bitmap for Domain Source address.
|
| EPacketFilterSrcAddrSubnetMask = 0x002 |
Bitmap for Domain Subnet mask.
|
| EPacketFilterProtocolNumberOrNextHeader = 0x004 |
Bitmap for Protocol number (IPv4) or Next Header (IPv6) field of incoming packets.
|
| EPacketFilterSrcPortMin = 0x008 |
Bitmap for Minimum source port number of incoming packets.
|
| EPacketFilterSrcPortMax = 0x010 |
Bitmap for Maximum source port number of incoming packets.
|
| EPacketFilterDestPortMin = 0x020 |
Bitmap for Lowest destination port number of incoming packets.
|
| EPacketFilterDestPortMax = 0x040 |
Bitmap for Maximum destination port number of incoming packets.
|
| EPacketFilterIPSecSPI = 0x080 |
Bitmap for Security Parameter Index.
|
| EPacketFilterTOSorTrafficClass = 0x100 |
Bitmap for Type of Service (IPv4) or Traffic Class (IPv6).
|
| EPacketFilterFlowLabel = 0x200 |
Bitmap for Flow label (IPv6 only) of incoming packets.
|
Member Data Documentation
TUint16
iAllowedDataBitmap
|
TUint16
| iAllowedDataBitmap | [protected] |
Bitmap of allowed attributes set in the constructor in accordance to type of the filter as defined in TS 23.060.
TUint16
iPresentDataBitmap
|
TUint16
| iPresentDataBitmap | [protected] |
Bitmap of data members that are set(initialised) - data member can be set in allowed for the specified type of the filter only.
TPacketFilterType
iType
Initialised in the constructor - type can be I, II or III
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.