Skip to content

Commit 4a8c066

Browse files
Change type of message buffer handle (#537)
1 parent 618e165 commit 4a8c066

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

include/message_buffer.h

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,10 @@
8080
* Type by which message buffers are referenced. For example, a call to
8181
* xMessageBufferCreate() returns an MessageBufferHandle_t variable that can
8282
* then be used as a parameter to xMessageBufferSend(), xMessageBufferReceive(),
83-
* etc.
83+
* etc. Message buffer is essentially built as a stream buffer hence its handle
84+
* is also set to same type as a stream buffer handle.
8485
*/
85-
typedef void * MessageBufferHandle_t;
86+
typedef StreamBufferHandle_t MessageBufferHandle_t;
8687

8788
/*-----------------------------------------------------------*/
8889

@@ -155,11 +156,11 @@ typedef void * MessageBufferHandle_t;
155156
* \ingroup MessageBufferManagement
156157
*/
157158
#define xMessageBufferCreate( xBufferSizeBytes ) \
158-
( MessageBufferHandle_t ) xStreamBufferGenericCreate( xBufferSizeBytes, ( size_t ) 0, pdTRUE, NULL, NULL )
159+
xStreamBufferGenericCreate( xBufferSizeBytes, ( size_t ) 0, pdTRUE, NULL, NULL )
159160

160161
#if ( configUSE_SB_COMPLETED_CALLBACK == 1 )
161162
#define xMessageBufferCreateWithCallback( xBufferSizeBytes, pxSendCompletedCallback, pxReceiveCompletedCallback ) \
162-
( MessageBufferHandle_t ) xStreamBufferGenericCreate( xBufferSizeBytes, ( size_t ) 0, pdTRUE, pxSendCompletedCallback, pxReceiveCompletedCallback )
163+
xStreamBufferGenericCreate( xBufferSizeBytes, ( size_t ) 0, pdTRUE, pxSendCompletedCallback, pxReceiveCompletedCallback )
163164
#endif
164165

165166
/**
@@ -237,11 +238,11 @@ typedef void * MessageBufferHandle_t;
237238
* \ingroup MessageBufferManagement
238239
*/
239240
#define xMessageBufferCreateStatic( xBufferSizeBytes, pucMessageBufferStorageArea, pxStaticMessageBuffer ) \
240-
( MessageBufferHandle_t ) xStreamBufferGenericCreateStatic( xBufferSizeBytes, 0, pdTRUE, pucMessageBufferStorageArea, pxStaticMessageBuffer, NULL, NULL )
241+
xStreamBufferGenericCreateStatic( xBufferSizeBytes, 0, pdTRUE, pucMessageBufferStorageArea, pxStaticMessageBuffer, NULL, NULL )
241242

242243
#if ( configUSE_SB_COMPLETED_CALLBACK == 1 )
243244
#define xMessageBufferCreateStaticWithCallback( xBufferSizeBytes, pucMessageBufferStorageArea, pxStaticMessageBuffer, pxSendCompletedCallback, pxReceiveCompletedCallback ) \
244-
( MessageBufferHandle_t ) xStreamBufferGenericCreateStatic( xBufferSizeBytes, 0, pdTRUE, pucMessageBufferStorageArea, pxStaticMessageBuffer, pxSendCompletedCallback, pxReceiveCompletedCallback )
245+
xStreamBufferGenericCreateStatic( xBufferSizeBytes, 0, pdTRUE, pucMessageBufferStorageArea, pxStaticMessageBuffer, pxSendCompletedCallback, pxReceiveCompletedCallback )
245246
#endif
246247

247248
/**
@@ -342,7 +343,7 @@ typedef void * MessageBufferHandle_t;
342343
* \ingroup MessageBufferManagement
343344
*/
344345
#define xMessageBufferSend( xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait ) \
345-
xStreamBufferSend( ( StreamBufferHandle_t ) xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait )
346+
xStreamBufferSend( xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait )
346347

347348
/**
348349
* message_buffer.h
@@ -447,7 +448,7 @@ typedef void * MessageBufferHandle_t;
447448
* \ingroup MessageBufferManagement
448449
*/
449450
#define xMessageBufferSendFromISR( xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken ) \
450-
xStreamBufferSendFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken )
451+
xStreamBufferSendFromISR( xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken )
451452

452453
/**
453454
* message_buffer.h
@@ -536,7 +537,7 @@ typedef void * MessageBufferHandle_t;
536537
* \ingroup MessageBufferManagement
537538
*/
538539
#define xMessageBufferReceive( xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait ) \
539-
xStreamBufferReceive( ( StreamBufferHandle_t ) xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait )
540+
xStreamBufferReceive( xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait )
540541

