Flow-IPC 1.0.2
Flow-IPC project: Full implementation reference.
Public Types | Related Functions | List of all members
ipc::session::Client_app Struct Reference

An App that is used as a client in at least one client-server IPC split. More...

#include <app.hpp>

Inheritance diagram for ipc::session::Client_app:
[legend]
Collaboration diagram for ipc::session::Client_app:
[legend]

Public Types

using Base = App
 Short-hand for base type. More...
 
using Master_set = boost::unordered_map< std::string, Client_app >
 Suggested type for storing master repository or all Client_appss. See App doc header for discussion. More...
 
- Public Types inherited from ipc::session::App
using Master_set = boost::unordered_map< std::string, App >
 Suggested type for storing master repository or all Appss. See App doc header for discussion. More...
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const Client_app &val)
 Prints string representation of the given Client_appp to the given ostream. More...
 

Additional Inherited Members

- Public Attributes inherited from ipc::session::App
std::string m_name
 Brief application name, readable to humans and unique across all other applications' names; used both as a short programmatic key in shared resource naming (including as a folder in Shared_name for kernel-persistent resources and addresses; and in path names – such as PID file name – in the file system). More...
 
fs::path m_exec_path
 Absolute, lexically normalized canonical path to the executable entity (which is not a directory), as it would appear in a command line or exec()-like invocation when actually invoking the application. More...
 
util::user_id_t m_user_id
 The application must run as this user ID (UID). Files and other shared resources shall have this owner. More...
 
util::group_id_t m_group_id
 The application must run as this group ID (GID). Files and other shared resources shall have this owner. More...
 

Detailed Description

An App that is used as a client in at least one client-server IPC split.

This is explained in the "App, Client_app, Server_app registry conventions" section of the struct App doc header.

See also
struct App doc header.

As of this writing a Client_app is just an App with no added stored information. That said a Server_app may exist whose App base object is equals to a Client_app *this's App base object (in particular App::m_name but also all other members).

Definition at line 184 of file app.hpp.

Member Typedef Documentation

◆ Base

Short-hand for base type.

Definition at line 189 of file app.hpp.

◆ Master_set

using ipc::session::Client_app::Master_set = boost::unordered_map<std::string, Client_app>

Suggested type for storing master repository or all Client_appss. See App doc header for discussion.

Definition at line 192 of file app.hpp.

Friends And Related Function Documentation

◆ operator<<()

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

Prints string representation of the given Client_appp to the given ostream.

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

Definition at line 129 of file app.cpp.


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