Flow-IPC 3.0.0
Flow-IPC project: Full implementation reference.
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>

Collaboration diagram for ipc::transport::Null_peer:
[legend]

Public Types

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

Static Public Attributes

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

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.

Definition at line 1136 of file channel.hpp.

Member Typedef Documentation

◆ Async_io_obj

You may disregard.

Definition at line 1142 of file channel.hpp.

◆ Blob_batch_in

template<typename Msg_resource >
using ipc::transport::Null_peer::Blob_batch_in = Null_peer

You may disregard.

Definition at line 1148 of file channel.hpp.

◆ Blob_rcv_stats

You may disregard.

Definition at line 1156 of file channel.hpp.

◆ Blob_snd_stats

You may disregard.

Definition at line 1152 of file channel.hpp.

◆ Native_handle_batch_in

template<typename Msg_resource >
using ipc::transport::Null_peer::Native_handle_batch_in = Null_peer

You may disregard.

Definition at line 1145 of file channel.hpp.

◆ Native_handle_rcv_stats

You may disregard.

Definition at line 1154 of file channel.hpp.

◆ Native_handle_snd_stats

You may disregard.

Definition at line 1150 of file channel.hpp.

◆ Sync_io_obj

You may disregard.

Definition at line 1140 of file channel.hpp.

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.

Definition at line 30 of file channel.cpp.

Member Data Documentation

◆ S_RCV_BLOB_BATCH_SZ_RECOMMENDATION

constexpr size_t ipc::transport::Null_peer::S_RCV_BLOB_BATCH_SZ_RECOMMENDATION = 0
staticconstexpr

You may disregard.

Definition at line 1158 of file channel.hpp.

◆ S_RCV_NATIVE_HANDLE_BATCH_SZ_RECOMMENDATION

constexpr size_t ipc::transport::Null_peer::S_RCV_NATIVE_HANDLE_BATCH_SZ_RECOMMENDATION = 0
staticconstexpr

You may disregard.

Definition at line 1160 of file channel.hpp.


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