Flow-IPC 3.0.0
Flow-IPC project: Public API.
Public Types | Static Public Attributes | Related Functions | List of all members
ipc::transport::Null_peer Class Reference

Dummy type for use as a template param to Channel when either the blobs pipe or handles pipe is disabled; as well as to mark a given peer object as not having a counterpart form: a sync_io object shall have its using Sync_io_obj = Null_peer and conversely for async-I/O guys and their Async_io_objs. More...

#include <channel.hpp>

Public Types

using Sync_io_obj = Null_peer
 You may disregard.
 
using Async_io_obj = Null_peer
 You may disregard.
 
template<typename Msg_resource >
using Native_handle_batch_in = Null_peer
 You may disregard.
 
template<typename Msg_resource >
using Blob_batch_in = Null_peer
 You may disregard.
 
using Native_handle_snd_stats = Null_peer
 You may disregard.
 
using Blob_snd_stats = Null_peer
 You may disregard.
 
using Native_handle_rcv_stats = Null_peer
 You may disregard.
 
using Blob_rcv_stats = Null_peer
 You may disregard.
 

Static Public Attributes

static constexpr size_t S_RCV_BLOB_BATCH_SZ_RECOMMENDATION = 0
 You may disregard.
 
static constexpr size_t S_RCV_NATIVE_HANDLE_BATCH_SZ_RECOMMENDATION = 0
 You may disregard.
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const Null_peer &val)
 Dummy that is never invoked. More...
 

Detailed Description

Dummy type for use as a template param to Channel when either the blobs pipe or handles pipe is disabled; as well as to mark a given peer object as not having a counterpart form: a sync_io object shall have its using Sync_io_obj = Null_peer and conversely for async-I/O guys and their Async_io_objs.

No object of this type is ever touched, at least if Channel is properly used.

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  os,
const Null_peer &  val 
)
related

Dummy that is never invoked.

It must still exist in order for Channel to build successfully with at least 1 Null_peer template arg.

Assertion may trip if this is invoked. Formally behavior is undefined.

Parameters
osStream to which to write.
valObject to serialize.
Returns
os.

The documentation for this class was generated from the following files: