You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: include/hicr/frontends/channel/variableSize/spsc/consumer.hpp
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ class Consumer final : public variableSize::Base
50
50
* \param[in] coordinationCommunicationManager The backend's memory manager to facilitate communication between the producer and consumer coordination buffers
51
51
* \param[in] payloadCommunicationManager The backend's memory manager to facilitate communication between the producer and consumer payload buffers
52
52
* \param[in] payloadBuffer The memory slot pertaining to the payload buffer. The producer will push messages into this
53
-
* buffer, while there is enough space. This buffer should be large enough to hold twice the capacity specified by \ref payloadCapacity argument.
53
+
* buffer, while there is enough space. This buffer should be large enough to hold twice the capacity specified by payloadCapacity argument.
54
54
* Half of the buffer is used as excess buffer to avoid internal fragmentation of messages
55
55
* \param[in] tokenBuffer The memory slot pertaining to the token buffer. This buffer is only used to exchange internal metadata
56
56
* about the sizes of the individual messages being sent.
@@ -282,7 +282,7 @@ class Consumer final : public variableSize::Base
282
282
* This funciton can be used to quickly check whether the channel is becoming full when trying
283
283
* to push an element of a given size. First thing, we are checking if we can still
284
284
* push tokens (i.e., if the coordination buffer has space). Second thing, we are checking the
285
-
* payload buffer. If the current depth of the payload and the \ref requiredBufferSize to push
285
+
* payload buffer. If the current depth of the payload and the requiredBufferSize to push
286
286
* exceed the channel capacity, the channel is considered full.
287
287
*
288
288
* \param[in] requiredBufferSize size of the token to push into the channel
0 commit comments