541542

542543
/**
@@ -638,7 +639,7 @@ typedef void * MessageBufferHandle_t;
638639
* \ingroup MessageBufferManagement
639640
*/
640641
#define xMessageBufferReceiveFromISR( xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken ) \
641-
xStreamBufferReceiveFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken )
642+
xStreamBufferReceiveFromISR( xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken )
642643

643644
/**
644645
* message_buffer.h
@@ -659,7 +660,7 @@ typedef void * MessageBufferHandle_t;
659660
*
660661
*/
661662
#define vMessageBufferDelete( xMessageBuffer ) \
662-
vStreamBufferDelete( ( StreamBufferHandle_t ) xMessageBuffer )
663+
vStreamBufferDelete( xMessageBuffer )
663664

664665
/**
665666
* message_buffer.h
@@ -677,7 +678,7 @@ typedef void * MessageBufferHandle_t;
677678
* pdTRUE is returned. Otherwise pdFALSE is returned.
678679
*/
679680
#define xMessageBufferIsFull( xMessageBuffer ) \
680-
xStreamBufferIsFull( ( StreamBufferHandle_t ) xMessageBuffer )
681+
xStreamBufferIsFull( xMessageBuffer )
681682

682683
/**
683684
* message_buffer.h
@@ -694,7 +695,7 @@ typedef void * MessageBufferHandle_t;
694695
*
695696
*/
696697
#define xMessageBufferIsEmpty( xMessageBuffer ) \
697-
xStreamBufferIsEmpty( ( StreamBufferHandle_t ) xMessageBuffer )
698+
xStreamBufferIsEmpty( xMessageBuffer )
698699

699700
/**
700701
* message_buffer.h
@@ -718,7 +719,7 @@ typedef void * MessageBufferHandle_t;
718719
* \ingroup MessageBufferManagement
719720
*/
720721
#define xMessageBufferReset( xMessageBuffer ) \
721-
xStreamBufferReset( ( StreamBufferHandle_t ) xMessageBuffer )
722+
xStreamBufferReset( xMessageBuffer )
722723

723724

724725
/**
@@ -741,9 +742,9 @@ typedef void * MessageBufferHandle_t;
741742
* \ingroup MessageBufferManagement
742743
*/
743744
#define xMessageBufferSpaceAvailable( xMessageBuffer ) \
744-
xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer )
745+
xStreamBufferSpacesAvailable( xMessageBuffer )
745746
#define xMessageBufferSpacesAvailable( xMessageBuffer ) \
746-
xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer ) /* Corrects typo in original macro name. */
747+
xStreamBufferSpacesAvailable( xMessageBuffer ) /* Corrects typo in original macro name. */
747748

748749
/**
749750
* message_buffer.h
@@ -763,7 +764,7 @@ typedef void * MessageBufferHandle_t;
763764
* \ingroup MessageBufferManagement
764765
*/
765766
#define xMessageBufferNextLengthBytes( xMessageBuffer ) \
766-
xStreamBufferNextMessageLengthBytes( ( StreamBufferHandle_t ) xMessageBuffer ) PRIVILEGED_FUNCTION;
767+
xStreamBufferNextMessageLengthBytes( xMessageBuffer ) PRIVILEGED_FUNCTION;
767768

768769
/**
769770
* message_buffer.h
@@ -803,7 +804,7 @@ typedef void * MessageBufferHandle_t;
803804
* \ingroup StreamBufferManagement
804805
*/
805806
#define xMessageBufferSendCompletedFromISR( xMessageBuffer, pxHigherPriorityTaskWoken ) \
806-
xStreamBufferSendCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )
807+
xStreamBufferSendCompletedFromISR( xMessageBuffer, pxHigherPriorityTaskWoken )
807808

808809
/**
809810
* message_buffer.h
@@ -844,7 +845,7 @@ typedef void * MessageBufferHandle_t;
844845
* \ingroup StreamBufferManagement
845846
*/
846847
#define xMessageBufferReceiveCompletedFromISR( xMessageBuffer, pxHigherPriorityTaskWoken ) \
847-
xStreamBufferReceiveCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )
848+
xStreamBufferReceiveCompletedFromISR( xMessageBuffer, pxHigherPriorityTaskWoken )
848849

849850
/* *INDENT-OFF* */
850851
#if defined( __cplusplus )

0 commit comments

Comments
 (0)