ObjFW  Changes To API Review for 1.0

Changes to "API Review for 1.0" between 2021-04-07 20:53:20 and 2021-04-07 21:16:38

1
2
3
4
5
6
7
8
9
10


11
12
13
14
15
16
17




18
19
20
21
22


23
24
25

26
27

28
29

30
31
32
33
34
35



36
37
38
39
40
41
42






43
44
45


46
47
48


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

65
66
67
68
69
70
71
1
2
3
4
5
6
7
8


9
10
11
12





13
14
15
16
17
18
19


20
21
22
23

24
25

26
27

28
29
30
31



32
33
34
35






36
37
38
39
40
41
42


43
44



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

62
63
64
65
66
67
68
69








-
-
+
+


-
-
-
-
-
+
+
+
+



-
-
+
+


-
+

-
+

-
+



-
-
-
+
+
+

-
-
-
-
-
-
+
+
+
+
+
+

-
-
+
+
-
-
-
+
+















-
+







# API Review for 1.0

For the 1.0 release, all APIs should be reviewed, as starting 1.0, they are supposed to be stable.

Right now, we have fhe following:

## Protocols

* ❌ OFApplicationDelegate 
* ✅ OFCollection 
* ❌ OFApplicationDelegate
* ✅ OFCollection
* ✅ OFComparing
* ✅ OFCopying
* ❌ OFCryptoHash
  * Should be renamed to OFCryptographicHash
* ❌ OFDatagramSocketDelegate 
* ❌ OFDNSResolverHostDelegate 
* ❌ OFDNSResolverQueryDelegate 
* ✅ OFCryptographicHash
* ❌ OFDatagramSocketDelegate
* ❌ OFDNSResolverHostDelegate
* ❌ OFDNSResolverQueryDelegate
* ✅ OFEnumeration
* ✅ OFFastEnumeration
  * API given by the compiler
* ❌ OFHTTPClientDelegate 
* ❌ OFHTTPServerDelegate 
* ❌ OFHTTPClientDelegate
* ❌ OFHTTPServerDelegate
* ✅ OFIPSocketAsyncConnecting
  * Private
* ❌ OFIPXSocketDelegate 
* ❌ OFIPXSocketDelegate
* ❌ OFJSONRepresentation
* ❌ OFKernelEventObserverDelegate 
* ❌ OFKernelEventObserverDelegate
* ❌ OFKeyValueCoding
* ✅ OFLocking 
* ✅ OFLocking
* ❌ OFMessagePackRepresentation
* ✅ OFMutableCopying
* ❌ OFObject
* ❌ OFReadyForReadingObserving 
* ❌ OFReadyForWritingObserving 
* ❌ OFSequencedPacketSocketDelegate 
* ❌ OFReadyForReadingObserving
* ❌ OFReadyForWritingObserving
* ❌ OFSequencedPacketSocketDelegate
* ❌ OFSerialization
* ❌ OFSPXSocketDelegate 
* ❌ OFSPXStreamSocketDelegate 
* ❌ OFStreamDelegate 
* ❌ OFStreamSocketDelegate 
* ❌ OFStringXMLUnescapingDelegate 
* ❌ OFTCPSocketDelegate 
* ❌ OFSPXSocketDelegate
* ❌ OFSPXStreamSocketDelegate
* ❌ OFStreamDelegate
* ❌ OFStreamSocketDelegate
* ❌ OFStringXMLUnescapingDelegate
* ❌ OFTCPSocketDelegate
* ❌ OFTLSSocket
* ❌ OFTLSSocketDelegate 
* ❌ OFUDPSocketDelegate 
* ❌ OFTLSSocketDelegate
* ❌ OFUDPSocketDelegate
* ❌ OFUNIXDatagramSocketDelegate 
* ❌ OFXMLElementBuilderDelegate 
* ❌ OFXMLParserDelegate 
* ❌ OFXMLElementBuilderDelegate
* ❌ OFXMLParserDelegate

## Classes

* ✅ NSString
  * Fake class has no API and is only used to make string boxing via `@(cString)` work.
* ❌ OFAAAADNSResourceRecord
* ❌ OFAcceptFailedException
* ✅ OFAdjacentArray
  * Private
