ObjFW  Check-in [0fd2b1b4c8]

Overview
Comment:OFSCTPSocket: Use a dictionary for message info

This is more extensible. Without this, extending it later would result
in an API and ABI breakage.

Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | sctp
Files: files | file ages | folders
SHA3-256: 0fd2b1b4c8e3bd75ee619df563752d9028c4d8cbb99fe05dee3ab8793ad346ab
User & Date: js on 2024-05-04 20:05:40
Other Links: branch diff | manifest | tags
Context
2024-05-04
20:06
Add support for SCTP sockets check-in: fef7240652 user: js tags: trunk
20:05
OFSCTPSocket: Use a dictionary for message info Closed-Leaf check-in: 0fd2b1b4c8 user: js tags: sctp
2024-05-01
23:23
OFSCTPSocket: Rename packet to message check-in: 816c13da9b user: js tags: sctp
Changes

Modified src/OFRunLoop+Private.h from [a9ea36d376] to [80e1bfb64f].

134
135
136
137
138
139
140
141
142
143

144
145
146
147
148
149
150
151
152
153
154
155
134
135
136
137
138
139
140



141
142
143
144
145
146
147
148
149
150
151
152
153







-
-
-
+












      mode: (OFRunLoopMode)mode
#  ifdef OF_HAVE_BLOCKS
     block: (nullable OFSCTPSocketAsyncReceiveBlock)block
#  endif
  delegate: (nullable id <OFSCTPSocketDelegate>)delegate;
+ (void)of_addAsyncSendForSCTPSocket: (OFSCTPSocket *)socket
      data: (OFData *)data
  streamID: (uint16_t)streamID
      PPID: (uint32_t)PPID
     flags: (OFSCTPMessageFlags)flags
      info: (OFSCTPMessageInfo)info
      mode: (OFRunLoopMode)mode
# ifdef OF_HAVE_BLOCKS
     block: (nullable OFSCTPSocketAsyncSendDataBlock)block
# endif
  delegate: (nullable id <OFSCTPSocketDelegate>)delegate;
# endif
+ (void)of_cancelAsyncRequestsForObject: (id)object mode: (OFRunLoopMode)mode;
#endif
- (void)of_removeTimer: (OFTimer *)timer forMode: (OFRunLoopMode)mode;
@end

OF_ASSUME_NONNULL_END

Modified src/OFRunLoop.m from [0a75a2f08b] to [f56fb160b7].

218
219
220
221
222
223
224
225
226
227

228
229
230
231
232
233
234
218
219
220
221
222
223
224



225
226
227
228
229
230
231
232







-
-
-
+







@interface OFRunLoopSCTPSendQueueItem: OFRunLoopQueueItem
{
@public
#  ifdef OF_HAVE_BLOCKS
	OFSCTPSocketAsyncSendDataBlock _block;
#  endif
	OFData *_data;
	uint16_t _streamID;
	uint32_t _PPID;
	OFSCTPMessageFlags _flags;
	OFSCTPMessageInfo _info;
}
@end
# endif
#endif

@implementation OFRunLoopState
- (instancetype)init
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045

1046
1047
1048
1049
1050
1051
1052

1053
1054
1055
1056
1057
1058
1059
1060
1061

1062
1063
1064
1065


1066
1067
1068
1069
1070
1071
1072
1073

1074
1075
1076
1077
1078
1079
1080
1081
1034
1035
1036
1037
1038
1039
1040



1041
1042
1043
1044
1045
1046


1047

1048
1049
1050
1051
1052
1053
1054

1055
1056
1057


1058
1059

1060
1061
1062
1063
1064


1065

1066
1067
1068
1069
1070
1071
1072







-
-
-
+





-
-
+
-







-
+


-
-
+
+
-





-
-
+
-







@end

# ifdef OF_HAVE_SCTP
@implementation OFRunLoopSCTPReceiveQueueItem
- (bool)handleObject: (id)object
{
	size_t length;
	uint16_t streamID;
	uint32_t PPID;
	OFSCTPMessageFlags flags;
	OFSCTPMessageInfo info;
	id exception = nil;

	@try {
		length = [object receiveIntoBuffer: _buffer
					    length: _length
					  streamID: &streamID
					      PPID: &PPID
					      info: &info];
					     flags: &flags];
	} @catch (id e) {
		length = 0;
		exception = e;
	}

