Realm
A distributed, event-based tasking library
Loading...
Searching...
No Matches
fragmented_message.h
Go to the documentation of this file.
1/*
2 * Copyright 2025 Stanford University, NVIDIA Corporation
3 * SPDX-License-Identifier: Apache-2.0
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#ifndef FRAGMENTED_MESSAGE_HPP
19#define FRAGMENTED_MESSAGE_HPP
20
21#include "realm/realm_config.h"
22
23#include <vector>
24#include <cstdint>
25#include <cstring>
26
27namespace Realm {
28
63
65 public:
66 explicit FragmentedMessage(uint32_t total_chunks = 0);
67
68 bool add_chunk(uint32_t chunk_id, const void *data, size_t size);
69 // the same, but taking over a copy the caller has already made - so that the
70 // copy need not be made under whatever lock protects this message
71 bool add_chunk(uint32_t chunk_id, std::vector<char> &&data);
72
73 bool is_complete() const;
74 size_t size() const;
75
76 // number of chunks this message was created expecting - a fragment claiming a
77 // different total means two messages have collided on one reassembly key, or
78 // the fragment header is corrupt
79 uint32_t expected_chunks() const { return total_chunks; }
80 std::vector<char> reassemble() const;
81 // copies the complete message, in order, to 'dst', which has room for size() bytes
82 void reassemble(void *dst) const;
83
84 private:
85 uint32_t total_chunks{0};
86 size_t total_size{0};
87 std::vector<std::vector<char>> received_chunks;
88 std::vector<bool> received_flags;
89 uint32_t received_count{0};
90 };
91} // namespace Realm
92
93#endif // FRAGMENTED_MESSAGE_HPP
std::vector< char > reassemble() const
bool add_chunk(uint32_t chunk_id, const void *data, size_t size)
void reassemble(void *dst) const
FragmentedMessage(uint32_t total_chunks=0)
uint32_t expected_chunks() const
Definition fragmented_message.h:79
bool add_chunk(uint32_t chunk_id, std::vector< char > &&data)
Definition activemsg.h:42