Flow-IPC 1.0.0
Flow-IPC project: Full implementation reference.
transport_fwd.hpp
Go to the documentation of this file.
1/* Flow-IPC: Core
2 * Copyright 2023 Akamai Technologies, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the
5 * "License"); you may not use this file except in
6 * compliance with the License. You may obtain a copy
7 * of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in
12 * writing, software distributed under the License is
13 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
14 * CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing
16 * permissions and limitations under the License. */
17
18/// @file
19#pragma once
20
22
23namespace ipc::transport
24{
25
26// Types.
27
28// Find doc headers near the bodies of these compound types.
29
30template<typename Persistent_mq_handle>
31class Blob_stream_mq_base_impl;
32template<typename Persistent_mq_handle>
33class Blob_stream_mq_receiver_impl;
34template<typename Persistent_mq_handle>
35class Blob_stream_mq_sender_impl;
36
37// Free functions.
38
39/**
40 * Prints string representation of the given `Blob_stream_mq_receiver_impl` to the given `ostream`.
41 *
42 * @relatesalso Blob_stream_mq_receiver_impl
43 *
44 * @param os
45 * Stream to which to write.
46 * @param val
47 * Object to serialize.
48 * @return `os`.
49 */
50template<typename Persistent_mq_handle>
51std::ostream& operator<<(std::ostream& os, const Blob_stream_mq_receiver_impl<Persistent_mq_handle>& val);
52
53/**
54 * Prints string representation of the given `Blob_stream_mq_sender` to the given `ostream`.
55 *
56 * @relatesalso Blob_stream_mq_sender_impl
57 *
58 * @param os
59 * Stream to which to write.
60 * @param val
61 * Object to serialize.
62 * @return `os`.
63 */
64template<typename Persistent_mq_handle>
65std::ostream& operator<<(std::ostream& os, const Blob_stream_mq_sender_impl<Persistent_mq_handle>& val);
66
67} // namespace ipc::transport
68
70{
71
72// Types.
73
74// Find doc headers near the bodies of these compound types.
75
76template<typename Core_t>
78template<typename Core_t>
80template<typename Persistent_mq_handle>
82template<typename Persistent_mq_handle>
84
85// Free functions.
86
87/**
88 * Prints string representation of the given `Blob_stream_mq_receiver_impl` to the given `ostream`.
89 *
90 * @relatesalso Blob_stream_mq_receiver_impl
91 *
92 * @param os
93 * Stream to which to write.
94 * @param val
95 * Object to serialize.
96 * @return `os`.
97 */
98template<typename Persistent_mq_handle>
99std::ostream& operator<<(std::ostream& os, const Blob_stream_mq_receiver_impl<Persistent_mq_handle>& val);
100
101/**
102 * Prints string representation of the given `Blob_stream_mq_sender` to the given `ostream`.
103 *
104 * @relatesalso Blob_stream_mq_sender_impl
105 *
106 * @param os
107 * Stream to which to write.
108 * @param val
109 * Object to serialize.
110 * @return `os`.
111 */
112template<typename Persistent_mq_handle>
113std::ostream& operator<<(std::ostream& os, const Blob_stream_mq_sender_impl<Persistent_mq_handle>& val);
114
115} // namespace ipc::transport::sync_io
Internal-use type that adapts a given PEER-state sync_io::Native_handle_receiver or sync_io::Blob_rec...
Internal-use type that adapts a given PEER-state sync_io::Native_handle_sender or sync_io::Blob_sende...
Internal, non-movable pImpl-lite implementation of sync_io::Blob_stream_mq_receiver class template.
Internal, non-movable pImpl-lite implementation of sync_io::Blob_stream_mq_sender class template.
sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.
std::ostream & operator<<(std::ostream &os, const Blob_stream_mq_receiver_impl< Persistent_mq_handle > &val)
Prints string representation of the given Blob_stream_mq_receiver_impl to the given ostream.
Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...
std::ostream & operator<<(std::ostream &os, const Bipc_mq_handle &val)
Prints string representation of the given Bipc_mq_handle to the given ostream.