#  ifdef OF_HAVE_BLOCKS
	if (_block != NULL)
		return _block(length, streamID, PPID, flags, exception);
		return _block(length, info, exception);
	else {
#  endif
		if (![_delegate respondsToSelector: @selector(socket:
		    didReceiveIntoBuffer:length:streamID:PPID:flags:
		if (![_delegate respondsToSelector: @selector(
		    socket:didReceiveIntoBuffer:length:info:exception:)])
		    exception:)])
			return false;

		return [_delegate socket: object
		    didReceiveIntoBuffer: _buffer
				  length: length
				streamID: streamID
				    PPID: PPID
				    info: info
				   flags: flags
			       exception: exception];
#  ifdef OF_HAVE_BLOCKS
	}
#  endif
}

# ifdef OF_HAVE_BLOCKS
1093
1094
1095
1096
1097
1098
1099
1100
1101

1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122


1123
1124
1125
1126
1127
1128

1129
1130
1131
1132
1133
1134
1135
1136
1084
1085
1086
1087
1088
1089
1090


1091

1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109


1110
1111
1112
1113
1114
1115


1116

1117
1118
1119
1120
1121
1122
1123







-
-
+
-


















-
-
+
+




-
-
+
-







{
	id exception = nil;
	OFData *newData, *oldData;

	@try {
		[object sendBuffer: _data.items
			    length: _data.count * _data.itemSize
			  streamID: _streamID
			      PPID: _PPID
			      info: _info];
			     flags: _flags];
	} @catch (id e) {
		exception = e;
	}

#  ifdef OF_HAVE_BLOCKS
	if (_block != NULL) {
		newData = _block(exception);

		if (newData == nil)
			return false;

		oldData = _data;
		_data = [newData copy];
		[oldData release];

		return true;
	} else {
#  endif
		if (![_delegate respondsToSelector: @selector(socket:
		    didSendData:streamID:PPID:flags:exception:)])
		if (![_delegate respondsToSelector: @selector(
		    socket:didSendData:info:exception:)])
			return false;

		newData = [_delegate socket: object
				didSendData: _data
				   streamID: _streamID
				       PPID: _PPID
				       info: _info
				      flags: _flags
				  exception: exception];

		if (newData == nil)
			return false;

		oldData = _data;
		_data = [newData copy];
1144
1145
1146
1147
1148
1149
1150

1151
1152
1153
1154
1155
1156
1157
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145







+








- (void)dealloc
{
	[_data release];
# ifdef OF_HAVE_BLOCKS
	[_block release];
# endif
	[_info release];

	[super dealloc];
}
@end
# endif
#endif

1482
1483
1484
1485
1486
1487
1488
1489
1490
1491

1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506

1507
1508
1509
1510
1511
1512
1513
1514
1470
1471
1472
1473
1474
1475
1476



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490


1491

1492
1493
1494
1495
1496
1497
1498







-
-
-
+













-
-
+
-







	queueItem->_length = length;

	QUEUE_ITEM
}

+ (void)of_addAsyncSendForSCTPSocket: (OFSCTPSocket *)sock
				data: (OFData *)data
			    streamID: (uint16_t)streamID
				PPID: (uint32_t)PPID
			       flags: (OFSCTPMessageFlags)flags
				info: (OFSCTPMessageInfo)info
				mode: (OFRunLoopMode)mode
# ifdef OF_HAVE_BLOCKS
			       block: (OFSCTPSocketAsyncSendDataBlock)block
# endif
			    delegate: (id <OFSCTPSocketDelegate>)delegate
{
	NEW_WRITE(OFRunLoopSCTPSendQueueItem, sock, mode)

	queueItem->_delegate = [delegate retain];
# ifdef OF_HAVE_BLOCKS
	queueItem->_block = [block copy];
# endif
	queueItem->_data = [data copy];
	queueItem->_streamID = streamID;
	queueItem->_PPID = PPID;
	queueItem->_info = [info copy];
	queueItem->_flags = flags;

	QUEUE_ITEM
}
# endif
# undef NEW_READ
# undef NEW_WRITE
# undef QUEUE_ITEM

