-
Notifications
You must be signed in to change notification settings - Fork 33
/
Packet.cpp
1701 lines (1350 loc) · 43.3 KB
/
Packet.cpp
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
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
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
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
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
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
310
311
312
313
314
315
316
317
318
319
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
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
477
478
479
480
481
482
483
484
485
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
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
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2000, 2017 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
/*
* @(#)Packet.cpp 1.19 06/26/07
*/
#include "Packet.hpp"
#include "PacketProperties.hpp"
#include "../util/UtilityMacros.h"
#include "../client/protocol/StubProtocolHandler.hpp"
#include "../cshim/mqheader-props.h"
#include "PacketFlag.hpp"
#include "PacketType.hpp"
#include <ctype.h>
/*
*
*/
Packet::Packet()
{
CHECK_OBJECT_VALIDITY();
this->init();
}
/*
*
*/
Packet::~Packet()
{
CHECK_OBJECT_VALIDITY();
this->reset();
}
/*
*
*/
void
Packet::reset()
{
CHECK_OBJECT_VALIDITY();
headerStream.reset();
// Delete the buffer that stores the packet after the header
DELETE_ARR( packetBuffer );
// Reset all of the optional header fields
for (int i = Packet::MIN_VALID_ID; i <= Packet::MAX_VALID_ID; i++) {
DELETE( variableHeaders[i] );
}
DELETE( msgProperties );
// Delete the msg body if needed
resetMsgBody();
DELETE_ARR( packetStr );
// Reinitialize all fields
init();
}
/**
*
*/
void
Packet::resetMsgBody()
{
CHECK_OBJECT_VALIDITY();
if (deleteMsgBody) {
DELETE_ARR( msgBody );
}
msgBody = NULL;
msgBodySize = 0;
deleteMsgBody = PR_FALSE;
}
/**
*
*/
void
Packet::init()
{
CHECK_OBJECT_VALIDITY();
magic = PACKET_MAGIC;
version = PACKET_VERSION;
packetType = PACKET_TYPE_INVALID;
packetSize = 0;
transactionID = 0;
producerID = 0;
expiration = 0; // 64 bit
deliveryTime = 0; // 64 bit
deliveryCount = 0; // 32 bit
propertiesOffset = 0;
propertiesSize = 0;
encryption = 0;
priority = PACKET_DEFAULT_PRIORITY;
bitFlags = 0;
consumerID = PACKET_NULL_CONSUMER_ID;
sysMessageID.reset();
msgProperties = NULL;
packetBuffer = NULL;
msgBody = NULL;
msgBodySize = 0;
deleteMsgBody = PR_FALSE;
for (int i = Packet::MIN_VALID_ID; i <= Packet::MAX_VALID_ID; i++) {
variableHeaders[i] = NULL;
}
packetStr = NULL;
}
/*
*
*/
MQError
Packet::validateHeader() const
{
CHECK_OBJECT_VALIDITY();
if ((packetSize < PACKET_HEADER_SIZE) ||
(propertiesOffset < PACKET_HEADER_SIZE) ||
(propertiesSize + propertiesOffset > packetSize))
{
return MQ_INVALID_PACKET;
}
return MQ_SUCCESS;
}
/*
*
*/
MQError
Packet::readPacket(TransportProtocolHandler * const transport)
{
CHECK_OBJECT_VALIDITY();
MQError errorCode;
PRInt32 bytesRemaining;
PRUint32 variableHeaderSize;
PRUint32 propertiesIndex;
PRUint32 payloadIndex;
RETURN_ERROR_IF_NULL( transport );
reset();
// Read in the header and validate it.
ERRCHK( this->readHeader(transport) );
ERRCHK( validateHeader() );
// Now read in the rest of the packet
bytesRemaining = this->packetSize - PACKET_HEADER_SIZE;
ASSERT( bytesRemaining >= 0 );
MEMCHK( this->packetBuffer = new PRUint8[bytesRemaining] );
ERRCHK( readFully(transport, this->packetBuffer, bytesRemaining) );
// Read in the variable headers. If the properties do not start immediately
// after the header, then there are some variable headers.
variableHeaderSize = this->propertiesOffset - PACKET_HEADER_SIZE;
if (this->propertiesOffset != PACKET_HEADER_SIZE) {
ERRCHK( readVariableHeader(packetBuffer, variableHeaderSize) );
}
// Read in the properties
// OPTIMIZATION: We could delay this until a getProperty call is made.
propertiesIndex = this->propertiesOffset - PACKET_HEADER_SIZE;
if (this->propertiesSize != 0) {
ERRCHK( readProperties(&(packetBuffer[propertiesIndex]),
this->propertiesSize) );
}
// Set the msg payload pointer to point into the remaining bytes
msgBodySize = bytesRemaining - (variableHeaderSize +
this->propertiesSize);
ASSERT( this->packetSize == PACKET_HEADER_SIZE +
variableHeaderSize +
this->propertiesSize +
this->msgBodySize );
payloadIndex = propertiesIndex + this->propertiesSize;
this->msgBody = &(this->packetBuffer)[payloadIndex];
this->deleteMsgBody = PR_FALSE;
return MQ_SUCCESS;
Cleanup:
reset();
return errorCode;
}
/*
*
*/
MQError
Packet::readHeader(TransportProtocolHandler * const transport)
{
CHECK_OBJECT_VALIDITY();
RETURN_ERROR_IF_NULL( transport );
RETURN_IF_ERROR( readFully(transport, headerBuffer, sizeof(headerBuffer)) );
RETURN_IF_ERROR( headerStream.setNetOrderStream(headerBuffer,
sizeof(headerBuffer)) );
RETURN_IF_ERROR( headerStream.readUint32(&(this->magic)) );
RETURN_IF_ERROR( headerStream.readUint16(&(this->version)) );
RETURN_IF_ERROR( headerStream.readUint16(&(this->packetType)) );
RETURN_IF_ERROR( headerStream.readUint32(&(this->packetSize)) );
// Check the magic number and version
RETURN_ERROR_IF( this->magic != PACKET_MAGIC, MQ_BAD_PACKET_MAGIC_NUMBER );
RETURN_ERROR_IF( this->version != PACKET_VERSION, MQ_UNSUPPORTED_PACKET_VERSION );
RETURN_IF_ERROR( headerStream.readUint64(&(this->expiration)) );
RETURN_IF_ERROR( sysMessageID.readID(&headerStream) );
RETURN_IF_ERROR( headerStream.readUint32(&(this->propertiesOffset)) );
RETURN_IF_ERROR( headerStream.readUint32(&(this->propertiesSize)) );
RETURN_IF_ERROR( headerStream.readUint8(&(this->priority)) );
RETURN_IF_ERROR( headerStream.readUint8(&(this->encryption)) );
RETURN_IF_ERROR( headerStream.readUint16(&(this->bitFlags)) );
RETURN_IF_ERROR( headerStream.readUint64(&(this->consumerID)) );
return MQ_SUCCESS;
}
/**
*
*/
MQError
Packet::readVariableHeader(const PRUint8 * const varHeaderBuffer,
const PRUint32 varHeaderBufferSize)
{
CHECK_OBJECT_VALIDITY();
RETURN_ERROR_IF_NULL( varHeaderBuffer );
ASSERT( varHeaderBufferSize > 0 );
// Put the buffer in an input stream
SerialDataInputStream varHeaderStream;
RETURN_IF_ERROR( varHeaderStream.setNetOrderStream(varHeaderBuffer,
varHeaderBufferSize) );
while (!varHeaderStream.endOfStream()) {
// Read in the variable header id
PRInt16 varHeaderID = 0;
RETURN_IF_ERROR( varHeaderStream.readInt16(&varHeaderID) );
if (varHeaderID == (PRInt16)Packet::MESSAGE_ID_ID)
{
//message id should be sysMessageID on receiving and
//MQ client runtime does not send user set messageid to broker
UTF8String skipMessageID;
RETURN_IF_ERROR( skipMessageID.read(&varHeaderStream) );
}
else
// If the header ID is valid, then read it in
if ((varHeaderID >= (PRInt16)Packet::MIN_VALID_ID) &&
(varHeaderID <= (PRInt16)Packet::MAX_VALID_ID))
{
DELETE( variableHeaders[varHeaderID] );
RETURN_IF_OUT_OF_MEMORY( variableHeaders[varHeaderID] = new UTF8String() );
RETURN_IF_ERROR( variableHeaders[varHeaderID]->read(&varHeaderStream) );
}
else if ( varHeaderID == (PRUint16)Packet::TRANSACTION_ID )
{
//no packet from broker requires transaction-id - 3.5 protocol
PRUint64 skipTranID = 0;
RETURN_IF_ERROR( varHeaderStream.readInt16(&varHeaderID) ); //skip length
RETURN_IF_ERROR( varHeaderStream.readUint64(&skipTranID) );
}
else if ( varHeaderID == (PRUint16)Packet::PRODUCER_ID )
{
RETURN_IF_ERROR( varHeaderStream.readInt16(&varHeaderID) ); //skip length
RETURN_IF_ERROR( varHeaderStream.readUint64(&producerID) );
}
else if ( varHeaderID == (PRUint16)Packet::DELIVERY_TIME )
{
RETURN_IF_ERROR( varHeaderStream.readInt16(&varHeaderID) ); //skip length
RETURN_IF_ERROR( varHeaderStream.readUint64(&deliveryTime) );
}
else if ( varHeaderID == (PRUint16)Packet::DELIVERY_COUNT )
{
RETURN_IF_ERROR( varHeaderStream.readInt16(&varHeaderID) ); //skip length
RETURN_IF_ERROR( varHeaderStream.readUint32(&deliveryCount) );
}
// Otherwise if it's the header terminator, then we've successfully read the
// variable headers.
else if (varHeaderID == (PRInt16)Packet::HEADER_TERMINATOR_ID) {
break;
}
// Otherwise it's a header that we don't recognize. So consume it and ignore it.
else {
UTF8String unrecognizedVariableHeader;
RETURN_IF_ERROR( unrecognizedVariableHeader.readLengthBytes(&varHeaderStream, PR_FALSE) );
// LOG: log something here
}
}
return MQ_SUCCESS;
}
/**
*
*/
MQError
Packet::readProperties(const PRUint8 * const propertiesBuffer,
const PRUint32 propertiesBufferSize)
{
CHECK_OBJECT_VALIDITY();
RETURN_ERROR_IF_NULL( propertiesBuffer );
ASSERT( propertiesBufferSize > 0 );
// Put the buffer in an input stream
SerialDataInputStream propertiesStream;
RETURN_IF_ERROR( propertiesStream.setNetOrderStream(propertiesBuffer,
propertiesBufferSize) );
// Read in the serialized Java hashtable
ASSERT( this->msgProperties == NULL );
RETURN_IF_OUT_OF_MEMORY( this->msgProperties = new Properties(PR_TRUE) );
RETURN_IF_ERROR( this->msgProperties->getInitializationError() );
RETURN_IF_ERROR( PacketProperties::readProperties(&propertiesStream, this->msgProperties) );
ASSERT( propertiesStream.endOfStream() );
return MQ_SUCCESS;
}
/*
*
*/
MQError
Packet::readFully(TransportProtocolHandler * const transport,
PRUint8 * const buffer,
const PRInt32 amountToRead)
{
CHECK_OBJECT_VALIDITY();
RETURN_ERROR_IF_NULL( transport );
RETURN_ERROR_IF_NULL( buffer );
PRInt32 amountRead = 0;
RETURN_IF_ERROR( transport->read( amountToRead,
TRANSPORT_NO_TIMEOUT,
buffer,
&amountRead) );
ASSERT( amountRead == amountToRead );
return MQ_SUCCESS;
}
// This method ensures that all packet fields are properly initialized
MQError
Packet::checkPacketFields() const
{
CHECK_OBJECT_VALIDITY();
RETURN_ERROR_IF( magic != PACKET_MAGIC, MQ_INVALID_PACKET_FIELD );
RETURN_ERROR_IF( version != PACKET_VERSION, MQ_INVALID_PACKET_FIELD );
//? RETURN_ERROR_IF( packetType == PACKET_NULL_CONSUMER_ID, MQ_INVALID_PACKET_FIELD );
// This check could be more restictive by checking for the holds in PacketType. But
// most of the problems will be with PacketType::INVALID.
RETURN_ERROR_IF( (packetType <= PACKET_TYPE_INVALID) ||
(packetType >= PACKET_TYPE_LAST),
MQ_INVALID_PACKET_FIELD );
RETURN_ERROR_IF( (msgBodySize != 0) && (msgBody == NULL),
MQ_INVALID_PACKET_FIELD );
return MQ_SUCCESS;
}
MQError
Packet::writePacket(TransportProtocolHandler * const transport, PRUint32 writeTimeout)
{
CHECK_OBJECT_VALIDITY();
MQError errorCode = MQ_SUCCESS;
RETURN_ERROR_IF_NULL( transport );
RETURN_IF_ERROR( checkPacketFields() );
// An output stream to hold the entire packet
SerialDataOutputStream headerOut;
// An output stream to hold the variable headers and the properties field
SerialDataOutputStream varHeaderOut;
// The total size of the packet is the size of
// the fixed header (HEADER_SIZE) +
// the size of the variable headers +
// the size of the properties +
// the size of the message body
// We don't know the size of the variable headers or the properties so we
// have to write them out varHeaderOut before writing them out to the transport.
// write out the variable header and the properties
ERRCHK( writeVariableHeaders(&varHeaderOut) );
ERRCHK( writeProperties(&varHeaderOut) );
// Assign the next sequence number
this->sysMessageID.setSequence(getNextSequenceNumber());
// Generate a timestamp. PR_Now() returns MICROseconds since 1/1/1970.
// The timestamp is MILLIseconds since 1/1/1970.
this->sysMessageID.setTimestamp(PR_Now() / 1000);
// Now we can determine how big the packet is
this->packetSize = PACKET_HEADER_SIZE +
varHeaderOut.numBytesWritten() +
msgBodySize;
this->setMessageID(NULL);
this->setRedelivered(PR_FALSE);
// write the header out to an output stream
ERRCHK( writeHeader(&headerOut) );
ASSERT( (PRUint32)headerOut.numBytesWritten() == PACKET_HEADER_SIZE );
CNDCHK( (PRUint32)headerOut.numBytesWritten() != PACKET_HEADER_SIZE,
MQ_PACKET_OUTPUT_ERROR );
//
// Now actually each part of the packet out to a buffer
//
PRInt32 bytesWritten; // the number of bytes written to the socket
// Write the header first
ERRCHK( transport->write(headerOut.numBytesWritten(),
headerOut.getStreamBytes(),
writeTimeout,
&bytesWritten) );
CNDCHK( bytesWritten != headerOut.numBytesWritten(), MQ_PACKET_OUTPUT_ERROR );
// Then the variable header and properties
ERRCHK( transport->write(varHeaderOut.numBytesWritten(),
varHeaderOut.getStreamBytes(),
writeTimeout,
&bytesWritten) );
CNDCHK( bytesWritten != varHeaderOut.numBytesWritten(), MQ_PACKET_OUTPUT_ERROR );
// Then the message body
ERRCHK( transport->write(this->msgBodySize,
this->msgBody,
writeTimeout,
&bytesWritten) );
CNDCHK( bytesWritten != msgBodySize, MQ_PACKET_OUTPUT_ERROR );
return MQ_SUCCESS;
Cleanup:
return errorCode;
}
/*
*
*/
MQError
Packet::writeHeader(SerialDataOutputStream * const out) const
{
CHECK_OBJECT_VALIDITY();
//
RETURN_ERROR_IF_NULL(out);
RETURN_IF_ERROR( out->writeUint32(this->magic) );
RETURN_IF_ERROR( out->writeUint16(this->version) );
RETURN_IF_ERROR( out->writeUint16(this->packetType) );
RETURN_IF_ERROR( out->writeUint32(this->packetSize) );
RETURN_IF_ERROR( out->writeUint64(this->expiration) );
RETURN_IF_ERROR( sysMessageID.writeID(out) );
RETURN_IF_ERROR( out->writeUint32(this->propertiesOffset) );
RETURN_IF_ERROR( out->writeUint32(this->propertiesSize) );
RETURN_IF_ERROR( out->writeUint8(this->priority) );
RETURN_IF_ERROR( out->writeUint8(this->encryption) );
RETURN_IF_ERROR( out->writeUint16(this->bitFlags) );
RETURN_IF_ERROR( out->writeUint64(this->consumerID) );
return MQ_SUCCESS;
}
/*
*
*/
MQError
Packet::writeVariableHeaders(SerialDataOutputStream * const out)
{
CHECK_OBJECT_VALIDITY();
RETURN_ERROR_IF_NULL( out );
// NOTE: This code violates the "Swift (JMQ 2.0) Packet Format
// Version 1.0.3" document, which says "If there are no variable
// headers, then the property data must start immediately after the
// fixed header. I.e. property_offset would be 72 and there would
// be no TYPE=0 list terminator." The Java MQ code violates this,
// and we would rather be consistent with their implementation than
// their spec.
if (LL_IS_ZERO(transactionID) == 0) {
RETURN_IF_ERROR( out->writeUint16((PRUint16)Packet::TRANSACTION_ID) );
RETURN_IF_ERROR( out->writeUint16((PRUint16)Packet::TRANSACTION_ID) );
RETURN_IF_ERROR( out->writeUint64(transactionID) );
}
if (LL_IS_ZERO(producerID) == 0 && this->getConsumerFlow() == PR_TRUE) {
RETURN_IF_ERROR( out->writeUint16((PRUint16)Packet::PRODUCER_ID) );
RETURN_IF_ERROR( out->writeUint16(sizeof(PRUint64)) );
RETURN_IF_ERROR( out->writeUint64(producerID) );
}
if (LL_IS_ZERO(deliveryTime) == 0) {
RETURN_IF_ERROR( out->writeUint16((PRUint16)Packet::DELIVERY_TIME) );
RETURN_IF_ERROR( out->writeUint16(sizeof(PRUint64)) );
RETURN_IF_ERROR( out->writeUint64(deliveryTime) );
}
if (variableHeaders[(PRUint16)Packet::DESTINATION_ID] != NULL) {
RETURN_IF_ERROR( out->writeUint16((PRUint16)Packet::DESTINATION_ID) );
RETURN_IF_ERROR( variableHeaders[(PRUint16)Packet::DESTINATION_ID]->write(out) );
}
// Write out rest of the variable headers that are valid, except MESSAGE_ID
for( PRUint16 headerID = (PRUint16)Packet::CORRELATION_ID_ID;
headerID <= (PRUint16)Packet::MAX_VALID_ID;
headerID++ )
{
if (variableHeaders[headerID] != NULL) {
RETURN_IF_ERROR( out->writeUint16(headerID) );
RETURN_IF_ERROR( variableHeaders[headerID]->write(out) );
}
}
// Null terminate the list
RETURN_IF_ERROR( out->writeUint16((PRUint16)Packet::HEADER_TERMINATOR_ID) );
// Pad the list to a 4 byte boundary
PRUint32 numBytesToPad = out->numBytesWritten() % 4;
if (numBytesToPad != 0) {
numBytesToPad = 4 - numBytesToPad;
}
RETURN_IF_ERROR( out->writeUint8Array(PACKET_ZERO_BYTES, numBytesToPad) );
return MQ_SUCCESS;
}
/*
*
*/
MQError
Packet::writeProperties(SerialDataOutputStream * const out)
{
CHECK_OBJECT_VALIDITY();
RETURN_ERROR_IF_NULL( out );
PRUint32 prevBytesWritten = 0;
// Calculate the propertyOffset and initialize propertiesSize
this->propertiesOffset = out->numBytesWritten() + PACKET_HEADER_SIZE;
ASSERT( this->propertiesOffset % 4 == 0 ); // must be aligned on 4-byte boundary
this->propertiesSize = 0;
// Write properties out to the buffer only if there are properties to write.
PRUint32 numProperties = 0;
if (this->msgProperties != NULL) {
this->msgProperties->getNumKeys(&numProperties);
if (numProperties != 0) {
prevBytesWritten = out->numBytesWritten();
RETURN_IF_ERROR( PacketProperties::writeProperties(out, this->msgProperties) );
this->propertiesSize = out->numBytesWritten() - prevBytesWritten;
}
}
return MQ_SUCCESS;
}
/**
*
* @return the next sequence number
*/
PRUint32 Packet::sequenceNumber = PACKET_MIN_SEQUENCE_NUMBER;
Monitor Packet::seqnumMonitor;
PRUint32
Packet::getNextSequenceNumber()
{
seqnumMonitor.enter();
PRUint32 seqnum = sequenceNumber;
sequenceNumber = (sequenceNumber == PACKET_MAX_SEQUENCE_NUMBER) ?
PACKET_MIN_SEQUENCE_NUMBER :
sequenceNumber + 1;
seqnumMonitor.exit();
return seqnum;
}
//------------------------------------------------------------------------------
// Get/Set
//------------------------------------------------------------------------------
/*
*
*/
PRBool
Packet::getFlag(const PRUint16 flag) const
{
CHECK_OBJECT_VALIDITY();
ASSERT( (flag == PACKET_FLAG_IS_QUEUE) ||
(flag == PACKET_FLAG_REDELIVERED) ||
(flag == PACKET_FLAG_PERSISTENT) ||
(flag == PACKET_FLAG_SELECTORS_PROCESSED) ||
(flag == PACKET_FLAG_SEND_ACK) ||
(flag == PACKET_FLAG_LAST_MESSAGE) ||
(flag == PACKET_FLAG_FLOW_PAUSED) ||
(flag == PACKET_FLAG_CONSUMER_FLOW_PAUSED) );
return ((bitFlags & flag) == flag);
}
PRUint16
Packet::getVersion() const
{
CHECK_OBJECT_VALIDITY();
return version;
}
PRUint32
Packet::getMagic() const
{
CHECK_OBJECT_VALIDITY();
return magic;
}
PRUint16
Packet::getPacketType() const
{
CHECK_OBJECT_VALIDITY();
return packetType;
}
PRUint32
Packet::getPacketSize() const
{
CHECK_OBJECT_VALIDITY();
return packetSize;
}
PRUint64
Packet::getTimestamp() const
{
CHECK_OBJECT_VALIDITY();
return sysMessageID.getTimestamp();
}
PRUint64
Packet::getExpiration() const
{
CHECK_OBJECT_VALIDITY();
return expiration;
}
PRUint64
Packet::getDeliveryTime() const
{
CHECK_OBJECT_VALIDITY();
return deliveryTime;
}
PRUint32
Packet::getDeliveryCount() const
{
CHECK_OBJECT_VALIDITY();
return deliveryCount;
}
PRUint32
Packet::getPort() const
{
CHECK_OBJECT_VALIDITY();
return sysMessageID.getPort();
}
void
Packet::getIP(PRUint8 * const ipv6Addr) const
{
CHECK_OBJECT_VALIDITY();
sysMessageID.getIPv6Address(ipv6Addr);
}
PRUint32
Packet::getSequence() const
{
CHECK_OBJECT_VALIDITY();
return sysMessageID.getSequence();
}
PRUint8
Packet::getEncryption() const
{
CHECK_OBJECT_VALIDITY();
return encryption;
}
PRUint8
Packet::getPriority() const
{
CHECK_OBJECT_VALIDITY();
return priority;
}
PRUint64
Packet::getConsumerID() const
{
CHECK_OBJECT_VALIDITY();
return consumerID;
}
PRBool
Packet::getPersistent() const
{
CHECK_OBJECT_VALIDITY();
return getFlag(PACKET_FLAG_PERSISTENT);
}
PRBool
Packet::getRedelivered() const
{
CHECK_OBJECT_VALIDITY();
return getFlag(PACKET_FLAG_REDELIVERED);
}
PRBool
Packet::getIsQueue() const
{
CHECK_OBJECT_VALIDITY();
return getFlag(PACKET_FLAG_IS_QUEUE);
}
PRBool
Packet::getSelectorsProcessed() const
{
CHECK_OBJECT_VALIDITY();
return getFlag(PACKET_FLAG_SELECTORS_PROCESSED);
}
PRBool
Packet::getSendAcknowledge() const
{
CHECK_OBJECT_VALIDITY();
return getFlag(PACKET_FLAG_SEND_ACK);
}
PRBool
Packet::getIsLast() const
{
CHECK_OBJECT_VALIDITY();
return getFlag(PACKET_FLAG_LAST_MESSAGE);
}
PRBool
Packet::getConsumerFlow() const
{
CHECK_OBJECT_VALIDITY();
return getFlag(PACKET_FLAG_CONSUMER_FLOW_PAUSED);
}
const UTF8String *
Packet::getDestination() const
{
CHECK_OBJECT_VALIDITY();
return getVariableHeader(Packet::DESTINATION_ID);
}
const UTF8String *
Packet::getDestinationClass() const
{
CHECK_OBJECT_VALIDITY();
return getVariableHeader(Packet::DESTINATION_CLASS_ID);
}
const UTF8String *
Packet::getMessageID() const
{
CHECK_OBJECT_VALIDITY();
// If the client has set a MessageID then that is what is returned.
// Otherwise, the system message ID is returned.
if (variableHeaders[Packet::MESSAGE_ID_ID] == NULL) {
// toString caches the string value, so it is a mutator, but we
// want to treat it as a const.
SysMessageID * msgID = (SysMessageID*)&(this->sysMessageID);
return msgID->toString();
} else {
return getVariableHeader(Packet::MESSAGE_ID_ID);
}
}
const UTF8String *
Packet::getCorrelationID() const
{
CHECK_OBJECT_VALIDITY();
return getVariableHeader(Packet::CORRELATION_ID_ID);
}
const UTF8String *
Packet::getReplyTo() const
{
CHECK_OBJECT_VALIDITY();
return getVariableHeader(Packet::REPLY_TO_ID);
}
const UTF8String *
Packet::getReplyToClass() const
{
CHECK_OBJECT_VALIDITY();
return getVariableHeader(Packet::REPLY_TO_CLASS_ID);
}
const UTF8String *
Packet::getMessageType() const
{
CHECK_OBJECT_VALIDITY();
return getVariableHeader(Packet::MESSAGE_TYPE_ID);
}
const UTF8String *
Packet::getVariableHeader(const VariableHeaderID headerID) const
{
CHECK_OBJECT_VALIDITY();
ASSERT( (headerID >= Packet::MIN_VALID_ID) &&
(headerID <= Packet::MAX_VALID_ID) );
return variableHeaders[headerID];
}
const SysMessageID *
Packet::getSystemMessageID() const
{
CHECK_OBJECT_VALIDITY();
return &(this->sysMessageID);
}
const PRUint8 *
Packet::getMessageBody() const
{
CHECK_OBJECT_VALIDITY();
return msgBody;
}
PRInt32
Packet::getMessageBodySize() const
{
CHECK_OBJECT_VALIDITY();
return msgBodySize;
}
IMQDataInputStream *
Packet::getMessageBodyStream() const
{
CHECK_OBJECT_VALIDITY();
SerialDataInputStream * input = NULL;
if ((msgBodySize > 0) &&
((input = new SerialDataInputStream()) != NULL))
{
ASSERT( msgBody != NULL );
input->setNetOrderStream(msgBody, msgBodySize);
}
return input;
}
const Properties *
Packet::getProperties() const
{
CHECK_OBJECT_VALIDITY();
return msgProperties;
}
/*
*
*/
void
Packet::setFlag(const PRUint16 flag, const PRBool value)
{
CHECK_OBJECT_VALIDITY();
ASSERT( (flag == PACKET_FLAG_IS_QUEUE) ||
(flag == PACKET_FLAG_REDELIVERED) ||
(flag == PACKET_FLAG_PERSISTENT) ||
(flag == PACKET_FLAG_SELECTORS_PROCESSED) ||
(flag == PACKET_FLAG_SEND_ACK) ||
(flag == PACKET_FLAG_LAST_MESSAGE) ||
(flag == PACKET_FLAG_FLOW_PAUSED) ||
(flag == PACKET_FLAG_CONSUMER_FLOW_PAUSED) );
#ifdef DEBUG
/** see below comment
PRBool prevValue = getFlag(flag); **/
#endif
if (value) {
bitFlags |= flag; // or in the flag
} else {
bitFlags &= ~flag; // and out the flag
}
#ifdef DEBUG
/**XXX revisit cause failures in situations like
* non-persistent message for both values would be false