libcosmos
Linux C++ System Programming Library
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
cosmos::FileDescriptor::Owner Struct Reference

Information about file owner settings. More...

#include <FileDescriptor.hxx>

Public Types

enum class  Type : std::underlying_type< RawType >::type { THREAD = F_OWNER_TID , PROCESS = F_OWNER_PID , GROUP = F_OWNER_PGRP }
 Strong owner type differentation. More...
 
using RawType = decltype(f_owner_ex::type)
 

Public Member Functions

 Owner (ProcessID pid)
 
 Owner (ProcessGroupID pgid)
 
 Owner (ThreadID tid)
 
Type type () const
 
bool isTID () const
 
bool isPID () const
 
bool isPGID () const
 
bool valid () const
 
void invalidate ()
 
void set (ProcessID pid)
 
void set (ProcessGroupID pgid)
 
void set (ThreadID tid)
 
std::optional< ProcessID > asPID () const
 
std::optional< ProcessGroupID > asPGID () const
 
std::optional< ThreadID > asTID () const
 
auto raw ()
 
auto raw () const
 

Protected Attributes

f_owner_ex m_raw
 

Detailed Description

Information about file owner settings.

This type holds either a ProcessID, ProcessGroupID or ThreadID. Only type safe operations are provided, for low level access the raw system call data structure can be accesses via the raw() member.

The file owner defines which process, thread or process group gets notified about asynchronous file I/O events via signals.

Definition at line 81 of file FileDescriptor.hxx.

Member Typedef Documentation

◆ RawType

using cosmos::FileDescriptor::Owner::RawType = decltype(f_owner_ex::type)

Definition at line 92 of file FileDescriptor.hxx.

Member Enumeration Documentation

◆ Type

enum class cosmos::FileDescriptor::Owner::Type : std::underlying_type< RawType >::type
strong

Strong owner type differentation.

Definition at line 97 of file FileDescriptor.hxx.

97 : std::underlying_type<RawType>::type {
98 THREAD = F_OWNER_TID,
99 PROCESS = F_OWNER_PID,
100 GROUP = F_OWNER_PGRP
101 };
cosmos::CloneFlag::THREAD
@ THREAD
The child shares the same thread group as the parent. Thread groups are used to implement thread sema...

Constructor & Destructor Documentation

◆ Owner() [1/4]

cosmos::FileDescriptor::Owner::Owner ( )
inline

Definition at line 105 of file FileDescriptor.hxx.

105 {
106 invalidate();
107 }

◆ Owner() [2/4]

cosmos::FileDescriptor::Owner::Owner ( ProcessID pid)
inlineexplicit

Definition at line 109 of file FileDescriptor.hxx.

109 {
110 set(pid);
111 }

◆ Owner() [3/4]

cosmos::FileDescriptor::Owner::Owner ( ProcessGroupID pgid)
inlineexplicit

Definition at line 113 of file FileDescriptor.hxx.

113 {
114 set(pgid);
115 }

◆ Owner() [4/4]

cosmos::FileDescriptor::Owner::Owner ( ThreadID tid)
inlineexplicit

Definition at line 117 of file FileDescriptor.hxx.

117 {
118 set(tid);
119 }

Member Function Documentation

◆ asPGID()

std::optional< ProcessGroupID > cosmos::FileDescriptor::Owner::asPGID ( ) const
inline

Definition at line 166 of file FileDescriptor.hxx.

166 {
167 return isPGID() ? std::make_optional(ProcessGroupID{m_raw.pid}) : std::nullopt;
168 }

◆ asPID()

std::optional< ProcessID > cosmos::FileDescriptor::Owner::asPID ( ) const
inline

Definition at line 162 of file FileDescriptor.hxx.

162 {
163 return isPID() ? std::make_optional(ProcessID{m_raw.pid}) : std::nullopt;
164 }

◆ asTID()

std::optional< ThreadID > cosmos::FileDescriptor::Owner::asTID ( ) const
inline

Definition at line 170 of file FileDescriptor.hxx.

170 {
171 return isTID() ? std::make_optional(ThreadID{m_raw.pid}) : std::nullopt;
172 }

◆ invalidate()

void cosmos::FileDescriptor::Owner::invalidate ( )
inline

Definition at line 142 of file FileDescriptor.hxx.

142 {
143 m_raw.type = (RawType)-1;
144 m_raw.pid = -1;
145 }

◆ isPGID()

bool cosmos::FileDescriptor::Owner::isPGID ( ) const
inline

Definition at line 133 of file FileDescriptor.hxx.

133 {
134 return type() == Type::GROUP;
135 }

◆ isPID()

bool cosmos::FileDescriptor::Owner::isPID ( ) const
inline

Definition at line 129 of file FileDescriptor.hxx.

129 {
130 return type() == Type::PROCESS;
131 }

◆ isTID()

bool cosmos::FileDescriptor::Owner::isTID ( ) const
inline

Definition at line 125 of file FileDescriptor.hxx.

125 {
126 return type() == Type::THREAD;
127 }

◆ raw() [1/2]

auto cosmos::FileDescriptor::Owner::raw ( )
inline

Definition at line 174 of file FileDescriptor.hxx.

174 {
175 return &m_raw;
176 }

◆ raw() [2/2]

auto cosmos::FileDescriptor::Owner::raw ( ) const
inline

Definition at line 178 of file FileDescriptor.hxx.

178 {
179 return &m_raw;
180 }

◆ set() [1/3]

void cosmos::FileDescriptor::Owner::set ( ProcessGroupID pgid)
inline

Definition at line 152 of file FileDescriptor.hxx.

152 {
153 m_raw.type = static_cast<RawType>(Type::GROUP);
154 m_raw.pid = to_integral(pgid);
155 }

◆ set() [2/3]

void cosmos::FileDescriptor::Owner::set ( ProcessID pid)
inline

Definition at line 147 of file FileDescriptor.hxx.

147 {
148 m_raw.type = static_cast<RawType>(Type::PROCESS);
149 m_raw.pid = to_integral(pid);
150 }

◆ set() [3/3]

void cosmos::FileDescriptor::Owner::set ( ThreadID tid)
inline

Definition at line 157 of file FileDescriptor.hxx.

157 {
158 m_raw.type = static_cast<RawType>(Type::THREAD);
159 m_raw.pid = to_integral(tid);
160 }

◆ type()

Type cosmos::FileDescriptor::Owner::type ( ) const
inline

Definition at line 121 of file FileDescriptor.hxx.

121 {
122 return Type{m_raw.type};
123 }
cosmos::FileDescriptor::Owner::Type
Type
Strong owner type differentation.
Definition FileDescriptor.hxx:97

◆ valid()

bool cosmos::FileDescriptor::Owner::valid ( ) const
inline

Definition at line 137 of file FileDescriptor.hxx.

137 {
138 // if not owner was ever set then the PID will be zero
139 return m_raw.pid != 0 && (isTID() || isPID() || isPGID());
140 }

Member Data Documentation

◆ m_raw

f_owner_ex cosmos::FileDescriptor::Owner::m_raw
protected

Definition at line 184 of file FileDescriptor.hxx.

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