Modified src/OFSCTPSocket.h from [2e3d49a6fe] to [48237f617c].

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
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87



88
89
90
91
92


93
94
95
96
97
98
99
100
101







+




-
+
+
+
+
+
+
+

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














-
-
-
+




-
-
+
+







#import "OFSequencedPacketSocket.h"
#import "OFRunLoop.h"

OF_ASSUME_NONNULL_BEGIN

/** @file */

@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFSCTPSocket;
@class OFString;

/**
 * @brief Flags for an SCTP message.
 * @brief A key for the SCTP message info.
 *
 * Possible values are:
 *
 *   * @ref OFSCTPStreamID
 *   * @ref OFSCTPPPID
 *   * @ref OFSCTPUnordered
 */
typedef enum {
	/** The message is sent / received out of order. */
	OFSCTPMessageUnordered = 1
} OFSCTPMessageFlags;
typedef OFConstantString *OFSCTPMessageInfoKey;

/**
 * @brief A dictionary mapping keys of type @ref OFSCTPMessageInfoKey to their
 *	  values.
 */
typedef OFDictionary OF_GENERIC(OFSCTPMessageInfoKey, id) *OFSCTPMessageInfo;

#ifdef __cplusplus
extern "C" {
#endif
/**
 * @brief The SCTP stream ID for which the message was send / received.
 *
 * This is an `uint16_t` wrapped in an @ref OFNumber.
 */
extern const OFSCTPMessageInfoKey OFSCTPStreamID;

/**
 * @brief The Payload Protocol Identifier for the message.
 *
 * This is an `uint32_t` wrapped in an @ref OFNumber.
 */
extern const OFSCTPMessageInfoKey OFSCTPPPID;

/**
 * @brief Whether the message is send / received out of order.
 *
 * Possible values are an @ref OFNumber with either `true` or `false`.
 */
extern const OFSCTPMessageInfoKey OFSCTPUnordered;
#ifdef __cplusplus
}
#endif

#ifdef OF_HAVE_BLOCKS
/**
 * @brief A block which is called when the socket connected.
 *
 * @param exception An exception which occurred while connecting the socket or
 *		    `nil` on success
 */
typedef void (^OFSCTPSocketAsyncConnectBlock)(id _Nullable exception);

/**
 * @brief A block which is called when a message has been received.
 *
 * @param length The length of the message
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 * @param exception An exception which occurred while receiving or `nil` on
 *		    success
 * @return A bool whether the same block should be used for the next receive
 */
typedef bool (^OFSCTPSocketAsyncReceiveBlock)(size_t length, uint16_t streamID,
    uint32_t PPID, OFSCTPMessageFlags flags, id _Nullable exception);
typedef bool (^OFSCTPSocketAsyncReceiveBlock)(size_t length,
    OFSCTPMessageInfo info, id _Nullable exception);

/**
 * @brief A block which is called when a message has been sent.
 *
 * @param exception An exception which occurred while reading or `nil` on
 *		    success
 * @return The data to repeat the send with or nil if it should not repeat
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
119
120
121

122
123
124
125
126
127
128
129

130
131
132
133
134
135
136
127
128
129
130
131
132
133



134
135
136
137
138
139
140
141



142
143
144
145
146
147
148
149



150
151
152
153
154
155



156
157
158
159
160
161
162
163







-
-
-
+







-
-
-
+







-
-
-
+





-
-
-
+








/**
 * @brief This method is called when a message has been received.
 *
 * @param socket The SCTP socket which received a message
 * @param buffer The buffer the message has been written to
 * @param length The length of the message
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 * @param exception An exception that occurred while receiving, or nil on
 *		    success
 * @return A bool whether the same block should be used for the next receive
 */
-	  (bool)socket: (OFSCTPSocket *)socket
  didReceiveIntoBuffer: (void *)buffer
		length: (size_t)length
	      streamID: (uint16_t)streamID
		  PPID: (uint32_t)PPID
		 flags: (OFSCTPMessageFlags)flags
		  info: (nullable OFSCTPMessageInfo)info
	     exception: (nullable id)exception;

/**
 * @brief This method is called when a message has been sent.
 *
 * @param socket The SCTP socket which sent a message
 * @param data The data which was sent
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 * @param exception An exception that occurred while sending, or nil on success
 * @return The data to repeat the send with or nil if it should not repeat
 */
