williamr@2
|
1 |
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
|
williamr@2
|
2 |
// All rights reserved.
|
williamr@2
|
3 |
// This component and the accompanying materials are made available
|
williamr@4
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
williamr@2
|
5 |
// which accompanies this distribution, and is available
|
williamr@4
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
williamr@2
|
7 |
//
|
williamr@2
|
8 |
// Initial Contributors:
|
williamr@2
|
9 |
// Nokia Corporation - initial contribution.
|
williamr@2
|
10 |
//
|
williamr@2
|
11 |
// Contributors:
|
williamr@2
|
12 |
//
|
williamr@2
|
13 |
// Description:
|
williamr@2
|
14 |
// This file contains the API definition for the classes TAuthorityC16 and
|
williamr@2
|
15 |
// CAuthority16. These classes provide non-modifying (TAuthorityC16) and
|
williamr@2
|
16 |
// modifying (CAuthority16) functionality for the components of an
|
williamr@2
|
17 |
// Authority as described in RFC2396.
|
williamr@2
|
18 |
//
|
williamr@2
|
19 |
//
|
williamr@2
|
20 |
|
williamr@2
|
21 |
/**
|
williamr@2
|
22 |
@file Authority16.h
|
williamr@2
|
23 |
@publishedAll
|
williamr@2
|
24 |
@deprecated Deprecated in 9.1
|
williamr@2
|
25 |
*/
|
williamr@2
|
26 |
|
williamr@2
|
27 |
#ifndef __AUTHORITY16_H__
|
williamr@2
|
28 |
#define __AUTHORITY16_H__
|
williamr@2
|
29 |
|
williamr@2
|
30 |
// System includes
|
williamr@2
|
31 |
//
|
williamr@2
|
32 |
#include <e32base.h>
|
williamr@2
|
33 |
#include <authoritycommon.h>
|
williamr@2
|
34 |
|
williamr@2
|
35 |
|
williamr@2
|
36 |
/**
|
williamr@2
|
37 |
Dependencies : TAuthorityComponent.
|
williamr@2
|
38 |
Comments : Provides non-modifying functionality on the components of an authority
|
williamr@2
|
39 |
object as defined in RFC2396. There are 3 components; userinfo, host and port.
|
williamr@2
|
40 |
|
williamr@2
|
41 |
The object holds descriptor pointers to the parsed authority components and a descriptor
|
williamr@2
|
42 |
pointer to the authority. It is non-owning. It uses 16-bit descriptors.
|
williamr@2
|
43 |
|
williamr@2
|
44 |
The functionality provided by this API allows the authority components to be extracted
|
williamr@2
|
45 |
from the parsed authority, checked for their presence in the authority and be compared
|
williamr@2
|
46 |
with those in another TAuthorityC16 object.
|
williamr@2
|
47 |
@publishedAll
|
williamr@2
|
48 |
@deprecated Deprecated in 9.1
|
williamr@2
|
49 |
@since 6.0
|
williamr@2
|
50 |
*/
|
williamr@2
|
51 |
class TAuthorityC16
|
williamr@2
|
52 |
{
|
williamr@2
|
53 |
public: // Methods
|
williamr@2
|
54 |
|
williamr@2
|
55 |
IMPORT_C const TDesC16& Extract(TAuthorityComponent aComponent) const;
|
williamr@2
|
56 |
IMPORT_C TBool IsPresent(TAuthorityComponent aComponent) const;
|
williamr@2
|
57 |
IMPORT_C TInt Compare(const TAuthorityC16& aAuthority, TAuthorityComponent aComponent) const;
|
williamr@2
|
58 |
IMPORT_C const TDesC16& AuthorityDes() const;
|
williamr@2
|
59 |
IMPORT_C HBufC* DisplayFormL(TAuthorityComponent aComponent = EAuthorityComplete ) const;
|
williamr@2
|
60 |
|
williamr@2
|
61 |
protected: // Methods
|
williamr@2
|
62 |
|
williamr@2
|
63 |
|
williamr@2
|
64 |
IMPORT_C TAuthorityC16();
|
williamr@2
|
65 |
|
williamr@2
|
66 |
void Reset();
|
williamr@2
|
67 |
|
williamr@2
|
68 |
protected: // Attributes
|
williamr@2
|
69 |
|
williamr@2
|
70 |
/**
|
williamr@2
|
71 |
The array of descriptor pointers to the authority components.
|
williamr@2
|
72 |
*/
|
williamr@2
|
73 |
TPtrC16 iComponent[EAuthorityMaxComponents];
|
williamr@2
|
74 |
|
williamr@2
|
75 |
/**
|
williamr@2
|
76 |
The descriptor pointer to the authority.
|
williamr@2
|
77 |
*/
|
williamr@2
|
78 |
TPtrC16 iAuthorityDes;
|
williamr@2
|
79 |
|
williamr@2
|
80 |
/**
|
williamr@2
|
81 |
A friend class.
|
williamr@2
|
82 |
@see CAuthority16
|
williamr@2
|
83 |
@since 6.0
|
williamr@2
|
84 |
*/
|
williamr@2
|
85 |
friend class CAuthority16;
|
williamr@2
|
86 |
|
williamr@2
|
87 |
/**
|
williamr@2
|
88 |
A friend class used for testing.
|
williamr@2
|
89 |
@see TAuthorityC16StateAccessor
|
williamr@2
|
90 |
@since 6.0
|
williamr@2
|
91 |
*/
|
williamr@2
|
92 |
friend class TAuthorityC16StateAccessor;
|
williamr@2
|
93 |
|
williamr@2
|
94 |
};
|
williamr@2
|
95 |
|
williamr@2
|
96 |
/**
|
williamr@2
|
97 |
Dependencies : TAuthorityC16
|
williamr@2
|
98 |
Comments : Provides functionality to parse a descriptor into the components of an
|
williamr@2
|
99 |
authority as defined in RFC2396. There are 3 components; userinfo, host and port.
|
williamr@2
|
100 |
|
williamr@2
|
101 |
This uses 16-bit descriptors.
|
williamr@2
|
102 |
|
williamr@2
|
103 |
Format of an authority is; [userinfo@]host[:port]
|
williamr@2
|
104 |
|
williamr@2
|
105 |
@warning The descriptor that is parsed by an object of this class will be referenced
|
williamr@2
|
106 |
by that object. If the original descriptor is no longer in scope there will be undefined
|
williamr@2
|
107 |
behaviour.
|
williamr@2
|
108 |
@publishedAll
|
williamr@2
|
109 |
@deprecated Deprecated in 9.1. Use UriUtils::CreateAuthorityL() instead
|
williamr@2
|
110 |
@since 6.0
|
williamr@2
|
111 |
*/
|
williamr@2
|
112 |
class TAuthorityParser16 : public TAuthorityC16
|
williamr@2
|
113 |
{
|
williamr@2
|
114 |
public: // Methods
|
williamr@2
|
115 |
|
williamr@2
|
116 |
IMPORT_C TAuthorityParser16();
|
williamr@2
|
117 |
IMPORT_C TInt Parse(const TDesC16& aAuthority);
|
williamr@2
|
118 |
|
williamr@2
|
119 |
};
|
williamr@2
|
120 |
|
williamr@2
|
121 |
/**
|
williamr@2
|
122 |
Dependencies : CBase, TAuthorityC16.
|
williamr@2
|
123 |
Comments : Provides modifying functionality on the components of an authority object, as
|
williamr@2
|
124 |
defined in RFC2396. There are 3 components; userinfo, host and port.
|
williamr@2
|
125 |
|
williamr@2
|
126 |
The object holds parsed authority information. It is owning. It uses 16-bit descriptors.
|
williamr@2
|
127 |
|
williamr@2
|
128 |
The functionality provided by this API allows the authority components to be set or removed
|
williamr@2
|
129 |
from this parsed authority. Also, it provides a reference to TAuthorityC16 object so that
|
williamr@2
|
130 |
the non-modifying functionality can be used.
|
williamr@2
|
131 |
@publishedAll
|
williamr@2
|
132 |
@deprecated Deprecated in 9.1
|
williamr@2
|
133 |
@since 6.0
|
williamr@2
|
134 |
*/
|
williamr@2
|
135 |
class CAuthority16 : public CBase
|
williamr@2
|
136 |
{
|
williamr@2
|
137 |
public: // Methods
|
williamr@2
|
138 |
|
williamr@2
|
139 |
IMPORT_C static CAuthority16* NewL(const TAuthorityC16& aAuthority);
|
williamr@2
|
140 |
IMPORT_C static CAuthority16* NewLC(const TAuthorityC16& aAuthority);
|
williamr@2
|
141 |
IMPORT_C static CAuthority16* NewL();
|
williamr@2
|
142 |
IMPORT_C static CAuthority16* NewLC();
|
williamr@2
|
143 |
IMPORT_C ~CAuthority16();
|
williamr@2
|
144 |
|
williamr@2
|
145 |
IMPORT_C const TAuthorityC16& Authority() const;
|
williamr@2
|
146 |
IMPORT_C void SetComponentL(const TDesC16& aData, TAuthorityComponent aComponent);
|
williamr@2
|
147 |
IMPORT_C void SetAndEscapeComponentL(const TDesC16& aData, TAuthorityComponent aComponent);
|
williamr@2
|
148 |
IMPORT_C void RemoveComponentL(TAuthorityComponent aComponent);
|
williamr@2
|
149 |
|
williamr@2
|
150 |
private: // Methods
|
williamr@2
|
151 |
|
williamr@2
|
152 |
CAuthority16(const TAuthorityC16& aAuthority);
|
williamr@2
|
153 |
|
williamr@2
|
154 |
void ConstructL();
|
williamr@2
|
155 |
|
williamr@2
|
156 |
void FormAuthorityL();
|
williamr@2
|
157 |
|
williamr@2
|
158 |
private: // Attributes
|
williamr@2
|
159 |
|
williamr@2
|
160 |
/**
|
williamr@2
|
161 |
The descriptor buffer that contains the authority.
|
williamr@2
|
162 |
*/
|
williamr@2
|
163 |
HBufC16* iAuthorityBuf;
|
williamr@2
|
164 |
|
williamr@2
|
165 |
/**
|
williamr@2
|
166 |
The parsed authority object.
|
williamr@2
|
167 |
*/
|
williamr@2
|
168 |
TAuthorityC16 iAuthority;
|
williamr@2
|
169 |
|
williamr@2
|
170 |
/**
|
williamr@2
|
171 |
A friend class used for testing.
|
williamr@2
|
172 |
@see TAuthority16StateAccessor
|
williamr@2
|
173 |
@since 6.0
|
williamr@2
|
174 |
*/
|
williamr@2
|
175 |
friend class TAuthority16StateAccessor;
|
williamr@2
|
176 |
|
williamr@2
|
177 |
};
|
williamr@2
|
178 |
/**
|
williamr@2
|
179 |
Do not use. Use TAuthorityC8 instead
|
williamr@2
|
180 |
@publishedAll
|
williamr@2
|
181 |
@deprecated Deprecated in 9.1
|
williamr@2
|
182 |
*/
|
williamr@2
|
183 |
typedef TAuthorityC16 TAuthorityC;
|
williamr@2
|
184 |
|
williamr@2
|
185 |
/**
|
williamr@2
|
186 |
Do not use. Use TAuthorityParser8 instead
|
williamr@2
|
187 |
@publishedAll
|
williamr@2
|
188 |
@deprecated Deprecated in 9.1
|
williamr@2
|
189 |
*/
|
williamr@2
|
190 |
typedef TAuthorityParser16 TAuthorityParser;
|
williamr@2
|
191 |
|
williamr@2
|
192 |
/**
|
williamr@2
|
193 |
Do not use. Use CAuthority8 instead
|
williamr@2
|
194 |
@publishedAll
|
williamr@2
|
195 |
@deprecated Deprecated in 9.1
|
williamr@2
|
196 |
*/
|
williamr@2
|
197 |
typedef CAuthority16 CAuthority;
|
williamr@2
|
198 |
|
williamr@2
|
199 |
#endif // __AUTHORITY16_H__
|