* ✅ OFAdjacentSubarray
  * Private
* ❌ OFADNSResourceRecord
* ❌ OFAllocFailedException
* ❌ OFAlreadyConnectedException
* ❌ OFApplication
* ❌ OFArray 
* ❌ OFArray
* ❌ OFBindFailedException
* ✅ OFBitSetCharacterSet
  * Private
* ✅ OFBlock
  * Has no API
* ✅ OFBytesValue
  * Private
81
82
83
84
85
86
87
88

89
90
91
92
93

94
95
96
97
98
99

100
101
102
103
104
105
106
107
108
109
110
111

112
113
114
115
116
117
118
79
80
81
82
83
84
85

86
87
88
89
90

91
92
93
94
95
96

97
98
99
100
101
102
103
104
105
106
107
108

109
110
111
112
113
114
115
116







-
+




-
+





-
+











-
+







* ❌ OFConditionStillWaitingException
* ❌ OFConditionWaitFailedException
* ❌ OFConnectionFailedException
* ❌ OFConstantString
* ❌ OFCopyItemFailedException
* ✅ OFCountedMapTableSet
  * Private
* ❌ OFCountedSet 
* ❌ OFCountedSet
* ❌ OFCreateDirectoryFailedException
* ❌ OFCreateSymbolicLinkFailedException
* ❌ OFCreateWindowsRegistryKeyFailedException
* ❌ OFData
* ✅ OFData (CryptoHashing)
* ✅ OFData (CryptographicHashing)
* ❌ OFDatagramSocket
* ❌ OFData (MessagePackParsing)
* ❌ OFDate
* ❌ OFDeleteWindowsRegistryKeyFailedException
* ❌ OFDeleteWindowsRegistryValueFailedException
* ❌ OFDictionary 
* ❌ OFDictionary
* ❌ OFDictionary (FileAttributes)
* ✅ OFDimensionValue
  * Private
* ❌ OFDNSQuery
* ❌ OFDNSQueryFailedException
* ❌ OFDNSResolver
* ✅ OFDNSResolverSettings
  * Private
* ❌ OFDNSResourceRecord
* ❌ OFDNSResponse
* ❌ OFEnumerationMutationException
* ❌ OFEnumerator 
* ❌ OFEnumerator
* ✅ OFEpollKernelEventObserver
  * Private
* ❌ OFException
* ❌ OFFile
* ❌ OFFileManager
* ✅ OFFileURLHandler
  * Private
158
159
160
161
162
163
164
165

166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

187
188

189
190
191
192
193
194
195


196
197
198

199
200
201
202
203
204
205
156
157
158
159
160
161
162

163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

184
185

186
187
188
189
190
191


192
193
194
195

196
197
198
199
200
201
202
203







-
+




















-
+

-
+





-
-
+
+


-
+







* ✅ OFKqueueKernelEventObserver
  * Private
* ❌ OFLHAArchive
* ❌ OFLHAArchiveEntry
* ✅ OFLHADecompressingStream
  * Private
* ❌ OFLinkFailedException
* ❌ OFList 
* ❌ OFList
* ❌ OFListenFailedException
* ❌ OFLoadPluginFailedException
* ❌ OFLocale
* ❌ OFLockFailedException
* ❌ OFMalformedXMLException
* ✅ OFMallocBlock
  * Doesn't have an API
* ❌ OFMapTable
* ✅ OFMapTableDictionary
  * Private
* ❌ OFMapTableEnumerator
* ✅ OFMapTableSet
  * Private
* ❌ OFMD5Hash
* ❌ OFMemoryNotPartOfObjectException
* ❌ OFMessagePackExtension
* ❌ OFMethodSignature
* ❌ OFMoveItemFailedException
* ✅ OFMutableAdjacentArray
  * Private
* ❌ OFMutableArray 
* ❌ OFMutableArray
* ❌ OFMutableData
* ❌ OFMutableDictionary 
* ❌ OFMutableDictionary
* ❌ OFMutableLHAArchiveEntry
* ✅ OFMutableMapTableDictionary
  * Private