- (nullable OFData *)socket: (OFSCTPSocket *)socket
		didSendData: (OFData *)data
		   streamID: (uint16_t)streamID
		       PPID: (uint32_t)PPID
		      flags: (OFSCTPMessageFlags)flags
		       info: (nullable OFSCTPMessageInfo)info
		  exception: (nullable id)exception;
@end

/**
 * @class OFSCTPSocket OFSCTPSocket.h ObjFW/OFSCTPSocket.h
 *
 * @brief A class which provides methods to create and use SCTP sockets in
234
235
236
237
238
239
240
241
242
243

244
245
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


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302


303
304
305
306
307
308
309
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
287
288
289
290


291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324


325
326
327
328
329
330
331
332
333







-
-
-
+






-
-
+
+
-


-
-
+
+










-
-
+
+














-
-
+
+
















-
-
+
+







 * @brief Receives a message for the specified stream ID and stores it into the
 *	  specified buffer.
 *
 * If the buffer is too small, the message is truncated.
 *
 * @param buffer The buffer to write the message to
 * @param length The length of the buffer
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 * @return The length of the received message
 * @throw OFReadFailedException Receiving failed
 * @throw OFNotOpenException The socket is not open
 */
- (size_t)receiveIntoBuffer: (void *)buffer
		     length: (size_t)length
		   streamID: (nullable uint16_t *)streamID
		       PPID: (nullable uint32_t *)PPID
		       info: (__autoreleasing _Nullable OFSCTPMessageInfo
				 *_Nullable)info;
		      flags: (nullable OFSCTPMessageFlags *)flags;

/**
 * @brief Asynchronously receives a message with stream ID and PPID and stores
 *	  it into the specified buffer.
 * @brief Asynchronously receives a message and stores it into the specified
 *	  buffer.
 *
 * If the buffer is too small, the message is truncated.
 *
 * @param buffer The buffer to write the message to
 * @param length The length of the buffer
 */
- (void)asyncReceiveWithInfoIntoBuffer: (void *)buffer
				length: (size_t)length;

/**
 * @brief Asynchronously receives a message with stream ID and PPID and stores
 *	  it into the specified buffer.
 * @brief Asynchronously receives a message and stores it into the specified
 *	  buffer.
 *
 * If the buffer is too small, the message is truncated.
 *
 * @param buffer The buffer to write the message to
 * @param length The length of the buffer
 * @param runLoopMode The run loop mode in which to perform the asynchronous
 *		      receive
 */
- (void)asyncReceiveWithInfoIntoBuffer: (void *)buffer
				length: (size_t)length
			   runLoopMode: (OFRunLoopMode)runLoopMode;

#ifdef OF_HAVE_BLOCKS
/**
 * @brief Asynchronously receives a message with stream ID and PPID and stores
 *	  it into the specified buffer.
 * @brief Asynchronously receives a message and stores it into the specified
 *	  buffer.
 *
 * If the buffer is too small, the message is truncated.
 *
 * @param buffer The buffer to write the message to
 * @param length The length of the buffer
 * @param block The block to call when the message has been received. If the
 *		block returns true, it will be called again with the same
 *		buffer and maximum length when more messages have been received.
 *		If you want the next method in the queue to handle the message
 *		received next, you need to return false from the method.
 */
- (void)asyncReceiveWithInfoIntoBuffer: (void *)buffer
				length: (size_t)length
				 block: (OFSCTPSocketAsyncReceiveBlock)block;

