TokenPipe Class Reference

An interprocess or interthread pipe for sending tokens (one-byte values) over. More...

#include <tokenpipe.h>

Public Member Functions
	~TokenPipe ()
TokenPipeEnd	TakeReadEnd ()
	Take the read end of this pipe.
TokenPipeEnd	TakeWriteEnd ()
	Take the write end of this pipe.
void	Close ()
	Close and end of the pipe that hasn't been moved out.
	TokenPipe (TokenPipe &&other)
TokenPipe &	operator= (TokenPipe &&other)
	TokenPipe (const TokenPipe &)=delete
TokenPipe &	operator= (const TokenPipe &)=delete

Static Public Member Functions
static std::optional< TokenPipe >	Make ()
	Create a new pipe.

Private Member Functions
	TokenPipe (int fds[2])

Private Attributes
int	m_fds [2] = {-1, -1}

Detailed Description

An interprocess or interthread pipe for sending tokens (one-byte values) over.

Definition at line 75 of file tokenpipe.h.

Constructor & Destructor Documentation

TokenPipe() [1/3]

TokenPipe::TokenPipe ( int  fds[2] )

inlineprivate

Definition at line 79 of file tokenpipe.h.

~TokenPipe()

TokenPipe::~TokenPipe

(

)

Definition at line 89 of file tokenpipe.cpp.

Here is the call graph for this function:

TokenPipe() [2/3]

TokenPipe::TokenPipe ( TokenPipe &&  other )

inline

Definition at line 109 of file tokenpipe.h.

TokenPipe() [3/3]

TokenPipe::TokenPipe ( const TokenPipe &  )

delete

Member Function Documentation

Close()

void TokenPipe::Close

(

)

Close and end of the pipe that hasn't been moved out.

Definition at line 93 of file tokenpipe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Make()

std::optional< TokenPipe > TokenPipe::Make ( )

static

Create a new pipe.

Returns

The created TokenPipe, or an empty std::nullopt in case of error.

Definition at line 75 of file tokenpipe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

TokenPipe & TokenPipe::operator= ( const TokenPipe &  )

delete

operator=() [2/2]

TokenPipe & TokenPipe::operator= ( TokenPipe &&  other )

inline

Definition at line 115 of file tokenpipe.h.

Here is the call graph for this function:

TakeReadEnd()

TokenPipeEnd TokenPipe::TakeReadEnd

(

)

Take the read end of this pipe.

This can only be called once, as the object will be moved out.

Definition at line 14 of file tokenpipe.cpp.

Here is the call graph for this function:

TakeWriteEnd()

TokenPipeEnd TokenPipe::TakeWriteEnd

(

)

Take the write end of this pipe.

This should only be called once, as the object will be moved out.

Definition at line 20 of file tokenpipe.cpp.

Here is the call graph for this function:

Member Data Documentation

m_fds

int TokenPipe::m_fds[2] = {-1, -1}

private

Definition at line 77 of file tokenpipe.h.

---

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

• src/util/tokenpipe.h
• src/util/tokenpipe.cpp