* ✅ OFMutableMapTableSet
  * Private
* ❌ OFMutablePair 
* ❌ OFMutableSet 
* ❌ OFMutablePair
* ❌ OFMutableSet
* ❌ OFMutableString
* ❌ OFMutableTarArchiveEntry
* ❌ OFMutableTriple 
* ❌ OFMutableTriple
* ❌ OFMutableURL
* ✅ OFMutableUTF8String
  * Private
* ❌ OFMutableZIPArchiveEntry
* ❌ OFMutex
* ❌ OFMXDNSResourceRecord
* ✅ OFNonretainedObjectValue
214
215
216
217
218
219
220
221

222
223
224
225
226
227
228
212
213
214
215
216
217
218

219
220
221
222
223
224
225
226







-
+







* ❌ OFObject (OFSerialization)
* ❌ OFObserveFailedException
* ❌ OFOpenItemFailedException
* ❌ OFOpenWindowsRegistryKeyFailedException
* ❌ OFOptionsParser
* ❌ OFOutOfMemoryException
* ❌ OFOutOfRangeException
* ❌ OFPair 
* ❌ OFPair
* ❌ OFPlugin
* ✅ OFPointerValue
  * Private
* ✅ OFPointValue
  * Private
* ✅ OFPollKernelEventObserver
  * Private
248
249
250
251
252
253
254
255

256
257
258
259
260
261
262
263
264
265
266
267
268

269
270
271
272
273
274
275
276
277
278
279

280
281
282
283
284
285
286
246
247
248
249
250
251
252

253
254
255
256
257
258
259
260
261
262
263
264
265

266
267
268
269
270
271
272
273
274
275
276

277
278
279
280
281
282
283
284







-
+












-
+










-
+







  * Private in 1.0 (but public in trunk)
* ❌ OFSecureData
* ❌ OFSeekableStream
* ❌ OFSeekFailedException
* ✅ OFSelectKernelEventObserver
  * Private
* ❌ OFSequencedPacketSocket
* ❌ OFSet 
* ❌ OFSet
* ❌ OFSetItemAttributesFailedException
* ❌ OFSetOptionFailedException
* ❌ OFSettings
* ❌ OFSetWindowsRegistryValueFailedException
* ❌ OFSHA1Hash
* ❌ OFSHA224Hash
* ❌ OFSHA224Or256Hash
* ❌ OFSHA256Hash
* ❌ OFSHA384Hash
* ❌ OFSHA384Or512Hash
* ❌ OFSHA512Hash
* ❌ OFSOADNSResourceRecord
* ❌ OFSortedList 
* ❌ OFSortedList
* ❌ OFSPXSocket
* ❌ OFSPXStreamSocket
* ❌ OFSRVDNSResourceRecord
* ✅ OFStackBlock
  * Doesn't have an API
* ❌ OFStdIOStream
* ❌ OFStillLockedException
* ❌ OFStream
* ❌ OFStreamSocket
* ❌ OFString
* ✅ OFString (CryptoHashing)
* ✅ OFString (CryptographicHashing)
* ❌ OFString (JSONParsing)
* ❌ OFString (PathAdditions)
* ❌ OFString (PropertyListParsing)
* ❌ OFString (Serialization)
* ❌ OFString (URLEncoding)
* ❌ OFString (XMLEscaping)
* ❌ OFString (XMLUnescaping)
294
295
296
297
298
299
300
301

302
303
304
305
306
307
308
292
293
294
295
296
297
298

299
300
301
302
303
304
305
306







-
+







* ✅ OFTCPSocketSOCKS5Connector
  * Private
* ❌ OFThread
* ❌ OFThreadJoinFailedException
* ❌ OFThreadStartFailedException
* ❌ OFThreadStillRunningException
* ❌ OFTimer
* ❌ OFTriple 
* ❌ OFTriple
* ❌ OFTruncatedDataException
* ❌ OFTXTDNSResourceRecord
* ❌ OFUDPSocket
* ❌ OFUnboundNamespaceException
* ❌ OFUnboundPrefixException
* ❌ OFUndefinedKeyException
* ❌ OFUnknownXMLEntityException