/**
 * @brief Asynchronously receives a message with stream ID and PPID and stores
 *	  it into the specified buffer.
 * @brief Asynchronously receives a message and stores it into the specified
 *	  buffer.
 *
 * If the buffer is too small, the message is truncated.
 *
 * @param buffer The buffer to write the message to
 * @param length The length of the buffer
 * @param runLoopMode The run loop mode in which to perform the asynchronous
 *		      receive
320
321
322
323
324
325
326
327
328
329

330
331
332
333
334
335
336
337

338
339
340
341
342
343
344
345

346
347

348
349
350
351
352
353
354
355
356
357
358

359
360
361
362
363
364
365

366
367
368
369
370
371
372
373
374
375

376
377
378
379
380
381
382
383

384
385
386
387
388
389
390
391
392

393
394
395
396
397
398
399
400
401
402

403
404
405
406
407
408
344
345
346
347
348
349
350



351
352
353
354
355
356



357
358
359
360
361
362



363
364

365



366
367
368
369
370



371
372
373
374
375



376
377
378
379
380
381
382
383



384
385
386
387
388
389



390
391
392
393
394
395
396



397
398
399
400
401
402
403
404



405
406
407
408
409
410
411







-
-
-
+





-
-
-
+





-
-
-
+

-
+
-
-
-





-
-
-
+




-
-
-
+







-
-
-
+





-
-
-
+






-
-
-
+







-
-
-
+






#endif

/**
 * @brief Sends the specified message on the specified stream.
 *
 * @param buffer The buffer to send as a message
 * @param length The length of the buffer
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 * @throw OFWriteFailedException Sending failed
 * @throw OFNotOpenException The socket is not open
 */
- (void)sendBuffer: (const void *)buffer
	    length: (size_t)length
	  streamID: (uint16_t)streamID
	      PPID: (uint32_t)PPID
	     flags: (OFSCTPMessageFlags)flags;
	      info: (nullable OFSCTPMessageInfo)info;

/**
 * @brief Asynchronously sends the specified message on the specified stream.
 *
 * @param data The data to send as a message
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 */
- (void)asyncSendData: (OFData *)data
- (void)asyncSendData: (OFData *)data info: (nullable OFSCTPMessageInfo)info;
	     streamID: (uint16_t)streamID
		 PPID: (uint32_t)PPID
		flags: (OFSCTPMessageFlags)flags;

/**
 * @brief Asynchronously sends the specified message on the specified stream.
 *
 * @param data The data to send as a message
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 * @param runLoopMode The run loop mode in which to perform the asynchronous
 *		      send
 */
- (void)asyncSendData: (OFData *)data
	     streamID: (uint16_t)streamID
		 PPID: (uint32_t)PPID
		flags: (OFSCTPMessageFlags)flags
		 info: (nullable OFSCTPMessageInfo)info
	  runLoopMode: (OFRunLoopMode)runLoopMode;

#ifdef OF_HAVE_BLOCKS
/**
 * @brief Asynchronously sends the specified message on the specified stream.
 *
 * @param data The data to send as a message
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 * @param block The block to call when the message has been sent. It should
 *		return the data for the next send with the same callback or nil
 *		if it should not repeat.
 */
- (void)asyncSendData: (OFData *)data
	     streamID: (uint16_t)streamID
		 PPID: (uint32_t)PPID
		flags: (OFSCTPMessageFlags)flags
		 info: (nullable OFSCTPMessageInfo)info
		block: (OFSCTPSocketAsyncSendDataBlock)block;

/**
 * @brief Asynchronously sends the specified message on the specified stream.
 *
 * @param data The data to send as a message
 * @param streamID The stream ID for the message
 * @param PPID The Payload Protocol Identifier for the message
 * @param flags Flags for the message
 * @param info Information about the message, see @ref OFSCTPMessageInfo
 * @param runLoopMode The run loop mode in which to perform the asynchronous
 *		      send
 * @param block The block to call when the message has been sent. It should
 *		return the data for the next send with the same callback or nil
 *		if it should not repeat.
 */
- (void)asyncSendData: (OFData *)data
	     streamID: (uint16_t)streamID
		 PPID: (uint32_t)PPID
		flags: (OFSCTPMessageFlags)flags
		 info: (nullable OFSCTPMessageInfo)info
	  runLoopMode: (OFRunLoopMode)runLoopMode
		block: (OFSCTPSocketAsyncSendDataBlock)block;
#endif
@end

OF_ASSUME_NONNULL_END

Modified src/OFSCTPSocket.m from [908828903c] to [4453ea5c07].

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
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







+
+

















+
+
+
+







#endif

#import "OFSCTPSocket.h"
#import "OFAsyncIPSocketConnector.h"
#import "OFDNSResolver.h"
#import "OFData.h"
#import "OFDate.h"
#import "OFDictionary.h"
#import "OFNumber.h"
#import "OFRunLoop.h"
#import "OFRunLoop+Private.h"
#import "OFSocket.h"
#import "OFSocket+Private.h"
#import "OFString.h"
#import "OFThread.h"

