cosmos::UnixCredentials Struct Reference

User and group credentials of a peer process. More...

#include <unix_aux.hxx>

Inheritance diagram for cosmos::UnixCredentials:

Public Member Functions
	UnixCredentials ()
	Create credentials all set to INVALID values.
	UnixCredentials (const ProcessID p_pid, const UserID p_uid, const GroupID p_gid)
	Create credentials using the given values.
void	setCurrentCreds ()
	Fill in the credentials from the current process context.
auto	processID ()
auto	userID ()
auto	groupID ()

Detailed Description

User and group credentials of a peer process.

This type is used to indicate process credentials passed over a UNIX domain socket. It is used in UnixOptions::credentials() and in the UnixCredentialsMessage ancillary message.

Definition at line 28 of file unix_aux.hxx.

Constructor & Destructor Documentation

UnixCredentials() [1/2]

cosmos::UnixCredentials::UnixCredentials ( )

inline

Create credentials all set to INVALID values.

Definition at line 32 of file unix_aux.hxx.

                          :
                UnixCredentials{ProcessID::INVALID, UserID::INVALID, GroupID::INVALID} {
        }

UnixCredentials() [2/2]

cosmos::UnixCredentials::UnixCredentials ( const ProcessID p_pid, const UserID p_uid, const GroupID p_gid )

inline

Create credentials using the given values.

Definition at line 37 of file unix_aux.hxx.

                                                                                        {
                pid = cosmos::to_integral(p_pid);
                uid = cosmos::to_integral(p_uid);
                gid = cosmos::to_integral(p_gid);
        }

Member Function Documentation

groupID()

auto cosmos::UnixCredentials::groupID ( )

inline

Definition at line 52 of file unix_aux.hxx.

{ return GroupID{gid}; }

processID()

auto cosmos::UnixCredentials::processID ( )

inline

Definition at line 50 of file unix_aux.hxx.

{ return ProcessID{pid}; }

setCurrentCreds()

void cosmos::UnixCredentials::setCurrentCreds

(

)

Fill in the credentials from the current process context.

The current process ID, effective UID and effective GID will be set in the structure.

Definition at line 14 of file unix_aux.cxx.

                                      {
        pid = to_integral(cosmos::proc::get_own_pid());
        uid = to_integral(cosmos::proc::get_effective_user_id());
        gid = to_integral(cosmos::proc::get_effective_group_id());
}

userID()

auto cosmos::UnixCredentials::userID ( )

inline

Definition at line 51 of file unix_aux.hxx.

{ return UserID{uid}; }

---

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

• include/net/unix_aux.hxx
• src/net/unix_aux.cxx