#import "OFAcceptSocketFailedException.h"
#import "OFAlreadyOpenException.h"
#import "OFBindIPSocketFailedException.h"
#import "OFGetOptionFailedException.h"
#import "OFNotOpenException.h"
#import "OFOutOfRangeException.h"
#import "OFReadFailedException.h"
#import "OFSetOptionFailedException.h"
#import "OFWriteFailedException.h"

const OFSCTPMessageInfoKey OFSCTPStreamID = @"OFSCTPStreamID";
const OFSCTPMessageInfoKey OFSCTPPPID = @"OFSCTPPPID";
const OFSCTPMessageInfoKey OFSCTPUnordered = @"OFSCTPUnordered";

static const OFRunLoopMode connectRunLoopMode =
    @"OFSCTPSocketConnectRunLoopMode";

@interface OFSCTPSocket () <OFAsyncIPSocketConnecting>
@end

@interface OFSCTPSocketConnectDelegate: OFObject <OFSCTPSocketDelegate>
341
342
343
344
345
346
347
348

349
350
351
352
353
354
355
356
357
358
359

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380

381
382
383



384
385
386
387

388
389
390
391

392
393
394
395




396
397
398
399


400
401
402



403
404
405
406
407
408
409
347
348
349
350
351
352
353

354




355
356
357
358



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379

380
381


382
383
384




385




386




387
388
389
390




391
392



393
394
395
396
397
398
399
400
401
402







-
+
-
-
-
-




-
-
-
+




















-
+

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








	return accepted;
}
#endif

- (size_t)receiveIntoBuffer: (void *)buffer length: (size_t)length
{
	return [self receiveIntoBuffer: buffer
	return [self receiveIntoBuffer: buffer length: length info: NULL];
				length: length
			      streamID: NULL
				  PPID: NULL
				 flags: NULL];
}

- (size_t)receiveIntoBuffer: (void *)buffer
		     length: (size_t)length
		   streamID: (uint16_t *)streamID
		       PPID: (uint32_t *)PPID
		      flags: (OFSCTPMessageFlags *)flags
		       info: (OFSCTPMessageInfo *)info
{
	ssize_t ret;
	struct iovec iov = {
		.iov_base = buffer,
		.iov_len = length
	};
	struct sctp_rcvinfo rcvinfo;
	socklen_t rcvinfoSize = (socklen_t)sizeof(rcvinfo);
	unsigned int infotype = SCTP_RECVV_RCVINFO;

	if (_socket == OFInvalidSocketHandle)
		@throw [OFNotOpenException exceptionWithObject: self];

	if ((ret = sctp_recvv(_socket, &iov, 1, NULL, 0, &rcvinfo, &rcvinfoSize,
	    &infotype, 0)) < 0)
		@throw [OFReadFailedException
		    exceptionWithObject: self
			requestedLength: length
				  errNo: _OFSocketErrNo()];

	if (streamID != NULL) {
	if (info != NULL) {
		if (infotype == SCTP_RECVV_RCVINFO &&
		    rcvinfoSize >= (socklen_t)sizeof(rcvinfo))
			*streamID = rcvinfo.rcv_sid;
		    rcvinfoSize >= (socklen_t)sizeof(rcvinfo)) {
			OFNumber *streamID = [OFNumber numberWithUnsignedShort:
			    rcvinfo.rcv_sid];
		else
			*streamID = 0;
	}

			OFNumber *PPID = [OFNumber numberWithUnsignedLong:
	if (PPID != NULL) {
		if (infotype == SCTP_RECVV_RCVINFO &&
		    rcvinfoSize >= (socklen_t)sizeof(rcvinfo))
			*PPID = rcvinfo.rcv_ppid;
			    rcvinfo.rcv_ppid];
		else
			*PPID = 0;
	}

			OFNumber *unordered = [OFNumber numberWithBool:
			    (rcvinfo.rcv_flags & SCTP_UNORDERED)];

			*info = [OFDictionary dictionaryWithKeysAndObjects:
	if (flags != NULL) {
		*flags = 0;

		if (infotype == SCTP_RECVV_RCVINFO &&
			    OFSCTPStreamID, streamID,
			    OFSCTPPPID, PPID,
		    rcvinfoSize >= (socklen_t)sizeof(rcvinfo) &&
		    rcvinfo.rcv_flags & SCTP_UNORDERED)
			*flags |= OFSCTPMessageUnordered;
			    OFSCTPUnordered, unordered, nil];
		} else
			*info = [OFDictionary dictionary];
	}

	return ret;
}

- (void)asyncReceiveWithInfoIntoBuffer: (void *)buffer
				length: (size_t)length
451
452
453
454
455
456
457
458

459
460
461
462
463
464
465

466
467
468
469
470
471
472
473
474




475
476

477
478
479
480
481
482
483
444
445
446
447
448
449
450

451
452
453
454
455



456
457
458
459
460
461
462
463


464
465
466
467
468

469
470
471
472
473
474
475
476







-
+




-
-
-
+







-
-
+
+
+
+

-
+







					     block: block
					  delegate: nil];
}
#endif

- (void)sendBuffer: (const void *)buffer length: (size_t)length
{
	[self sendBuffer: buffer length: length streamID: 0 PPID: 0 flags: 0];
	[self sendBuffer: buffer length: length info: nil];
}

- (void)sendBuffer: (const void *)buffer
	    length: (size_t)length
	  streamID: (uint16_t)streamID
	      PPID: (uint32_t)PPID
	     flags: (OFSCTPMessageFlags)flags
	      info: (OFSCTPMessageInfo)info
{
	ssize_t bytesWritten;
	struct iovec iov = {
		.iov_base = (void *)buffer,
		.iov_len = length
	};
	struct sctp_sndinfo sndinfo = {
		.snd_sid = streamID,
		.snd_ppid = PPID,
		.snd_sid = (uint16_t)
		    [[info objectForKey: OFSCTPStreamID] unsignedShortValue],
		.snd_ppid = (uint32_t)
		    [[info objectForKey: OFSCTPPPID] unsignedLongValue],
		.snd_flags =
		    ((flags & OFSCTPMessageUnordered) ? SCTP_UNORDERED : 0),
		    [[info objectForKey: OFSCTPUnordered] boolValue]
	};

	if (_socket == OFInvalidSocketHandle)
		@throw [OFNotOpenException exceptionWithObject: self];

	if (length > SSIZE_MAX)
		@throw [OFOutOfRangeException exception];
493
494
495
496
497
498
499
500

501
502
503
504
505

506
507
508
509
510
511
512
513
514
515

516
517
518
519
520
521

522
523
524
525
526
527
528
529
530
531
532
533
534

535
536
537
538
539

540
541
542
543
544
545
546
547
548

549
550
551
552
553
554
555

556
557
558
559
560
561
562
563
486
487
488
489
490
491
492

493



494

495




496
497
498



499
500
501
502
503


504

505
506
507
508
509
510
511
512
513



514
515
516
517


518

519
520
521
522
523



524
525
526
527
528
529


530

531
532
533
534
535
536
537







-
+
-
-
-

-
+
-
-
-
-



-
-
-
+




-
-
+
-









-
-
-
+



-
-
+
-





-
-
-
+





-
-
+
-







	if ((size_t)bytesWritten != length)
		@throw [OFWriteFailedException exceptionWithObject: self
						   requestedLength: length
						      bytesWritten: bytesWritten
							     errNo: 0];
}

- (void)asyncSendData: (OFData *)data
- (void)asyncSendData: (OFData *)data info: (OFSCTPMessageInfo)info
	     streamID: (uint16_t)streamID
		 PPID: (uint32_t)PPID
		flags: (OFSCTPMessageFlags)flags
{
	[self asyncSendData: data
	[self asyncSendData: data info: nil runLoopMode: OFDefaultRunLoopMode];
		   streamID: streamID
		       PPID: PPID
		      flags: flags
		runLoopMode: OFDefaultRunLoopMode];
}

- (void)asyncSendData: (OFData *)data
	     streamID: (uint16_t)streamID
		 PPID: (uint32_t)PPID
		flags: (OFSCTPMessageFlags)flags
		 info: (OFSCTPMessageInfo)info
	  runLoopMode: (OFRunLoopMode)runLoopMode
{
	[OFRunLoop of_addAsyncSendForSCTPSocket: self
					   data: data
				       streamID: streamID
					   PPID: PPID
					   info: info
					  flags: flags
					   mode: runLoopMode
# ifdef OF_HAVE_BLOCKS
					  block: NULL
# endif
				       delegate: _delegate];
}

#ifdef OF_HAVE_BLOCKS
- (void)asyncSendData: (OFData *)data
	     streamID: (uint16_t)streamID
		 PPID: (uint32_t)PPID
		flags: (OFSCTPMessageFlags)flags
		 info: (OFSCTPMessageInfo)info
		block: (OFSCTPSocketAsyncSendDataBlock)block
{
	[self asyncSendData: data
		   streamID: streamID
		       PPID: PPID
		       info: info
		      flags: flags
		runLoopMode: OFDefaultRunLoopMode
		      block: block];
}

- (void)asyncSendData: (OFData *)data
	     streamID: (uint16_t)streamID
		 PPID: (uint32_t)PPID
		flags: (OFSCTPMessageFlags)flags
		 info: (OFSCTPMessageInfo)info
	  runLoopMode: (OFRunLoopMode)runLoopMode
		block: (OFSCTPSocketAsyncSendDataBlock)block
{
	[OFRunLoop of_addAsyncSendForSCTPSocket: self
					   data: data
				       streamID: streamID
					   PPID: PPID
					   info: info
					  flags: flags
					   mode: runLoopMode
					  block: block
				       delegate: nil];
}
#endif

- (void)setCanDelaySendingMessages: (bool)canDelaySendingMessages

Modified tests/OFSCTPSocketTests.m from [4d2bc6e16e] to [749f241e9f].

30
31
32
33
34
35
36
37

38
39

40
41
42
43
44
45
46
30
31
32
33
34
35
36

37


38
39
40
41
42
43
44
45







-
+
-
-
+








@implementation OFSCTPSocketTests
- (void)testSCTPSocket
{
	OFSCTPSocket *server, *client, *accepted;
	OFSocketAddress address;
	char buffer[6];
	uint16_t streamID;
	OFNumber *streamID, *PPID, *unordered;
	uint32_t PPID;
	OFSCTPMessageFlags flags;
	OFSCTPMessageInfo sendInfo, receiveInfo;

	server = [OFSCTPSocket socket];
	client = [OFSCTPSocket socket];

	@try {
		address = [server bindToHost: @"127.0.0.1" port: 0];
	} @catch (OFBindSocketFailedException *e) {
57
58
59
60
61
62
63







64
65
66

67
68
69
70
71
72
73

74
75
76

77
78
79
80
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

72


73
74
75


76

77

78


79
80







+
+
+
+
+
+
+


-
+
-
-



-
-
+
-

-
+
-
-


	[client connectToHost: @"127.0.0.1"
			 port: OFSocketAddressIPPort(&address)];

	accepted = [server accept];
	OTAssertEqualObjects(OFSocketAddressString(accepted.remoteAddress),
	    @"127.0.0.1");

	streamID = [OFNumber numberWithUnsignedShort: 1];
	PPID = [OFNumber numberWithUnsignedLong: 1234];
	unordered = [OFNumber numberWithBool: true];
	sendInfo = [OFDictionary dictionaryWithKeysAndObjects:
	    OFSCTPStreamID, streamID,
	    OFSCTPPPID, PPID,
	    OFSCTPUnordered, unordered, nil];
	[client sendBuffer: "Hello!"
		    length: 6
		  streamID: 1
		      info: sendInfo];
		      PPID: 1234
		     flags: OFSCTPMessageUnordered];

	[accepted receiveIntoBuffer: buffer
			     length: 6
			   streamID: &streamID
			       PPID: &PPID
			       info: &receiveInfo];
			      flags: &flags];
	OTAssertEqual(memcmp(buffer, "Hello!", 6), 0);
	OTAssertEqual(streamID, 1);
	OTAssertEqualObjects(receiveInfo, sendInfo);
	OTAssertEqual(PPID, 1234);
	OTAssertTrue(flags & OFSCTPMessageUnordered);
}
@end